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/Requisition — entity reference
REFERENCE · Last reviewed

Requisition — entity reference

A requisition is an internal request for items raised before a supplier is committed. It appears in the Procurement app, on the web and in the mobile app, and is numbered from document numbering (shipped series R, separator -, date DDMMYYYY, six digits). It is fulfilled in two ways that both draw on each line's pending quantity: Release Order and Selective Release Order create a purchase order for the requisition's supplier, partner account and branch, while Release Transfer and Selective Release Transfer create an outward stock transfer from From Branch to Branch. A purchase order can also pull its lines in with Add Requisition. Partner Account, Branch and Supplier Account are locked once saved. Status starts at Draft; a shipped business rule sets it to Confirmed when the requisition is saved with lines and no pending quantity. The shipped release buttons show only while Status is Draft and Total Pending Quantity is greater than zero. Step-by-step procedures are on the Requisitions page of the Procurement documentation.

Fields

FieldLabelTypeRequiredWhat it does
BranchIdBranchLookup → BranchThe requesting branch, which receives the goods. Must be active and belong to the partner account; required when the partner account has branches. A released transfer moves stock to this branch. Locked once saved.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTime
DescriptionDescriptionTextFree text describing the request.
DivisionDivisionPickList
DocumentDateDocument DateDateThe request's business date. Set to today when left empty.
DocumentNumberDocumentNumberNumber
ExternalIdExternalExternalId
FromBranchIdFrom BranchLookup → BranchThe supplying branch for the transfer route: Release Transfer and Selective Release Transfer create an outward transfer from this branch to Branch. Limited to the partner account's branches. Leave empty for a purchase.
IdIdGuidYes
IsOrderReleasedOrder ReleasedBooleanSet when a purchase order is released from the requisition. It does not mean everything is released; read Total Pending Quantity or the line counters for that.
LastModifiedByLast Modified ByLookupYesNot maintained; the record's last modifier is in Modified By.
ModifiedByIdModified ByLookup → UserAccountYes
NameDocument NumberText, uniqueThe requisition's document number, generated on save from the Requisition Name Setting. The shipped format is R, a hyphen, the document date as DDMMYYYY, a hyphen and a six-digit counter.
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdPartner AccountLookup → AccountYour organization raising the request. Only active partner accounts can be picked. Copied to purchase orders and transfers released from it. Locked once saved.
PerformReleaseOrderPerform Release OrderBooleanYesInternal flag cleared by the release. Releasing happens through the Release Order action, not by setting this field.
PriceAsOnDatePrice As On DateDateThe date prices are taken from for new lines. Document Date is used when it is empty.
PriceListIdPrice ListLookup → PriceListThe purchase price list new lines are priced from. A purchase-type price list that applies to the partner account and branch is chosen automatically on creation. Changing it later does not reprice existing lines.
PurchaseOrderIdPurchase OrderLookup → PurchaseOrderOptional header reference to a purchase order. The release actions do not fill it; each released purchase order points back at the requisition and each of its lines at the requisition line instead.
PurchaseOrderLineIdPurchase Order LineLookup → PurchaseOrderLineOptional reference to a purchase order line. Not filled by the release actions.
RecordTypeIdRecord TypeGuid, hidden
RemarksRemarksTextFree text.
RequestedByIdRequested ByLookupOptional reference to who asked for the items.
RequiredDateRequired DateDateWhen the items are needed. Cannot be earlier than today.
ResourceIdResourceLookup → ResourceThe person the request is raised for. Must be authorized for the requisition's partner account and branch.
StatusStatusPickListWhere the request stands: Draft (the default), Confirmed or Approved. A shipped business rule sets Confirmed when the requisition is saved with lines and no pending quantity left. Nothing in the shipped product sets Approved. Read-only on the shipped record page. The shipped release buttons show only while it is Draft. Values: Draft, Confirmed.
SupplierAccountIdSupplier AccountLookup → AccountThe vendor to buy from. Only active supplier accounts can be picked. Filled from the branch's default supplier when left empty. Copied to every purchase order released from the requisition. Locked once saved.
Tax1Tax 1Currency
Tax1NameTax Name 1Text
Tax1RateTax Rate 1Currency
Tax1TypeTax Type 1Text
TaxGroupIdTax GroupLookup → TaxGroupHeader-level taxes, applied when the requisition is created.
TaxIdTaxLookup → Tax
TaxSupplyTypeTax Supply TypePickListThe tax lane. For businesses in India it is set from the supplier's tax registration and whether the place and source of supply differ. Values: Within State, Outside State, Exempt, Exports, SEZ.
TotalAmountTotal AmountCalculated (calculated)The estimated value of the request: the sum of the line amounts, where each line amount is quantity times unit cost plus the line's tax.
TotalLineTaxAmountTotal Line Tax AmountCalculated (calculated)The total tax over all lines.
TotalQuantityPendingTotal Quantity PendingCalculated (calculated)Labelled Total Pending Quantity on the record page: the sum of the lines' pending quantity, which is what the release actions can still take. The shipped release buttons need it to be greater than zero.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
ApplyPackageConfigurationApplyPackageConfigurationServerAction (ApplyPackageConfiguration)ApplyPackageConfiguration
BulkDeleteDeleteDeleteDelete in Selected
CloneCloneServerAction (Clone)Creates a copy of the requisition, including its line items, after a confirmation.
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete
EditEditEditEDIT
EditInLineEditEditInlineEdit in line
EditInListEditEditInlineEdit
EditListRowEditEditedit list row
GetConfigurableItemsGetConfigurableItemsServerAction (GetConfigurableItems)GetConfigurableItems
GetPackageConfigurationGetPackageConfigurationServerAction (GetPackageConfiguration)GetPackageConfiguration
NewNewNewNew
PerformReleaseOrderRelease OrderServerActionCreates one purchase order for every line that still has pending quantity, at its full pending quantity, linked to the requisition and to each requisition line.
PerformReleaseTransferRelease TransferServerAction (PerformReleaseTransfer)Creates an outward stock transfer from From Branch to Branch for every line that still has pending quantity.
ProductConfiguratorProduct ConfiguratorUIActionOpens the package configurator to choose optional components and their quantities for a package line. Shown while Status is Draft.
SelectiveReleaseOrderSelective Release OrderServerAction (SelectiveReleaseOrder)Creates a purchase order for the lines the user ticks, each at the requested quantity entered for it, which must be greater than zero and no more than the line's pending quantity.
SelectiveReleaseTransferSelective Release TransferServerAction (SelectiveReleaseTransfer)Creates an outward stock transfer for the lines the user ticks, each at the requested quantity entered for it, which must be greater than zero and no more than the line's pending quantity.

Validations

ValidationApplies toError messageNotes
Required Date Rule ValidationRequiredDate, ErrorRequired By Date Should not be BackdatedPrevents backdated required-by date
XM_ValidateOnInactiveBranchBranchId, Errorplease tag active Branch!please tag active Branch!
XM_ValidateOnInactivePartnerAccountPartnerAccountId, ErrorPlease tag active Partner Account!Please tag active Partner Account!
XM_ValidateOnInactiveSupplierAccountErrorplease tag active supplier account!please tag active supplier account!

Lookup filters

FilterLookup fieldNotes
Branch For Partner AccountBranchId
Only Partner AccountPartnerAccountId
Only SupplierSupplierAccountId
Supplier Account From BranchFromBranchId (inactive)Supplier Account From Branch