Purchase Order — entity reference

A purchase order is the commitment to a supplier: the items, quantities and prices bought for a branch, and the document every later shipment, goods receipt and bill links back to line by line. It appears in the Procurement app. It is created directly, released from a requisition, filled from requisitions with Add Requisition, or generated from an auto order. It is numbered from document numbering (shipped series PO, separator -, date DDMMYYYY, six digits). Partner Account, Branch and Document Date are locked once saved with a value. Receiving, billing and dealer-order release are tracked independently by per-line counters; Release Receipt, Release Shipment, Release Invoice and Dealer Order each draw only on the matching pending quantity, and every one has a selective variant. Status starts at Draft; Release Shipment sets it to Shipment and two shipped business rules set Goods Receipt and Bill when the order is saved. There is no cancel action: undelivered quantity is entered as Cancelled Quantity on the line. Step-by-step procedures are on the Purchase orders page of the Procurement documentation.

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		The receiving branch. Must be active and belong to the partner account; required when the partner account has branches. Locked once saved with a value.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`DiscountGroupId`	Discount Group	Lookup → DiscountGroup		The discount group line discounts come from. A purchase-type discount group is chosen automatically on creation.
`DocumentDate`	Document Date	Date		The order's business date. Set to today when left empty, and used to pick the fiscal day the order belongs to. Locked once saved.
`DocumentNumber`	Document Number	Number
`ExecutiveResourceId`	Executive	Lookup → Resource		Labelled Executive: the internal person accountable for the order.
`ExternalId`	External	Text, unique
`Id`	Id	Guid	Yes
`InventoryFulfilmentId`	Fulfilment	Lookup → InventoryFulfilment
`IsInvoiceReleased`	Invoice Released	Calculated (calculated)	Yes	Legacy flag; not maintained by the release actions. Read the line counters instead.
`IsKPICalculated`	KPI Calculated	Boolean	Yes
`IsOrderReceived`	Order Received	Boolean	Yes	Legacy flag with no effect.
`IsOrderReleased`	Order Released	Boolean	Yes	Legacy flag with no effect.
`IsReceiptReleased`	Receipt Released	Calculated (calculated)	Yes	Legacy flag; not maintained by the release actions. Read the line counters instead.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Document Number	Text		The purchase order's document number, generated on save from the Purchase Order Name Setting. The shipped format is PO, a hyphen, the document date as DDMMYYYY, a hyphen and a six-digit counter.
`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		Your organization placing the order. Only active partner accounts can be picked. Locked once saved with a value.
`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		For tax: defaulted from the supplier's place of supply for businesses in India. Values: Haryana, Rajasthan, Gujarat, Maharashtra.
`PriceAsOnDate`	Price As On Date	Date		The date prices are taken from. Changing it reprices every line from the price list in force on that date.
`PriceListId`	Price List	Lookup → PriceList		The purchase price list lines are priced from. A purchase-type price list is chosen automatically on creation.
`PurchaseAutoOrderId`	Auto Purchase Order	Lookup → AutoOrder		Labelled Auto Purchase Order: the auto-order worksheet the order was generated from. Filled automatically.
`PurchaseOrderShipmentId`	Purchase Order Shipment	Lookup → Shipment
`PurchaseOrderType`	Purchase Order Type	PickList		A classification of the order: Part, Product, Local PO, VOR PO, Subcontracted PO or Blanket PO. The shipped list views filter on it; otherwise it is used for reporting. Values: Part PO, Product PO, Local PO, VOR PO.
`PurchaseRequisitionId`	Requisition	Lookup → Requisition		The requisition the order was released from. Filled automatically.
`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		The service order the purchase was raised for, when it came from one.
`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	Turns off supplier-scheme evaluation for the whole order. Not on the shipped layouts.
`SourceOfSupply`	Source of Supply	PickList		For tax: defaulted from the branch's source of supply for businesses in India. Values: Maharashtra, Gujarat, Rajasthan, Haryana.
`Status`	Status	PickList		The order's stage: Draft (the default), New, Shipment, Goods Receipt or Bill. Release Shipment sets Shipment; shipped business rules set Goods Receipt when no line has pending quantity and Bill when something is billed and nothing is left to bill, when the order is saved. It can also be moved by hand with the stepper. The shipped release buttons show only while it is Draft. Values: Draft, Shipment, Goods Receipt, Bill.
`SupplierAccountId`	Supplier Account	Lookup → Account		The vendor. Only active supplier accounts can be picked. Filled from the branch's default supplier when left empty. Add Requisition only accepts requisitions for the same supplier account.
`SupplierBranchId`	Supplier Branch	Lookup → Branch		The supplier's branch. Required by the Dealer Order actions, which create a sale order at this branch when the supplier is another organization on the platform. Not on the shipped create form.
`Tax1`	Tax1	Currency
`Tax1Name`	Tax Name 1	Text
`Tax1Rate`	Tax Rate 1	Currency
`Tax1Type`	Tax Type 1	Text
`TaxGroupId`	Tax Group	Lookup → TaxGroup		Header-level taxes. Must be a Document Level tax group.
`TaxId`	Tax	Lookup → Tax
`TaxSupplyType`	Tax Supply Type	PickList		The tax lane: Within State, Outside State, Exempt, Exports or SEZ. For businesses in India it is recalculated on every save from the supplier's registration type and whether the place and source of supply differ. 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)		The order total shown in the Amount Summary: base amount less scheme and other discounts plus tax.
`TotalDiscountAmount`	Total Discount Amount	Calculated (calculated)		The total of line discounts.
`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)		Quantity times unit cost over all lines, before discounts.
`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)		The sum of the lines' pending invoice quantity: ordered less billed less cancelled. The shipped release buttons need it to be greater than zero.
`TotalPendingQuantity`	Total Pending Quantity	Calculated (calculated)		The sum of the lines' pending quantity: ordered less staged on goods receipts less cancelled.
`TotalSchemeDiscountAmount`	Total Scheme Discount Amount	Calculated (calculated)		The total discount from applied supplier schemes.
`TotalTaxAmount`	Total Tax Amount	Calculated (calculated)		The total tax over all lines.
`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