Cmdlets for Workday

Build 24.0.9060

Requisitions

Retrieves a collection of requisitions.

Workday Resource Information

Retrieves a requisition with the specified ID.

Secured by: Checkout (REST), Process: Requisition - Reporting, Process: Requisition - View, Self-Service: Requisition, Self-Service: Supplier Contact Tasks, View: Organization Requisition

Scope: Procurement

Aggregate Fields

The cmdlet represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.

This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.

RequisitionLines_Aggregate


[{
  criticalCustomValidations: Text /* The list of failing critical custom validation messages that have been configured at the requisition line level as a single string. Each message is delimited by HTML encoded line feed character. */
  deliverToLocation: { /* The final location where the goods or services are delivered. Example: an "\~employee\~(s)" work station or stock room. */
     *id: Text /* wid / id / reference id */
  }
  descriptor: Text /* A preview of the instance */
  endDate: Date /* The end date requested for the service on the requisition line. */
  id: Text /* Id of the instance */
  item: { /* The item for the document line. */
     *id: Text /* wid / id / reference id */
  }
  itemDescription: Text /* The line item description for the requisition line. */
  lineCompany: { /* Returns the Company for the Business Document Line Distribution instance. */
     *id: Text /* wid / id / reference id */
  }
  lotSerialInformation: { /* Returns/Updates the instances of the Lot Serial Information for lines on the requisition for REST API. */
      descriptor: Text /* A preview of the instance */
      id: Text /* Id of the instance */
      lotNumber: Text /* The lot serial number for the bill only transaction. */
      serialNumber: Text /* The lot number for the bill only transaction. */
  }
  memo: Text /* The line memo for the requisition line. */
  noCharge: Boolean /* If true, the requisition line is a no charge requisition line. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area. */
  orderFromConnection: { /* The order-from supplier connection on the requisition line. The order-from connection populates on the requisition line based on sourcing rules or manual entry. */
     *id: Text /* wid / id / reference id */
  }
  quantity: Numeric /* The quantity on the requisition line. This value can have 20 integer places, is precise to 2 decimal places, and cannot be negative. */
  requestedDeliveryDate: Date /* The delivery date requested for the goods on the line. This field does not appear on the payload when a date isn't selected or when the line isn't for goods. */
  rfqRequired: Boolean /* If true, a request for quote is required for the requisition line. */
  shipToAddress: { /* The Address Reference related to the Ship-To Address of the document line.

Note: This CRF is only used internally via Closely Related Field configuration for Ship-To Address. */
     *id: Text /* wid / id / reference id */
  }
  shipToContact: { /* The Ship To contact \~worker\~ for the document line. */
     *id: Text /* wid / id / reference id */
  }
  spendCategory: { /* Returns the Spend Category defined on the Line for the Business Document Line Distribution. */
     *id: Text /* wid / id / reference id */
  }
  startDate: Date /* The start date requested for the service on the requisition line. */
  supplier: { /* The supplier as a worktag. */
     *id: Text /* wid / id / reference id */
  }
  supplierContract: { /* The supplier contract associated to the goods or services on the requisition line. The supplier contract may determine the pricing for the good or the service. */
     *id: Text /* wid / id / reference id */
  }
  supplierItemIdentifier: Text /* The alphanumeric identifier assigned by a supplier to an item. This can be different from the manufacturer identification number. */
  unitCost: Currency /* The unit cost for the requisition line. */
  unitOfMeasure: { /* The unit of measure for the document line. */
     *id: Text /* wid / id / reference id */
  }
  warningCustomValidations: Text /* The list of failing warning custom validation messages that have been configured at the requisition line level as a single string. Each message is delimited by HTML encoded line feed character. */
  worktags: [{
      descriptor: Text /* A preview of the instance */
      href: Text /* A link to the instance */
      id: Text /* Id of the instance */
      worktagType: { /* The worktag type. */
         *id: Text /* wid / id / reference id */
      }
  }]
  writeInGoods: Boolean /* If true, the requisition line is a goods line with no purchase item, supplier item, or catalog item. */
  writeInService: Boolean /* If true, the requisition line is a service line with no purchase item, supplier item, or catalog item. */
}]

Columns

Name Type ReadOnly Description
Id [KEY] String False

Id of the instance

AdditionalInformation String False

Supported for: SELECT, INSERT, UPDATE. The additional procedure details that a particular requisition is being created to accommodate.

Amount_Currency String False

Supported for: SELECT. The total amount for the requisition. This value displays in the currency for the requisition. Workday calculates this value as the sum of all requisition lines including additional charges such as tax and freight. (Currency name)

Amount_Value Decimal False

Supported for: SELECT. The total amount for the requisition. This value displays in the currency for the requisition. Workday calculates this value as the sum of all requisition lines including additional charges such as tax and freight. (Value)

Comments String False

Supported for: SELECT. Comments for canceling or closing a requisition.

Company_Descriptor String False

Supported for: SELECT. A preview of the instance

Company_Id String False

Supported for: SELECT, INSERT, UPDATE. Id of the instance

