xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField Sales & SFACRMRewardsClaimsInventoryProcurementWarehouse ManagementField ServiceServiceSupportTelephony & MessagingFinance & AccountingPayrollExpense ManagementCommercePortalsAnalytics & ReportingData StudioMobile AppSee all products →
PLATFORM
Platform overviewApp BuilderAutomationIntegrationsSecurity & GovernanceChange ManagementDevelopers
SENSE AI
Sense AI overviewSense AssistSense ControlSense VisionAI StudioTrust & governanceIn Claude & ChatGPTUse cases
SOLUTIONS
Auto DMSConsumer Goods DMSSales Force Automation (SFA) FMCG & DistributionManufacturing & Dealer NetworksAutomotive & DealershipsPharma & HealthcareConsumer DurablesAgri-InputsBuilding MaterialsService NetworksWarehousing & 3PLFinancial AccountingERP SoftwareIndia GST ComplianceUAE VAT & e-InvoicingSaudi ZATCA & VATAll solutions →
RESOURCES
Knowledge CenterDeveloper & CLIBlogGuidesWhat is xMatix?Company facts
COMPANY
AboutCareersPartnersEventsContactAuthorsLegal
Sign in Request demo
Home/Docs/Entity Reference/Goods Receipt — entity reference
REFERENCE · Last reviewed

Goods Receipt — entity reference

The inbound receiving document: goods physically arriving at a branch from a supplier, with the supplier's dispatch and invoice references and the transporter details. It is released from a purchase order (Purchase Order set, lines carrying Ordered Quantity) or from an inbound shipment (Shipment set, lines carrying Supplier Quantity), or created stand-alone. Its actions run the receiving sequence: Receive creates item lots and approves the selected lines for inventory posting, Inspection and Inspection Complete drive quality inspection through inspection lines, Release Bill creates the supplier bill, and Post General Ledger posts the accrual journal (debit Inventory, credit Unbilled Receipt, at Total Amount), which the bill later clears. Each action that does some work sets the read-only Document State; Status is the organization's own picklist, updated by seeded business rules when the receipt is saved.

Fields

