Purchase Order — entity reference

The buying-side demand document that opens the procure-to-pay chain: what is being bought, from which supplier (SupplierAccountId), on behalf of which partner account (PartnerAccountId) and into which branch (BranchId). It can be keyed by hand, released from a Requisition (PurchaseRequisitionId, or pulled in line-by-line by the add-requisition actions), or generated from an AutoOrder proposal (PurchaseAutoOrderId). PerformReleaseReceipt spawns a GoodsReceipt, PerformReleaseInvoice spawns Bill documents (purchasing bills through Bill, never through Invoice), and a supplier-branch variant can spawn a dealer sale Order. Every header money and quantity total is a metadata roll-up over PurchaseOrderLines; nothing in the procurement code ever assigns Status, so judge progress from the pending-quantity roll-ups and not from the status vocabulary.

Fields

Field	Label	Type	Required	What it does
`AccountName`	Account Name	Text		A denormalised copy of the counterparty account name kept on the document for display and export. It is a snapshot, so it can drift from the current name on the linked Account; resolve through PartnerAccountId when accuracy matters.
`AdjustedAdvanceAmount`	Adjusted Advance Amount	Currency
`AdvanceAmount`	Advance Amount	Currency		An advance paid to the supplier against this order, intended to net against the order value alongside AdjustedAdvanceAmount and OpenAdvanceAmount.
`BillingCity`	Billing City	PickList		Values: Mumbai, Pune, Chandigarh, Delhi.
`BillingCityPlaceId`	Billing City	Lookup → Place		Values: Pune, Chandigarh, Mumbai.
`BillingContactAddressId`	Billing Address	Lookup → ContactAddress
`BillingCountry`	Billing Country	PickList		Values: India.
`BillingPostalCode`	Billing Postal Code	Text
`BillingRegion`	Billing Region	Text
`BillingState`	Billing State	PickList		Values: Maharashtra, Punjab, New Delhi, Haryana.
`BillingStreet`	Billing Street	Text
`BranchId`	Branch	Lookup → Branch
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`DiscountGroupId`	Discount Group	Lookup → DiscountGroup
`DocumentDate`	Document Date	Date
`DocumentNumber`	Document Number	Number
`ExecutiveResourceId`	Executive	Lookup → Resource		The internal person (a Resource, not a user) accountable for the order. Its validation is disabled in the handler, so unlike other resource fields on the platform it is not checked against the resource master on save.
`ExternalId`	External	Text, unique
`Id`	Id	Guid	Yes
`InventoryFulfilmentId`	Fulfilment	Lookup → InventoryFulfilment
`IsInvoiceReleased`	Invoice Released	Calculated (calculated)	Yes	Judge billing progress from the Bill rows linked to the order or from TotalPendingInvoiceQuantity instead.
`IsKPICalculated`	KPI Calculated	Boolean	Yes
`IsOrderReceived`	Order Received	Boolean	Yes	A completion flag that no code path sets. Receiving completion is observable only through the receipt lines' inventory posting and through the order lines' PendingQuantity falling to zero.
`IsOrderReleased`	Order Released	Boolean	Yes	Treat it as user-maintained, never as evidence of what the system did.
`IsReceiptReleased`	Receipt Released	Calculated (calculated)	Yes	Intended to record that a goods receipt has been released from this order, but no code path writes it; PerformReleaseReceipt creates the GoodsReceipt without touching it. To tell whether receiving has started, look for GoodsReceipt rows carrying this order's id, or at the line-level PendingQuantity.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Document Number	Text
`OpenAdvanceAmount`	Open Advance Amount	Currency
`OpenAmount`	Open Amount	Currency		Intended as the order value still outstanding after advances (the domain type still carries the commented-out total-minus-advance expression).
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PartnerAccountId`	Partner Account	Lookup → Account
`PendingOrderQuantity`	Pending Order Quantity	Calculated (calculated)
`PerformKPICalculation`	Perform KPI Calculation	Boolean	Yes
`PerformReceive`	Perform Receive	Boolean	Yes	A trigger boolean with no listener on this entity: receiving is performed on the goods receipt, through GoodsReceipt.PerformReceive, not from the purchase order. Nothing reads or clears it here.
`PerformReleaseInvoice`	Perform Release Invoice	Boolean	Yes	A legacy trigger boolean superseded by the PerformReleaseInvoice server action.
`PerformReleaseOrder`	Perform Release Order	Boolean	Yes	A trigger boolean with no listener. Releasing a dealer sale order from this purchase order is done by the create-dealer-order server actions, which require SupplierBranchId and read PendingOrderQuantity; this flag plays no part in that.
`PerformReleaseReceipt`	Perform Release Receipt	Boolean	Yes	A legacy trigger boolean from the era when saving a flag ran a process.
`PlaceOfSupply`	Place of Supply	PickList		Values: Haryana, Rajasthan, Gujarat, Maharashtra.
`PriceAsOnDate`	Price As On Date	Date
`PriceListId`	Price List	Lookup → PriceList
`PurchaseAutoOrderId`	Auto Purchase Order	Lookup → AutoOrder		Set only when this order was generated from a replenishment proposal, pointing back at the AutoOrder it came from; the per-line counterpart is PurchaseOrderLine.AutoPurchaseOrderLineId. It stays empty on hand-keyed and requisition-released orders, so it is the reliable way to tell planner-generated purchasing from manual purchasing.
`PurchaseOrderShipmentId`	Purchase Order Shipment	Lookup → Shipment
`PurchaseOrderType`	Purchase Order Type	PickList		A free-text classification of the order with a seeded picklist of tenant-flavoured values (part, product, local and vehicle-off-road ordering). Values: Part PO, Product PO, Local PO, VOR PO.
`PurchaseRequisitionId`	Requisition	Lookup → Requisition		Set when the whole order was released from a single Requisition, and left empty when open requisition lines were instead pulled into an already-open order - that path tags each PurchaseOrderLine with RequisitionLineId and PurchaseRequisitionId rather than the header. Requisition pulls are refused unless the order's supplier and branch match the requisition's.
`RecordTypeId`	Record Type	Guid, hidden
`Remarks`	Remarks	Text
`RepairOrderId`	RepairOrder	Guid
`RoundOff`	Round Off	Currency		A rounding adjustment on the order total. It is not part of any header roll-up formula - TotalAmount is line amount plus tax only - and no code path computes it, so it neither derives from nor feeds the totals.
`ServiceOrderId`	Service Order	Lookup → ServiceOrder
`ShippingAddress`	Shipping Address	Text
`ShippingCity`	Shipping City	PickList		Values: Pune, Chandigarh, Mumbai, Delhi.
`ShippingCityPlaceId`	Shipping City	Lookup → Place		Values: Mumbai, Pune, Chandigarh.
`ShippingContactAddressId`	Shipping Address	Lookup → ContactAddress
`ShippingCountry`	Shipping Country	PickList		Values: India.
`ShippingPostalCode`	Shipping Postal Code	Text
`ShippingRegion`	Shipping Region	Text
`ShippingState`	Shipping State	PickList		Values: Maharashtra, Punjab, New Delhi, Haryana.
`ShippingStreet`	Shipping Street	Text
`SkipScheme`	Skip Scheme	Boolean	Yes	Suppresses promotional scheme evaluation for the whole document, so the shared scheme engine will not attach benefits or scheme discount lines. A per-line flag of the same name exists for excluding individual lines while leaving the rest of the order scheme-eligible.
`SourceOfSupply`	Source of Supply	PickList		Values: Maharashtra, Gujarat, Rajasthan, Haryana.
`Status`	Status	PickList		Values: Draft, Shipment, Goods Receipt, Bill.
`SupplierAccountId`	Supplier Account	Lookup → Account
`SupplierBranchId`	Supplier Branch	Lookup → Branch		The specific branch of the supplier partner this order is placed against, and the field the dealer-order flow depends on: creating a dealer sale Order from this purchase order is refused unless it is set, and the new order's branch and partner account are both taken from it. It is separate from SupplierAccountId because one supplier partner can own several branches.
`Tax1`	Tax1	Currency
`Tax1Name`	Tax Name 1	Text
`Tax1Rate`	Tax Rate 1	Currency
`Tax1Type`	Tax Type 1	Text
`TaxGroupId`	Tax Group	Lookup → TaxGroup
`TaxId`	Tax	Lookup → Tax
`TaxSupplyType`	Tax Supply Type	PickList		Values: Within State, Outside State, Exempt, Exports, SEZ.
`TCSEligibleAmount`	TCS Eligible Amount	Currency		The base amount that tax-collected-at-source is charged on, maintained by the shared tax-group service when header taxes are resolved rather than by the purchase-order handler itself. It is the input to the header Tax1 slot, not a total in its own right.
`TotalAmount`	Total Amount	Calculated (calculated)
`TotalDiscountAmount`	Total Discount Amount	Calculated (calculated)		Sum of the lines' combined net discount, which on each line already folds together the ordinary discount, the secondary discount and the contract discount, taken either as an amount or as a rate on the base (or on base plus tax when the line applies discount after tax). Scheme-driven discount is counted separately in TotalSchemeDiscountAmount.
`TotalLineAmount`	Total Line Amount	Calculated (calculated)		Sum of the line net amounts (each line's amount after its discounts). It is the base of the header TotalAmount formula, which adds TotalTaxAmount on top; it excludes tax, freight and rounding.
`TotalLineBaseAmount`	Total Line Base Amount	Calculated (calculated)
`TotalLineGrossAmount`	Total Line Gross Amount	Calculated (calculated)		Sum of the line gross amounts, meaning net plus line tax and with post-tax discounts already taken off. This is the figure the billed-inventory accrual journal reads, so it is the tax-inclusive view of the order rather than the payable base.
`TotalLineTaxAmount`	Total Line Tax Amount	Calculated (calculated)
`TotalPendingInvoiceQuantity`	Total Pending Invoice Quantity	Calculated (calculated)
`TotalPendingQuantity`	Total Pending Quantity	Calculated (calculated)
`TotalSchemeDiscountAmount`	Total Scheme Discount Amount	Calculated (calculated)
`TotalTaxAmount`	Total Tax Amount	Calculated (calculated)
`TotalTaxPostingAmount`	Total Tax Posting Amount	Calculated (calculated)
`TransactionType`	Transaction Type	PickList
`UIProps`	UI Props	Text
`UpdatedDateTime`	Modified Date	DateAndTime	Yes

Actions

Action	Label	Type	What it does
`ApplyPackageConfiguration`	Apply Package Configuration	ServerAction (`ApplyPackageConfiguration`)	ApplyPackageConfiguration
`ApplyScheme`	Apply Scheme	ServerAction (`ApplyScheme`)	Handled by the shared scheme engine rather than by the purchase-order handler: it applies one named scheme line to the document, optionally with a chosen benefit and a set of selected items, adding benefit lines and scheme discount to the order.
`BulkDelete`	Delete	Delete	Delete the selected records.
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`Delete`	Delete	Delete	Delete
`DeleteInList`	Delete	Delete	Delete in a list page
`Edit`	Edit	Edit	Edit
`EditInLine`	Edit	EditInline	Edit in page.
`EditInList`	Edit	EditInline	Edit
`EditListRow`	Edit	Edit	EditListRow
`GetConfigurableItems`	Get Configurable Items	ServerAction (`GetConfigurableItems`)	GetConfigurableItems
`GetFrequentlyOrderedItems`	Get Frequently Ordered Items	ServerAction (`GetFrequentlyOrderedItems`)	Get all Items ordered within particular duration.
`GetOpenDocuments`	Get Open Documents	ServerAction (`GetOpenDocuments`)	GetOpenDocuments
`GetPackageConfiguration`	Get Package Configuration	ServerAction (`GetPackageConfiguration`)	GetPackageConfiguration
`GetPaymentAmountSummary`	Get Payment AmountSummary	ServerAction (`GetPaymentAmountSummary`)	GetPaymentAmountSummary
`GetQualifiedBenefits`	Get Qualified Benefits	ServerAction (`GetQualifiedBenefits`)	Read-only. Returns the benefits available to this document for a given set of item groups supplied in the arguments, so a buyer can choose which benefit to take before applying a scheme. It changes nothing on the order.
`GetQualifiedSchemeSlabs`	Get Qualified Scheme Slabs	ServerAction (`GetQualifiedSchemeSlabs`)	Read-only. Returns the scheme slabs the document currently qualifies for, evaluated by the shared scheme engine against the order as it stands. Applying one is a separate step.
`GetSchemeRecommendations`	Get Scheme Recommendations	ServerAction (`GetSchemeRecommendations`)	Read-only. Returns the schemes the document could qualify for; with no item named in the arguments it evaluates the whole document server-side, and with one named it previews that single item's line, optionally reflecting a typed quantity, unit price and the pending basket totals so every card shows the same distance to the next threshold. It applies nothing.
`New`	New	New	New
`PerformCreateDealerOrder`	Create Dealer Order	ServerAction (`PerformCreateDealerOrder`)	PerformCreateDealerOrder
`PerformReleaseInvoice`	Release Invoice	ServerAction (`PerformReleaseInvoice`)	This action will create purchase invoice record for the current purchase order.
`PerformReleaseReceipt`	Release Receipt	ServerAction (`PerformReleaseReceipt`)	This action will create good receipt record for the current purchase order.
`PostAdjustments`	Post Adjustments	ServerAction (`PostAdjustments`)	PostAdjustments
`ProductCatalogue`	Product Catalogue	ServerAction	Despite being typed as a server action it names no server action - it is driven entirely by its attached layout, which opens the catalogue picker for adding lines to the order.
`ResetScheme`	Reset Scheme	ServerAction (`ResetScheme`)	Strips every applied scheme from the document through the shared scheme engine, removing the benefit lines it generated and clearing scheme discount, so the order can be re-evaluated from scratch. It is the undo for ApplyScheme and does affect stored line data.
`SelectiveAddRequisition`	Add Requisition	ServerAction (`SelectiveAddRequisition`)	Pull every open line of the selected requisitions into this purchase order
`SelectiveAddRequisitionLine`	Selective Requisition Lines	ServerAction (`SelectiveAddRequisitionLine`)	Pull the selected requisition lines into this purchase order at the requested quantity
`SelectiveCreateDealerOrder`	Selective Create Dealer Order	ServerAction (`SelectiveCreateDealerOrder`)	SelectiveCreateDealerOrder
`SelectiveReleaseInvoice`	Selective Release Invoice	ServerAction (`SelectiveReleaseInvoice`)	It is use to release selective lines.
`SelectiveReleaseReceipt`	Selective Release Receipt	ServerAction (`SelectiveReleaseReceipt`)	It is use to release selective lines.

Validations

Validation	Applies to	Error message	Notes
Tax Group Validation	Error	Tax Group Type must be "Document Level".	Ensures tax group type is 'Document Level' for purchase orders

Lookup filters

Filter	Lookup field	Notes
Branch For Partner Account	`BranchId`
Only Partner Account	`PartnerAccountId`
Only Supplier	`SupplierAccountId`

Branch — looks up via SupplierBranchId
Shipment — looks up via PurchaseOrderShipmentId
Place — looks up via BillingCityPlaceId
Account — looks up via SupplierAccountId
Account — looks up via PartnerAccountId
TaxGroup — looks up via TaxGroupId
Branch — looks up via BranchId
DiscountGroup — looks up via DiscountGroupId
UserAccount — looks up via OwnerId
Tax — looks up via TaxId
Place — looks up via ShippingCityPlaceId
InventoryFulfilment — looks up via InventoryFulfilmentId
UserAccount — looks up via ModifiedById
UserAccount — looks up via CreatedById
ServiceOrder — looks up via ServiceOrderId
Resource — looks up via ExecutiveResourceId
PriceList — looks up via PriceListId
ContactAddress — looks up via ShippingContactAddressId
ContactAddress — looks up via BillingContactAddressId
AutoOrder — looks up via PurchaseAutoOrderId
Requisition — looks up via PurchaseRequisitionId
Shipment — referenced by via PurchaseOrderId
SchemeLedger — referenced by via PurchaseOrderId
CreditNote — referenced by via PurchaseOrderId
PurchaseOrderRequisition — referenced by via PurchaseOrderId
ShipmentLine — referenced by via PurchaseOrderId
Requisition — referenced by via PurchaseOrderId
Bill — referenced by via PurchaseOrderId
PurchaseOrderLine — referenced by via PurchaseOrderId
Payment — referenced by via PurchaseOrderId
PaymentAdjustment — referenced by via PurchaseOrderId
GoodsReceipt — referenced by via PurchaseOrderId
CreditNoteLine — referenced by via PurchaseOrderId
Order — referenced by via PurchaseOrderId

Purchase Order — entity reference

Fields

Actions

Validations

Lookup filters

Related entities

Related topics