CriticalCustomValidations String False

Supported for: SELECT, INSERT, UPDATE. The list of failing critical custom validation messages that have been configured at the requisition header as a single string. These validations may represent aggregations at the line level. Each message is delimited by HTML encoded line feed character.

Currency_CurrencySymbol String False

Supported for: SELECT. The three letter currency symbol for the currency.

Currency_Descriptor String False

Supported for: SELECT. The full name of the currency.

Currency_Id String False

Supported for: SELECT, INSERT, UPDATE. Id of the instance

DeliverToLocationChain String False

Supported for: SELECT. The deliver-to location and the associated hierarchy of deliver-to locations for the requisition. When creating new requisition lines, this value is the line's default deliver-to location.

DeliverToLocation_Descriptor String False

Supported for: SELECT. A preview of the instance

DeliverToLocation_Id String False

Supported for: SELECT, UPDATE. Id of the instance

Descriptor String False

Supported for: SELECT, INSERT, UPDATE. A preview of the instance

ExternalSourceableId String False

Supported for: SELECT, INSERT, UPDATE. The External Sourceable ID for the requisition.

ExternalSystemId_Descriptor String False

Supported for: SELECT. A description of the instance

ExternalSystemId_Href String False

Supported for: SELECT. A link to the instance

ExternalSystemId_Id String False

Supported for: SELECT, INSERT, UPDATE. wid / id / reference id

FormattedAmount String False

Supported for: SELECT. The total amount for the requisition that shows the currency symbol. The locale of the current user determines the positive or negative display format, currency symbol placement, grouping separator, and decimal separator.

FormattedFreight String False

Supported for: SELECT. The freight amount for the requisition. Positive/negative display format, grouping separator, and decimal separator is based on the locale of the current logged in user.

FormattedOtherCharges String False

Supported for: SELECT. The other charges for the requisition. Positive/negative display format, grouping separator, and decimal separator is based on the locale of the current logged in user.

FormattedShippingAddress String False

Supported for: SELECT. The shipping address for the requisition as a single string. Each line of the shipping address is delimited by HTML encoded line feed character.

FormattedSubtotal String False

Supported for: SELECT. The line subtotal for the requisition. Positive/negative display format, grouping separator, and decimal separator is based on the locale of the current logged in user.

FreightAmount_Currency String False

Supported for: SELECT, INSERT, UPDATE. The total amount of freight charges that are applicable for the taxable document. (Currency name)

FreightAmount_Value Decimal False

Supported for: SELECT, INSERT, UPDATE. The total amount of freight charges that are applicable for the taxable document. (Value)

HighPriority Bool False

Supported for: SELECT, INSERT, UPDATE. Returns true if the "High Priority" checkbox was checked on the Requisition.

Href String False

Supported for: SELECT, INSERT. A link to the instance

InternalMemo String False

Supported for: SELECT, INSERT, UPDATE. The internal memo on a document. This type of memo is viewable by only internal workers of your company, and not any outside party.

InventorySite_Descriptor String False

Supported for: SELECT. A description of the instance

InventorySite_Href String False

Supported for: SELECT. A link to the instance

InventorySite_Id String False

Supported for: SELECT. wid / id / reference id

MedicalRecordNumber String False

Supported for: SELECT, INSERT, UPDATE. The medical record number that a particular requisition is being created to accommodate.

Memo String False

Supported for: SELECT, INSERT, UPDATE. The transaction memo for the reporting transaction.

OtherCharges_Currency String False

Supported for: SELECT, INSERT, UPDATE. The total amount of other charges that are applicable for the taxable document. (Currency name)

OtherCharges_Value Decimal False

Supported for: SELECT, INSERT, UPDATE. The total amount of other charges that are applicable for the taxable document. (Value)

ParLocation_Descriptor String False

Supported for: SELECT. A description of the instance

ParLocation_Href String False

Supported for: SELECT. A link to the instance

ParLocation_Id String False

Supported for: SELECT. wid / id / reference id

PatientId String False

Supported for: SELECT, INSERT, UPDATE. The patient id that a particular requisition is being created to accommodate.

PhysicianId String False

Supported for: SELECT, INSERT, UPDATE. The physician id that a particular requisition is being created to accommodate.

Procedure String False

Supported for: SELECT, INSERT, UPDATE. The procedure that a particular requisition is being created to accommodate.

ProcedureDate Datetime False

Supported for: SELECT, INSERT, UPDATE. The procedure date that a particular requisition is being created to accommodate.

ProcedureNumber String False

Supported for: SELECT, INSERT, UPDATE. The procedure number that a particular requisition is being created to accommodate.

ReasonCode_Descriptor String False

Supported for: SELECT. A description of the instance

ReasonCode_Href String False

Supported for: SELECT. A link to the instance

ReasonCode_Id String False

Supported for: SELECT. wid / id / reference id

Requester_Descriptor String False

Supported for: SELECT. A preview of the instance

Requester_Id String False

Supported for: SELECT, INSERT, UPDATE. Id of the instance

Requester_Image_Descriptor String False

Supported for: SELECT. A preview of the instance