FieldLabelTypeRequiredWhat it does
BranchIdBranchLookup → BranchThe receiving branch. Copied from the purchase order or shipment by the release, must belong to the partner account and be active, and is locked once the receipt is saved. Its default supplier fills Supplier Account on new receipts.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DocumentDateDocument DateDateThe receiving date. It is defaulted to the current date when the receipt is created and cannot be edited afterwards - the handler blocks changes to it, along with branch, partner and supplier, once the record exists.
ExternalIdExternalText, unique
GeneralLedgerIdGeneral LedgerLookup → GeneralLedger
GLAccountIdGL AccountLookup → GLAccountNot used when the accrual posts: the Inventory and Unbilled Receipt accounts come from a posting definition or the company's accounts of those types.
HasLineItemsHas Line ItemsCalculated (calculated)
IdIdGuidYes
InspectionLineIdInspection LineLookup → InspectionLinePoints at a single inspection line, used where a receipt was itself raised out of an inspection (for example a rework or return-to-stock consignment). It is the reverse of the InspectionLines collection, which holds the inspection lines this receipt generated.
IsAllocatedAllocatedBooleanYesNeither this flag nor PerformAllocation is ever read or written.
IsBillGeneratedBill GeneratedCalculated (calculated)YesIntended to record that a supplier bill was released from this receipt, but no code path sets it. PerformReleaseBill creates the Bill with this receipt's id on it, so look for that Bill rather than trusting the flag.
IsClaimedClaimedBooleanYes
IsGLPostedIs GL PostedBooleanRecords that this receipt's accrual journal has been posted - the goods-received accrual that debits inventory and credits the unbilled-receipt (GR-IR) account at the header TotalAmount. The supplier Bill later clears that same GR-IR account for every bill line sourced from a receipt line, which is what stops inventory being debited twice.
IsGLPostingApprovedIs GL Posting ApprovedBooleanSet to true by the general-ledger posting action immediately before the journal is built; it is the approval gate the document posting service reads, not a user-set field. IsGLPosted then records that the journal was written.
IsInspectedInspectedCalculated (calculated)YesRead the inspection lines to know the inspection state.
IsInspectionCompletedInspection CompletedCalculated (calculated)YesIntended to mark inspection closed on the header, but the constant is declared and never assigned; completing inspection only flips InspectionDone on the individual inspection lines. A header with open inspection lines is the real test.
IsReceivedReceivedCalculated (calculated)YesA system field that a user may not set on create (the handler rejects it as an attempted change to a system field), but which no code path afterwards sets either. Whether stock actually moved is told by the receipt lines carrying an InventoryLedgerId, not by this flag.
ModifiedByIdModified ByLookup → UserAccountYes
NameDocument NumberTextThe receipt's document number, generated on create from the Goods Receipt Name Setting (default series GRN, day-month-year date part, six-digit running number).
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdPartner AccountLookup → AccountYour organization (company) that receives the goods. Copied by the release, must be an active partner account, and is locked once the receipt is saved. Its GL Posting Enabled setting decides whether Post General Ledger writes a journal.
PerformAllocationPerform AllocationBooleanYesA trigger boolean for the disabled receipt-allocation step. Nothing listens to it; allocation of stock to demand happens on the sale order and inventory-fulfilment side instead.
PerformInspectionPerform InspectionBooleanYesTrigger flag behind the Inspection action. Set the action, not this field.
PerformInspectionCompletePerform Inspection CompleteBooleanYesTrigger flag behind the Inspection Complete action. Set the action, not this field.
PerformPopulateChecklistPerform Populate ChecklistBooleanYes
PerformReceivePerform ReceiveBooleanYesTrigger flag behind the Receive action. Set the action, not this field.
PerformReceiveAsyncPerform Receive AsyncBooleanYesReceiving runs synchronously through the PerformReceive server action.
PerformReleaseBillPerform Release BillBooleanYesTrigger flag behind the Release Bill action. Set the action, not this field.
PurchaseOrderIdPurchase OrderLookup → PurchaseOrderThe purchase order the receipt was released from. Set by Release Receipt on the order; empty on receipts released from a shipment. When set, Receive and Release Bill also move the order's Document State to Received and Billed.
ReceivedTimeReceived TimeDate
RecordTypeIdRecord TypeGuid, hidden
ResourceIdExecutiveLookup → ResourceThe person responsible for the receipt. Shown on the create form only; informational.
ShipmentIdShipmentLookup → ShipmentThe inbound shipment the receipt was released from. When set, receipt lines post Supplier Quantity to stock, moving it out of the in-transit bucket if the shipment was already posted.
StatusStatusPickListThe organization's own progress marker, shown as the stepper on the record page. Defaults to Draft. Seeded business rules set Start Inspection, Complete Inspection and Bill from the state of the lines when the receipt is saved, so it can lag behind the lines; it can also be set by clicking a step. Use Document State for the last lifecycle action that did some work. Values: Draft, Receive, Start Inspection, Complete Inspection, Bill.
SupplierAccountIdSupplier AccountLookup → AccountThe supplier who sent the goods. Required when the receipt is created and must be an active supplier account; defaults to the branch's default supplier when empty, and is locked once saved. It is the party on the accrual journal and is copied onto a bill released from the receipt.
SupplierDispatchDateSupplier Dispatch DateDateWhen the supplier dispatched the consignment, as opposed to DocumentDate which is when it was received. The gap between the two is the transit time; neither is used by any calculation in the receiving code.
SupplierInvoiceDateSupplier Invoice DateDateAndTimeDate on the supplier's own invoice for this consignment, distinct from DocumentDate (when the goods were booked in) and from SupplierDispatchDate (when they left the supplier). It is the date carried onto asset records created from this receipt.
SupplierInvoiceNumberSupplier Invoice NumberTextThe supplier's own invoice or delivery-note reference for this consignment, copied from the shipment when the receipt was released from one. It is a free-text reference, not validated for uniqueness, and it is carried onto the asset records created for asset-tracked items.
TotalAmountTotal AmountCalculated (calculated)Received quantity multiplied by unit cost, summed over the receipt lines. It is the amount the accrual journal posts.
TransporterContactNumberTransporter Contact NumberNumberThe carrier's contact phone number, stored as a number.
TransporterNameTransporter NameTextThe carrier who delivered the consignment. Copied from the shipment when the receipt is released from one.
TransporterReferenceNumberTransporter Reference NumberTextThe carrier's consignment, docket or vehicle reference, for tracing shortages and damage.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete the selected records.
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete
EditEditEditEdit
EditInLineEditEditInlineEdit In page
EditInListEditEditInlineEdit
EditPopUpEditEditEdit
NewNewNewNew
PerformGLPostingPost General LedgerServerAction (PerformGLPosting)PerformGLPosting
PerformInspectionInspectionServerAction (PerformInspection)PerformInspection
PerformInspectionCompleteInspection CompleteServerAction (PerformInspectionComplete)PerformInspectionComplete
PerformReceiveReceiveServerAction (PerformReceive)Perform Receive
PerformReleaseBillRelease BillServerAction (PerformReleaseBill)Perform Release Bill
PostGeneralLedgerPost General LedgerServerAction (PostGeneralLedger), inactivePost goods receipt to General Ledger.

Lookup filters

FilterLookup fieldNotes
Branch For Partner AccountBranchId
Partner Account FilterPartnerAccountId
Only SupplierSupplierAccountId