Create_PurchaseRequisition
This operation lets you create parent purchase requisitions and child purchase line items. It also creates a work information record for parent and child items if input values are supplied.
Best practice
DB field on interface form | Displayed on web services | Notes |
---|---|---|
zID_Action | Action | Required field "CREATE" is the only keyword supported and must be in uppercase |
Status | Status | Required field Accepted status values: In Preparation, On Order, Partially Received, Received, Closed, and Cancelled |
Date Required | DateRequired | Required field |
Description | Description | Required field |
Justification | Justification | Required field |
For_Company | RequestedForCompany | Required field |
Requested_For_PersonID | RequestedForPersonID | Required if RequestedForFullName is not provided |
For_Full Name | RequestedForFullName | Required if RequestedForPersonID is not provided |
Login Name | RequestedForLoginName | |
For_Phone | RequestedForPhoneNumber | |
For_Department | RequestedForDepartment | |
Manager Name | ManagerFullName | By default this is the manager of the Requested For person, and is used as the first approver by the provided process. If the status is In Preparation. then a value is recommended. A Full Name other than the actual manager can be supplied. |
Manager Login Name | ManagerLoginName | Login identifier of the value supplied for Manager Name |
By_Company | RequestedByCompany | Required field |
Requested_By_PersonID | RequestedByPersonID | Required if RequestedByFullName is not provided |
By_Full Name | RequestedByFullName | Required if RequestedByPersonID is not provided |
Requester Login Name | RequestedByLoginName | |
By_Phone | RequestedByPhoneNumber | |
By_Department | RequestedByDepartment | |
Shipping Instructions | ShippingInstructions | |
PRNumber | PRNumber | Available for storing external procurement system reference number |
DataTags | DataTags | Hidden field that can store a tag identifier |
Install Needed | InstallNeeded | Supported values are Yes or No |
Cost Center | CostCenter | |
Accounting Code | AccountingCode | |
Project Number | ProjectNumber | |
Budget Code | BudgetCode | |
z1D_Activity_Type | WorkInfoType | Required if creating a work information record |
z1D_ActivityDate_tab | WorkInfoDate | Required if creating a work information record |
z1D_Communication Source | WorkInfoSource | Required if creating a work information record |
z1D_Summary | WorkInfoSummary | Required if creating a work information record |
z1D_Details | WorkInfoNotes | Required if creating a work information record |
z1D_Secure_Log | WorkInfoLocked | Required if creating a work information record |
z1D_View Access | WorkInfoViewAccess | Required if creating a work information record. Supported values are "Internal" or "External." |
z2AF_Act_Attachment_1/attachmentName | WorkInfoAttachment1Name | Optional if creating a work information record |
z2AF_Act_Attachment_1/attachmentData | WorkInfoAttachment1Data | Optional if creating a work information record |
z2AF_Act_Attachment_1/attachmentOrigSize | WorkInfoAttachment1OrigSize | Optional if creating a work information record |
z2AF_Act_Attachment_2/attachmentName | WorkInfoAttachment2Name | Optional if creating a work information record |
z2AF_Act_Attachment_2/attachmentData | WorkInfoAttachment2Data | Optional if creating a work information record |
z2AF_Act_Attachment_2/attachmentOrigSize | WorkInfoAttachment2OrigSize | Optional if creating a work information record |
z2AF_Act_Attachment_3/attachmentName | WorkInfoAttachment3Name | Optional if creating a work information record |
z2AF_Act_Attachment_3/attachmentData | WorkInfoAttachment3Data | Optional if creating a work information record |
z2AF_Act_Attachment_3/attachmentOrigSize | WorkInfoAttachment3OrigSize | Optional if creating a work information record |
BillToAddr_Street | BillToStreet | Bill To fields are required and will be set based on Requested For. |
BillToAddr_City Name+ | BillToCity | |
BillToAddr_State Prov+ | BillToStateProv | |
BillToAddr_Postal Code+ | BillToPostalCode | |
BillToAddr_Country+ | BillToCountry | |
ShipToAddr_Street | ShipToStreet | Ship To fields are required and will be set based on Requested For. |
ShipToAddr_City Name+ | ShipToCity | |
ShipToAddr_State Prov+ | ShipToStateProv | |
ShipToAddr_Postal Code+ | ShipToPostalCode | |
ShipToAddr_Country+ | ShipToCountry | |
Assigned Support Company | SupportCompany | Assigned field values can be automatically set by workflow if a Group Assignment General event is defined. |
Assigned Support Organization | SupportOrganization | |
Assigned Group | AssignedGroup | |
Assignee | Assignee | |
TemplateInstanceID | ChangeTemplateInstanceID | Integration available if Change Management is installed. Specify the CHG Template ID (FieldID 179) which can be found in the CHG:Template form. If value is supplied then Installed Needed should be set to Yes. |
The following table lists input values for the child level of the Create_PurchaseRequisition operation and maps to the AST:PurchaseLineItemInterface_Create form:
DB field on interface form | Displayed on web services | Notes |
---|---|---|
zID_Action | Action | Required field "CREATE" is the only keyword supported and must be in upper case. |
Part Number | PartNumber | Required field |
Short Description | Description | Required field |
Status | Status | Required field Accepted status values: In Preparation, On Order, Partially Received, Received, and Cancelled. |
Asset Class ID | AssetClassID | Required field in the format of CI Keyword, for example BMC_COMPUTERSYSTEM. |
Unit of Measure | UnitOfMeasure | |
Required Qty* | RequiredQty | Required field |
Total Received Qty | TotalReceivedQty | Required if auto receive is set to yes and CI Type is Software Class or if Status is Received. |
Unit Price/currencyValue | UnitPriceAmount | If a value is provided, must provide the currency code. If Unit Price is 0 and if the order status is "In Preparation", then the Status of PLI will switch to Pending Pricing. |
Unit Price/currencyCode | UnitPriceCurrency Code | Must provide a currency value if currency code is provided. |
Estimated Price/currencyValue | EstimatedPriceAmount | If a value is provided, must provide the currency code. |
Estimated Price/currencyCode | EstimatedPriceCurrencyCode | Must provide a currency value if currency code is provided. |
Actual Price/currencyValue | ActualPriceAmount | If a value is provided, must provide the currency code. |
Actual Price/currencyCode | ActualPriceCurrency Code | Must provide a currency value if currency code is provided. |
Taxable | Taxable | Set to "Yes" if Tax Amount is supplied. |
Tax Amount/currencyValue | TaxAmount | If a value is provided, must provide the currency code. |
Tax Amount/currencyCode | TaxCurrencyCode | Must provide a currency value if currency code is provided. |
Tax Rate | TaxRate | If Taxable = "Yes", must provide rate. |
Shipping & Handling/currencyValue | ShippingAndHandling Amount | If a value is provided, must provide the currency code. |
Shipping & Handling/currencyCode | ShippingAndHandling CurrencyCode | Must provide a currency value if currency code is provided. |
Product Categorization Tier 1 | ProductTier1 | Required if CI Type is Software Class. |
Product Categorization Tier 2 | ProductTier2 | Required if CI Type is Software Class. |
Product Categorization Tier 3 | ProductTier3 | Required if CI Type is Software Class. |
Model | ProductName | Required if CI Type is Software Class. |
Version Number | ModelVersion | |
MarketVersion | MarketVersion | Required if CI Type is Software Class. |
Manufacture Name+ | Manufacturer | Required if CI Type is Software Class. |
Supplier Name+ | SupplierName | Required for most Status values. If Supplier is not filled in while In Preparation then the Status will switch to Pending Pricing. |
Date Required | DateRequired | Required field |
Date Ordered | DateOrdered | Required if Status is On Order or greater. |
Estimated Receiving Date | DateToReceive | |
LicenseCertificateType | CertificatePurchaseType | Required if Software Contract ID is used |
Software Contract ID | SoftwareContractID | Either SoftwareContractID or Certificate ID is required if CI Type is Software Class. |
LicenseTypeGUID | LicenseType | Required if Software Contract ID is used. Need to provide the license type GUID. In order to get this, user must go to the interface form and use the drop down box to select the type. The GUID will be displayed when type is selected. |
zID_CertificateID | CertificateID | Either SoftwareContractID or Certificate ID is required if CI Type is Software Class. If the CertificateID is specified, it must be a valid Certificate ID and should not be related to another purchase line item. |
PRNumber | PRNumber | Available for storing external procurement system reference number. |
PO Number | PONumber | Available for storing external purchase order reference number. |
Quote Number | QuoteNumber | |
QuoteDesc | QuoteInfo | |
Data Tags | Data Tags | Hidden field that can store a tag identifier. |
Cost Center | CostCenter | Required if Software Contract ID is used. |
Accounting Code | AccountingCode | |
Project Number | ProjectNumber | |
Budget Code | BudgetCode | |
Attachment1/attachmentName | PLIAttachment1Name | |
Attachment1/attachmentData | PLIAttachment1Data | |
Attachment1/attachmentOrigSize | PLIAttachment1OrigSize | |
Notes to Purchasing | NotesToPurchasing | |
Notes to Supplier | NotesToSupplier | |
Notes | EnterNotes | |
zID_Activity_Type | WorkInfoType | Required if creating a work information record. |
zID_ActivityDate_Tab | WorkInfoDate | Required if creating a work information record. |
zID_CommunicationSource | WorkInfoSource | Required if creating a work information record. |
zID_Summary | WorkInfoSummary | Required if creating a work information record. |
zID_Detailes | WorkInfoNotes | Required if creating a work information record. |
z2AF_Act_Attachment_1/attachmentName | WorkInfoAttachment1Name | Optional if creating a work information record. |
z2AF_Act_Attachment_1/attachmentData | WorkInfoAttachment1 Data | Optional if creating a work information record. |
z2AF_Act_Attachment_1/attachmentOrigSize | WorkInfoAttachment1 OrigSize | Optional if creating a work information record. |
z2AF_Act_Attachment_2/attachmentName | WorkInfoAttachment2 Name | Optional if creating a work information record. |
z2AF_Act_Attachment_2/attachmentData | WorkInfoAttachment2 Data | Optional if creating a work information record. |
z2AF_Act_Attachment_2/attachmentOrigSize | WorkInfoAttachment2 OrigSize | Optional if creating a work information record. |
z2AF_Act_Attachment_3/attachmentName | WorkInfoAttachment3 Name | Optional if creating a work information record. |
z2AF_Act_Attachment_3/attachmentData | WorkInfoAttachment3 Data | Optional if creating a work information record. |
z2AF_Act_Attachment_3/attachmentOrigSize | WorkInfoAttachment3 OrigSize | Optional if creating a work information record. |
zID_Secure_Log | WorkInfoLocked | Required if creating a work information record. |
zID_View_Access | WorkInfoViewAccess | Required if creating a work information record. Supported values are "Internal" or "External." |
Buyer Name | BuyerName | Will be stored in the Purchase Order if one is generated. |
OrderConfirmationTypeCode | ConfirmationCode | Will be stored in the Purchase Order if one is generated. |
Payment Terms | PaymentTerms | Will be stored in the Purchase Order if one is generated. |
Freight Terms | FreightTerms | Will be stored in the Purchase Order if one is generated. |
Ship Via | ShipVia | Will be stored in the Purchase Order if one is generated. |
Shipping Options | ShippingOptions | Will be stored in the Purchase Order if one is generated. |
The following table lists output values for the parent level of the Create_PurchaseRequisition operation from the AST:PurchaseRequisitionInterface_Create form:
DB field on interface form | Displayed on web services | Notes |
---|---|---|
instanceId | InstanceID | Unique identifier generated for each purchase requisition. |
Requisition ID | RequisitionID | Unique visible Requisition ID system generated. |
The following table lists output values for the child level of the Create_PurchaseRequisition operation from the AST:PurchaseLineItemInterface_Create form:
DB field on interface form | Displayed on web services | Notes |
---|---|---|
instanceId | InstanceID | Unique identifier generated for each line item. |
Comments
Log in or register to comment.