Requester_Image_Href String False

Supported for: SELECT. A link to the instance

Requester_Image_Id String False

Supported for: SELECT. Id of the instance

Requester_Image_Url String False

Supported for: SELECT. The relative url for this image in UI Server.

RequestingEntity_Descriptor String False

Supported for: SELECT. A description of the instance

RequestingEntity_Href String False

Supported for: SELECT. A link to the instance

RequestingEntity_Id String False

Supported for: SELECT, INSERT. wid / id / reference id

RequisitionDate Datetime False

Supported for: SELECT. The date when the items of the requisition were requested.

RequisitionLines_Aggregate String False

Supported for: INSERT. A JSON aggregate. The requisition lines on the requisition. These lines may not be returned in the same order.

RequisitionType_Descriptor String False

Supported for: SELECT. A preview of the instance

RequisitionType_Id String False

Supported for: SELECT, INSERT, UPDATE. Id of the instance

RequisitionType_RequisitionTypeDetails_BillOnly Bool False

Supported for: SELECT. Bill Only flag defined on Maintain Requisition Types Task.

RequisitionType_RequisitionTypeDetails_Consignment Bool False

Supported for: SELECT. Consignment flag defined on Maintain Requisition Types Task.

RequisitionType_RequisitionTypeDetails_HasService Bool False

Supported for: SELECT. Does the requisition type have a service.

RequisitionType_RequisitionTypeDetails_Inactive Bool False

Supported for: SELECT. Inactive flag defined on Maintain Requisition Types Task.

RequisitionType_RequisitionTypeDetails_InventoryReplenishment Bool False

Supported for: SELECT. Inventory Replenishment flag defined on Maintain Requisition Types Task.

RequisitionType_RequisitionTypeDetails_JustInTime Bool False

Supported for: SELECT. Just In Time flag defined on Maintain Requisition Types Task.

RequisitionType_RequisitionTypeDetails_ParReplenishment Bool False

Supported for: SELECT. Par Replenishment flag defined on Maintain Requisition Types Task.

RequisitionType_RequisitionTypeDetails_ProcedureInformation Bool False

Supported for: SELECT. Procedure Information flag defined on Maintain Requisition Types Task.

RequisitionType_RequisitionTypeDetails_SupplierContractRequest Bool False

Supported for: SELECT. Supplier Contract Request flag defined on Maintain Requisition Types Task

ShippingAddress_Descriptor String False

Supported for: SELECT. A description of the instance

ShippingAddress_Href String False

Supported for: SELECT. A link to the instance

ShippingAddress_Id String False

Supported for: SELECT, UPDATE. wid / id / reference id

SourcingBuyer_Descriptor String False

Supported for: SELECT. A description of the instance

SourcingBuyer_Href String False

Supported for: SELECT. A link to the instance

SourcingBuyer_Id String False

Supported for: SELECT, INSERT, UPDATE. wid / id / reference id

Status_Descriptor String False

Supported for: SELECT. A description of the instance

Status_Href String False

Supported for: SELECT. A link to the instance

Status_Id String False

Supported for: SELECT. wid / id / reference id

Submitter_Descriptor String False

Supported for: SELECT. A description of the instance

Submitter_Href String False

Supported for: SELECT. A link to the instance

Submitter_Id String False

Supported for: SELECT. wid / id / reference id

SupplierRepresentative String False

Supported for: SELECT, INSERT, UPDATE. The supplier representative that a particular requisition is being created to accommodate.

VerifiedBy String False

Supported for: SELECT, INSERT, UPDATE. The procedure verified by that a particular requisition is being created to accommodate.

WarningCustomValidations String False

Supported for: SELECT, INSERT, UPDATE. The list of failing warning custom validation messages that have been configured at the requisition header as a single string. These validations may represent aggregations at the line level. Each message is delimited by HTML encoded line feed character.

ExternalSourceableId_Prompt String False

No description available.

ExternalSystemId_Prompt String False

No description available.

FromDate_Prompt Date False

Filters the requisitions with document date on or after the specified date. Use the yyyy-mm-dd format.

Requester_Prompt String False

Filters the requisitions by requester. Specify the Workday ID of the worker who requested the requisition.

RequisitionType_Prompt String False

Accepts multiple inputs. Filters the requisitions by type. Specify the Workday ID of the requisition type. You can specify multiple requisitionType query parameters.

SubmittedByPerson_Prompt String False

Filters the requisitions by the Person who submitted the requisition. Specify the Workday ID or the reference ID of the person.

SubmittedBySupplier_Prompt String False

Accepts multiple inputs. Filters the requisitions by the supplier who submitted the requisition. Specify the Workday ID or the reference ID of the supplier. You can specify multiple submittedBySupplier query parameters.

SubmittedBy_Prompt String False

Filters the requisitions by the Worker who submitted the requisition. Specify the Workday ID or the reference ID of the worker. You can use a returned id from GET /workers in the Staffing REST web service.

ToDate_Prompt Date False

Filters the requisitions with document date on or before the specified date. Use the yyyy-mm-dd format.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060