{ "swagger": "2.0", "info": { "description": "The Procurement service enables applications to access and create procurement data.", "version": "v5", "title": "procurement", "x-workday-internal-source": "xo", "x-workday-internal-routing": "Public", "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-service-container-id": "ba74f44bc90e107329f637811cde0039" }, "host": "", "basePath": "/procurement/v5", "tags": [ { "name": "purchaseOrders", "description": "Provides the ability to get information about purchase orders." }, { "name": "requisitionTemplates", "description": "Provides the ability to get information about requisition templates." }, { "name": "requisitions", "description": "Provides the ability to get, create, update, and delete requisitions." }, { "name": "Prompt Values", "description": "Retrieves instances that can be used as values for other endpoint parameters in this service." } ], "schemes": [ "https" ], "paths": { "/requisitions/{ID}/attachments?type=getFileContent": { "get": { "tags": [ "requisitions" ], "description": "Get attachment information. Note that this operation can return either the metadata of the attachment, or the binary content of the attachment. The difference is based on whether the query parameter type is specified.\n\nSecured By Domain: REST API Public\n\nContains attachment(s) only", "produces": [ "application/octet-stream", "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "file" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A2377 | You can't edit this requisition because it either is invalid or isn't in Draft or In Progress status. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "65042b73eb40100007881202a7e200a7", "x-workday-secured-by-domains": [ "REST API Public" ] } }, "/requisitions/{ID}/attachments/{subresourceID}": { "get": { "tags": [ "requisitions" ], "summary": "Retrieves the metadata or the attachment content of the specified requisition.", "description": "Retrieves the metadata of the attachment with the specified ID for the specified requisition.\n\nTo retrieve the attachment content, specify the type=getFileContent query parameter.\n\nSecured By Domain: REST API Public", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: File_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(File_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/businessDocumenAttachmentRepresentationView_aff036e6348f1000136753063d7500a1" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A2377 | You can't edit this requisition because it either is invalid or isn't in Draft or In Progress status. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "c08b59edd9d610001d4608ce28ef009c", "x-workday-secured-by-domains": [ "REST API Public" ] }, "delete": { "tags": [ "requisitions" ], "summary": "Deletes the specified requisition attachment.", "description": "Deletes the specified attachment to the requisition with the specified ID.\n\nSecured By Domain: REST API Public", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: File_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(File_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Deleting resource." }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A359 | Cannot delete attachment. Requisition attachment is not part of the Requisition. |\n| Critical | A2377 | You can't edit this requisition because it either is invalid or isn't in Draft or In Progress status. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "ca69b2817201100007063186c51d000d", "x-workday-secured-by-domains": [ "REST API Public" ] }, "patch": { "tags": [ "requisitions" ], "summary": "Partially updates the metadata of an existing attachment instance for a requisition.", "description": "Partially updates the metadata for the specified attachment for the requisition with the specified ID. Supported metadata: comment, external attachment indicator, and attachment category.\n\nSecured By Domain: REST API Public", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: File_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(File_ID)=\\S+)$" }, { "in": "body", "name": "businessDocumenAttachmentRepresentationEdit", "required": true, "schema": { "$ref": "#/definitions/businessDocumenAttachmentRepresentationEdit_fb7b966900c210000b9c29aa7eff00d6" } } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Updating resource.", "schema": { "$ref": "#/definitions/businessDocumenAttachmentRepresentationEdit_fb7b966900c210000b9c29aa7eff00d6" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A2377 | You can't edit this requisition because it either is invalid or isn't in Draft or In Progress status. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "fb7b966900c210000b9e5cb1b36800da", "x-workday-secured-by-domains": [ "REST API Public" ] } }, "/values/requisitionsGroup/resolvedWorktags/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "true" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/values/requisitionsGroup/itemTags/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-confidence-level": "Production", "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/purchaseOrders/{ID}": { "get": { "tags": [ "purchaseOrders" ], "summary": "Retrieves a purchase order.", "description": "Retrieves a purchase order with the specified ID.\n\nSecured By Domain: Process: Purchase Order - View, Process: Supplier Invoice (OLD), Process: Supplier Invoice - View, Process: Supplier Portal - Purchase Orders, Self-Service: Purchase Order, View: Organization Purchase Order\n\nScope: Procurement, Supplier Accounts", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Document_Number, Purchase_Order_Reference_ID, External_PO_Number", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Document_Number|Purchase_Order_Reference_ID|External_PO_Number)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/purchaseOrderDetail_cf195d74f9ec10000e604d7d51c6000f" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "cf195d74f9ec1000116ec1fd2d01001f", "x-workday-secured-by-domains": [ "Process: Purchase Order - View", "Process: Supplier Invoice (OLD)", "Process: Supplier Invoice - View", "Process: Supplier Portal - Purchase Orders", "Self-Service: Purchase Order", "View: Organization Purchase Order" ] } }, "/requisitions/{ID}/relatedPurchaseOrders/{subresourceID}": { "get": { "tags": [ "requisitions" ], "summary": "Retrieves a related purchase order for the specified requisition.", "description": "Retrieves a related purchase order with the specified ID for the specified requisition.\n\nSecured By Domain: Process: Purchase Order - Reporting, Process: Purchase Order - View, Process: Supplier Invoice (OLD), Process: Supplier Invoice - Reporting, Process: Supplier Invoice - View, Process: Supplier Portal - Purchase Orders, Reports: Organization Purchase Order Line Reporting, Reports: Organization Supplier Invoice Lines, Self-Service: Purchase Order, View: Organization Purchase Order\n\nScope: Procurement, Supplier Accounts", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Document_Number, Purchase_Order_Reference_ID, External_PO_Number", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Document_Number|Purchase_Order_Reference_ID|External_PO_Number)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/relatedPurchaseOrderSummary_cb124c4f53f010001af6190a9802001d" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "cb124c4f53f010001ae4c765c18f001b", "x-workday-secured-by-domains": [ "Process: Purchase Order - Reporting", "Process: Purchase Order - View", "Process: Supplier Invoice (OLD)", "Process: Supplier Invoice - Reporting", "Process: Supplier Invoice - View", "Process: Supplier Portal - Purchase Orders", "Reports: Organization Purchase Order Line Reporting", "Reports: Organization Supplier Invoice Lines", "Self-Service: Purchase Order", "View: Organization Purchase Order" ] } }, "/requisitions/{ID}/requisitionLines/{subresourceID}": { "get": { "tags": [ "requisitions" ], "summary": "Retrieves a requisition line for the specified requisition.", "description": "Retrieves a requisition line with the specified ID for the specified requisition.\n\nSecured By Domain: Process: Requisition - Reporting, Process: Requisition - View, Process: Supplier Portal - Requisitions, Self-Service: Requisition, View: Organization Requisition\n\nSecured By Business Process Type: Requisition Event\n\nScope: Procurement\n\nContains attachment(s)", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Line_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Line_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/requisitionLineSummary_4b60be2b856c100017ffbcc376cf3169" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A2377 | You can't edit this requisition because it either is invalid or isn't in Draft or In Progress status. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "5ccaff216cbc1000051b4ee66f5800b8", "x-workday-secured-by-domains": [ "Process: Requisition - Reporting", "Process: Requisition - View", "Process: Supplier Portal - Requisitions", "Self-Service: Requisition", "View: Organization Requisition" ], "x-workday-secured-by-business-process-types": [ "Requisition Event" ] }, "delete": { "tags": [ "requisitions" ], "summary": "Deletes the specified requisition line.", "description": "Deletes a line from the requisition with the specified ID.\n \n You can delete a requisition line only if all these conditions are true:\n \n * The requisition status is Draft or In Progress.\n \n * The requisition has more than 1 requisition line.\n \n * The requisition line is not part of the selected requisition.\n\nSecured By Business Process Type: Requisition Event\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Line_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Line_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Deleting resource." }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A315 | Cannot delete requisition line. A Deliverable, Service or Goods Line is required on the Requisition. |\n| Critical | A330 | Cannot delete line. You must have at least 1 line remaining with a Spend Category that has Allocate Freight if there are Freight Charges. |\n| Critical | A333 | Cannot delete requisition line. Requisition line is not part of the Requisition. |\n| Critical | A334 | Cannot delete line. You must have at least 1 line remaining with a Spend Category that has Allocate Other Charges if there are Other Charges. |\n| Critical | A342 | Cannot delete requisition line where status is not Draft or In Progress. |\n| Critical | A1082 | Requisitions with a source of Workday Strategic Sourcing cannot remove lines. |\n| Critical | A2377 | You can't edit this requisition because it either is invalid or isn't in Draft or In Progress status. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "b20a455d13e6100006779ff2bb69000b", "x-workday-secured-by-business-process-types": [ "Requisition Event" ] }, "patch": { "tags": [ "requisitions" ], "summary": "Edits a specific requisition line for the requisition with the specified ID.", "description": "Partially updates a requisition line for the requisition with the specified ID. \n \nTo enable bulk support, specify \"bulk=true\" as a query parameter instead of the {requisitionLine-id} path parameter. You must specify the data[] in the request body, where each array item is the requisition line. For each requisition line in the array, specify the requisition line id in the id attribute, along with the fields to update. The maximum array size is 20.\n\nOnly the following fields can be edited on the line: memo, endDate, quantity, requestedDeliveryDate, lotSerialInformation, worktags, startDate, supplierItemIdentifier, and unitCost.\n\n**Starting in v3:**\n\nThe following fields can also be edited: deliverToLocation, shipToAdressReference, unitOfMeasure, spendCategory, supplier, shipToAddress\n\nYou can call these GET /values/requisitionsGroups subresources to retrieve values for the requisition and its requisition lines. These prompt value endpoints return the values that the user has access to.\n\n* supplierContract: Retrieves all prompt values for supplier contract. You can filter the resources by supplier and requisition.\n\n* deliverToLocation: Retrieves all prompt values for deliver-to location. Only applicable to non-inventory requisitions. You can filter the resources by company, req type, and requisitionLine. \n\n* shipToAddress: Retrieves all prompt values for ship-to address. You can filter the resources by requisitionDate, company, requester, and requisitionLine.\n\n* unitOfMeasure: Retrieves all prompt values for unit of measure.\n\n* spendCategory: Retrieves all prompt values for spend category.\n\n* resourceProvider: Retrieves all prompt values for resource provider. You can use these values for the supplier field. You can filter the resources by company, currency, supplier, and supplierContract\n\n* worktags: Retrieves prompt values for worktags. You can filter the resources by requisitionDate and requisitionLine.\nresolvedWorktags: Retrieves worktag prompt values that have been resolved between the existingWorktags and selectedWorktags. The returned set will have only one worktag per worktag type and be valid for submission with a requisition or requisition line. Worktags passed under selectedWorktags will take precedence between selectedWorktags and existingWorktags in resolving duplicate worktags of a single type.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nSecured By Business Process Type: Requisition Event\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Line_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Line_ID)=\\S+)$" }, { "in": "body", "name": "addRequisitionLineRepresentation", "required": true, "schema": { "$ref": "#/definitions/addRequisitionLineRepresentation_85fe2adb40611000128e4ab1c92d018a" } } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Updating resource.", "schema": { "$ref": "#/definitions/addRequisitionLineRepresentation_85fe2adb40611000128e4ab1c92d018a" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A310 | Request includes field(s) that are not allowed for this operation of the requisition line. |\n| Critical | A329 | [invalid requisition line worktag value message] |\n| Critical | A348 | Service requests are not allowed for the selected company. |\n| Critical | A1602 | Supplier Contract Request requisitions don't support these fields on the lines: [Supplier Contract, No Charge, RFQ Required, Requested Delivery Date, Supplier Item Identifier]. |\n| Critical | A1604 | The calculated extended amount on the requisition line can't be zero. |\n| Critical | A2377 | You can't edit this requisition because it either is invalid or isn't in Draft or In Progress status. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "5895eceec01410000e7c5c5d5d68129a", "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ], "x-workday-secured-by-business-process-types": [ "Requisition Event" ] } }, "/values/requisitionsGroup/requesters/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/values/requisitionsGroup/companies/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\nNote: This prompt value endpoint also returns the Company_Reference_ID response field.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/companies_79938b33b430100016e942b7cee50000" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/requisitionTemplates/{ID}": { "get": { "tags": [ "requisitionTemplates" ], "summary": "Retrieves the goods and service line details of a requisition template.", "description": "Retrieves the goods and service line details of a requisition template with the specified ID. This operation returns only requisition templates that are authorized for use by the processing worker.\n\nYou can use the response data from this endpoint to:\n \n * Create a new requisition using POST /requisitions.\n \n * Add a requisition line to an existing requisition using POST /requisitions/{ID}/requisitionLines.\n\nSecured By Domain: Process: Shared Requisition Template - View, Self-Service: Requisition Template\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Template_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Template_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/requisitionTemplateDetail_8d1b9d13e05110002261c46350e40000" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "e0327f064855100023691de3e87b0000", "x-workday-secured-by-domains": [ "Process: Shared Requisition Template - View", "Self-Service: Requisition Template" ] } }, "/values/requisitionsGroup/orderFromConnection/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/values/requisitionsGroup/shipToAddress/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "true" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/values/requisitionsGroup/resourceProvider/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "true" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/requisitions/{ID}/close": { "post": { "tags": [ "requisitions" ], "summary": "Closes a specified completed requisition.", "description": "Closes the requisition with the specified ID. Specify an empty request body or add a reason or comment.\nYou can specify a reason and/or comments when closing the requisition. The reason codes are configured on the Maintain Procurement Reasons task.\n\nSecured By Domain: Process: Requisition - Close\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "in": "body", "name": "closeRequisitionRepresentation", "required": true, "schema": { "$ref": "#/definitions/closeRequisitionRepresentation_7a5a9e9d07dc100007da452c6b3216bc" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/closeRequisitionRepresentation_7a5a9e9d07dc100007da452c6b3216bc" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A1003 | The requisition can't be closed. Either transactions are in progress or the requisition is closed, canceled, or denied. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "7a5a9e9d07dc100008087dd84ded16c6", "x-workday-secured-by-domains": [ "Process: Requisition - Close" ] } }, "/requisitions": { "get": { "tags": [ "requisitions" ], "summary": "Retrieves a collection of requisitions.", "description": "Retrieves all requisitions. You can filter the requisitions by submitter, date, requester, and type.\n\nSecured By Domain: Process: Requisition - Reporting, Process: Requisition - View, Process: Supplier Portal - Requisitions, Self-Service: Requisition, View: Organization Requisition\n\nSecured By Business Process Type: Requisition Event\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [ { "name": "externalSourceableId", "in": "query", "required": false, "type": "string" }, { "name": "externalSystemId", "in": "query", "required": false, "type": "string" }, { "name": "fromDate", "in": "query", "description": "Filters the requisitions with document date on or after the specified date. Use the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "requester", "in": "query", "description": "Filters the requisitions by requester. Specify the Workday ID of the worker who requested the requisition.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "Filters the requisitions by type. Specify the Workday ID of the requisition type. You can specify multiple requisitionType query parameters.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "submittedBy", "in": "query", "description": "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.", "required": false, "type": "string" }, { "name": "submittedByPerson", "in": "query", "description": "Filters the requisitions by the Person who submitted the requisition. Specify the Workday ID or the reference ID of the person.", "required": false, "type": "string" }, { "name": "submittedBySupplier", "in": "query", "description": "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.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "toDate", "in": "query", "description": "Filters the requisitions with document date on or before the specified date. Use the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/requisitionSummary_4b60be2b856c1000091cded56022310a" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "4b60be2b856c1000083af1369bed30fd", "x-workday-secured-by-domains": [ "Process: Requisition - Reporting", "Process: Requisition - View", "Process: Supplier Portal - Requisitions", "Self-Service: Requisition", "View: Organization Requisition" ], "x-workday-secured-by-business-process-types": [ "Requisition Event" ] }, "post": { "tags": [ "requisitions" ], "summary": "Creates a requisition.", "description": "Creates a requisition with the specified data.\n \nIn the request body, specify at least the required fields: requester {id}, requisitionLines[].\n\nFor each requisition line of a catalog item, supplier item, or purchase item, specify at least item{id} and quantity. The item pricing information for the item will be derived and populated on the requisition line.\n\n**Starting in v3:**\n\nTo add a write-in requisition line, specify the requisition line either as a write-in goods line or a write-in services line:\n\n* For a write-in goods line: Set writeInGoods to true. Specify itemDescription, spendCategory{id}, unitOfMeasure{id}, and quantity.\n\n* For a write-in services line: Set writeInService to true. Specify itemDescription and spendCategory{id}.\n\nNote that item lines and write-in lines are mutually exclusive. If you specify an item{id}, the pricing information on the item will take precedence over any of the information passed in manually.\n\nYou can call these GET /values/requisitionsGroups subresources to retrieve values for the requisition and its requisition lines. These prompt value endpoints return the values that the user has access to.\n\n* currencies: Retrieves all prompt values for currency. You can filter the resources by requisitionDate and company.\n\n* requesters: Retrieves all prompt values for requesting workers.\n\n* companies: Retrieves all prompt values for company.\n\n* supplierContract: Retrieves all prompt values for supplier contract. You can filter the resources by supplier and requisition.\n\n* deliverToLocation: Retrieves all prompt values for deliver-to location. Only applicable to non-inventory requisitions. You can filter the resources by company, requisitionType, and requisitionLine. \n\n* shipToAddress: Retrieves all prompt values for ship-to address. You can filter the resources by requisitionDate, company, requester, and requisitionLine.\n\n* unitOfMeasure: Retrieves all prompt values for unit of measure.\n\n* spendCategory: Retrieves all prompt values for spend category.\n\n* resourceProvider: Retrieves all prompt values for resource provider. You can use these values for the supplier field. You can filter the resources by company, currency, supplier, and supplierContract.\n\n* worktags: Retrieves prompt values for worktags. You can filter the resources by requisitionDate and requisitionLine.\n\n* resolvedWorktags: Retrieves worktag prompt values that have been resolved between the existingWorktags and selectedWorktags (under prompt values). The returned set will have only one worktag per worktag type and be valid for submission with a requisition or requisition line. Worktags passed under selectedWorktags will take precedence between selectedWorktags and existingWorktags in resolving duplicate worktags of a single type.\n\n* requisitionTypes: Retrieves all prompt values for requisition type. You can filter the resources by reqTypeShowAllTypes, reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, and requisitionType. More detail on how to filter using these parameters can be found in the description of each parameter.\n\nSecured By Business Process Type: Requisition Event\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "createRequisitionRepresentation", "required": true, "schema": { "$ref": "#/definitions/createRequisitionRepresentation_7b5e81579f91100020cd39bdc84800c3" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/createRequisitionRepresentation_7b5e81579f91100020cd39bdc84800c3" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A14 | Specify a company that you have access to. You don't have access to this company. |\n| Critical | A84 | Only one worktag for each type is allowed for each document line. |\n| Critical | A117 | Currency Conversion Rates between currency and company's default currency are not defined. |\n| Critical | A118 | Select a balancing worktag for Worktags of the following type: [type] |\n| Critical | A291 | Only the purchase item unit of measure on the supplier contract line is valid. |\n| Critical | A292 | Suppliers that are restricted to company must be restricted to either the document header company or the Company Hierarchy for which it is a subordinate. |\n| Critical | A293 | Worktags specified are of types not valid for this transaction. |\n| Critical | A294 | Spend Category is required on all requisition lines. |\n| Critical | A295 | The Resource Provider provided must match the Resource Provider for the Item supplied. |\n| Critical | A297 | Only the purchase item ordering unit of measure is a valid unit of measure. |\n| Critical | A298 | Enter a Document Date that is between the supplier contract start date and end date. |\n| Critical | A299 | Some worktags have invalid worktag type. |\n| Critical | A300 | Can not have any combination of Project, Project Phase or Project Task worktags for the same line. |\n| Critical | A301 | Certain required worktags are missing for the requisition line. |\n| Critical | A303 | The specified Item is Invalid. |\n| Critical | A304 | Enter a valid Unit of Measure for the purchase item. This unit of measure is not defined for the supplier. |\n| Critical | A305 | Worktags for the requisition line are not available for use with the company for the requisition. |\n| Critical | A306 | You must have at least 1 line with a Spend Category that has Allocate Other Charges if there are Other Charges. |\n| Critical | A307 | [Invalid Worktags Values for Requisition] |\n| Critical | A308 | Negative or zero amount lines can't be marked RFQ Required. |\n| Critical | A309 | You are not authorized to request this item. |\n| Critical | A311 | Enter an End Date on or after the Start Date. |\n| Critical | A312 | The Ship-To Address is not valid for use on the Requisition Line. |\n| Critical | A313 | For requisition lines tagged with a capital \\~project\\~ worktag, the company of the requisition must equal the company on the capital \\~project\\~. |\n| Critical | A314 | One of more of worktag values are not allowed because they are inactive. |\n| Critical | A316 | Item Description is required. |\n| Critical | A317 | Company is required to have a value. |\n| Critical | A318 | Enter a valid Supplier for the item's Multi-Supplier Contract. |\n| Critical | A320 | Use a company with procurement options enabled for freight if there are Freight Charges. |\n| Critical | A321 | Quantity must be greater than zero and cannot be partial when the document line's spend category is Tracked (unless related to a supplier contract line). |\n| Critical | A322 | The Unit of Measure is invalid for the catalog item. Only defined units of measure for the catalog item can be used. |\n| Critical | A324 | Enter a Requested Delivery Date that is on or after the Document Date. |\n| Critical | A326 | Required worktag types are missing. |\n| Critical | A327 | The total extended amount of all lines must be greater than or equal to zero. |\n| Critical | A328 | Only the catalog item default unit of measure is a valid unit of measure. |\n| Critical | A331 | Company is not active. |\n| Critical | A335 | Healthcare options are not enabled for this type of requisition. |\n| Critical | A336 | Inventory Replenishment and Par Replenishment Requisition Types are not supported. |\n| Critical | A337 | Supplier Contract is not valid for the Company, Supplier, and Requisition Date. The contract must also allow manual requisitioning and purchasing. |\n| Critical | A338 | Unit of Measure is required on all Item Requisition Lines. |\n| Critical | A340 | Requisition Line is required. |\n| Critical | A343 | Ship-To Address is required. |\n| Critical | A344 | The currency on the requisition is not one of the acceptable currencies by [supplier]. Please select an acceptable currency or select a different supplier. |\n| Critical | A346 | Unit Cost submitted for Item Line must match Unit Cost calculated from Unit of Measure and Purchase Item Unit Cost. |\n| Critical | A347 | Sourcing Buyer for requisition should be an authorized buyer and should not be terminated. |\n| Critical | A348 | Service requests are not allowed for the selected company. |\n| Critical | A349 | The specified requester is not valid. |\n| Critical | A353 | Create or edit of requisition line for web item is currently not supported. |\n| Critical | A354 | Use a company with procurement options enabled for other charges if there are Other Charges. |\n| Critical | A355 | Consignment requisitions can't be created through REST API. Please use the application or Workday WebService operations to create consignment requisitions. |\n| Critical | A357 | The unit cost isn't valid for the selected unit of measure. |\n| Critical | A360 | Only the default ordering unit of measure for the supplier is a valid unit of measure. Enter a valid default Unit of Measure. |\n| Critical | A362 | You do not have permission to order from this Supplier. |\n| Critical | A364 | You must have at least 1 line with a Spend Category that has Allocate Freight if there are Freight Charges. |\n| Critical | A365 | Currency is required. |\n| Critical | A366 | Remove the RFQ Required option from the Requsition Line. You can't mark RFQ Required on requisition lines unless RFQ is configured for use. |\n| Critical | A367 | Select either Write-In Goods or Write-In Service. |\n| Critical | A545 | If a line is marked no-charge, then unit cost must be $0. |\n| Critical | A546 | No charge can only be submitted on goods lines with items. |\n| Critical | A547 | Unit Cost submitted must match Unit Cost calculated from Unit of Measure and Supplier Pricing for the Purchase Item. |\n| Critical | A671 | Some lines on this request have an invalid deliver-to location. |\n| Critical | A922 | Some lines on this requisition have an invalid order-from connection for its supplier. |\n| Critical | A941 | Enable Multi-Company for requisitions or don't use a line company. |\n| Critical | A942 | Set up an intercompany relationship between requisition company and line company using the Edit Company Intercompany Profile task. |\n| Critical | A1069 | You’ve added an item restricted by a Requesting Entity. Select another item. |\n| Critical | A1074 | Submit values for both External System ID and External Sourceable ID. |\n| Critical | A1077 | Remove the line, or select a different item or inventory site. You can't add items that are restricted from purchasing or inactive for the inventory site. |\n| Critical | A1078 | Enter a valid spend category. The requisition has lines that include inactive spend category. |\n| Critical | A1090 | You can't submit a requisition with a requisition type that is inactive. |\n| Critical | A1102 | The combination of external source and external ID must be unique. |\n| Critical | A1105 | No requisition ID generator has been configured. Unable to create this requisition. |\n| Critical | A1241 | You must have security permissions for the spend categories on each line. |\n| Critical | A1337 | Specify a supplier. A supplier is required when the External System ID refers to Workday Strategic Sourcing. |\n| Critical | A1338 | Set the RFQ Required field to false. RFQ Required can't be true when the External System ID refers to Workday Strategic Sourcing. |\n| Critical | A1575 | You can only use the Purchase Items or Non-Catalog Item Requests on Supplier Contract requisition types. |\n| Critical | A1602 | Supplier Contract Request requisitions don't support these fields on the lines: [Supplier Contract, No Charge, RFQ Required, Requested Delivery Date, Supplier Item Identifier]. |\n| Critical | A1603 | Supplier Contract Request requisitions don't support these fields on the header: [Freight Amount, Other Charges]. |\n| Critical | A1604 | The calculated extended amount on the requisition line can't be zero. |\n| Critical | A1815 | Supplier Contract Request requisition types aren't supported for requesting entity. |\n| Critical | A2435 | You can only use the Lot and Serial Number fields on lot and serial requisition types. |\n| Critical | A2464 | Quantity is required and can't be negative or zero. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "4b60be2b856c10001b3e116ffa0731a6", "x-workday-secured-by-business-process-types": [ "Requisition Event" ] } }, "/values/requisitionsGroup/deliverToLocation/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "true" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/values/requisitionsGroup/spendCategory/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\nNote: This prompt value endpoint also returns the Spend_Category_ID response field.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/spendCategory_30cd9bbfbe2610001dc6e7eb9a4a0000" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/requisitions/{ID}/cancel": { "post": { "tags": [ "requisitions" ], "summary": "Cancels an existing requisition.", "description": "Cancels the requisition with the specified ID, and terminates the Requisition business process. Specify an empty request body.\n \n**Starting in v3**\nOptionally specify a reason and/or comments when canceling a requisition. The reason codes are configured on the Maintain Procurement Reasons task.\n\nSecured By Domain: Process: Requisition - Cancel, Process: Supplier Portal - Requisitions, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "in": "body", "name": "cancelRequisitionRepresentation", "required": true, "schema": { "$ref": "#/definitions/cancelRequisitionRepresentation_b8474d2ad32110001ab4918eb9b80087" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/cancelRequisitionRepresentation_b8474d2ad32110001ab4918eb9b80087" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A332 | Current status of requisition does not allow cancellation. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "ed12424b368e10000b24395056cc003b", "x-workday-secured-by-domains": [ "Process: Requisition - Cancel", "Process: Supplier Portal - Requisitions", "Self-Service: Requisition" ] } }, "/values/requisitionsGroup/supplierContract/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/requisitions/{ID}/relatedPurchaseOrders": { "get": { "tags": [ "requisitions" ], "summary": "Retrieves a collection of related purchase orders.", "description": "Retrieves related purchase order information for the specified requisition.\n\nSecured By Domain: Process: Purchase Order - Reporting, Process: Purchase Order - View, Process: Supplier Invoice (OLD), Process: Supplier Invoice - Reporting, Process: Supplier Invoice - View, Process: Supplier Portal - Purchase Orders, Reports: Organization Purchase Order Line Reporting, Reports: Organization Supplier Invoice Lines, Self-Service: Purchase Order, View: Organization Purchase Order\n\nScope: Procurement, Supplier Accounts", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/relatedPurchaseOrderSummary_cb124c4f53f010001af6190a9802001d" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "cb124c4f53f010001ae4c765c18f001b", "x-workday-secured-by-domains": [ "Process: Purchase Order - Reporting", "Process: Purchase Order - View", "Process: Supplier Invoice (OLD)", "Process: Supplier Invoice - Reporting", "Process: Supplier Invoice - View", "Process: Supplier Portal - Purchase Orders", "Reports: Organization Purchase Order Line Reporting", "Reports: Organization Supplier Invoice Lines", "Self-Service: Purchase Order", "View: Organization Purchase Order" ] } }, "/values/requisitionsGroup/unitOfMeasure/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\nNote: This prompt value endpoint also returns the unCefactCommonCode response field.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/unitOfMeasure_d1b9eb68ca14100010158ba233da0000" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "true" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/values/requisitionsGroup/sourcingBuyer/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/values/requisitionsGroup/lineCompany/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "true" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/values/requisitionsGroup/inventorySite/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "true" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/requisitionTemplates": { "get": { "tags": [ "requisitionTemplates" ], "summary": "Retrieves a collection of requisition templates.", "description": "Retrieves all requisition templates for creating requisitions. This operation returns only requisition templates that are authorized for use by the processing worker.\n\nThe GET /requisitionTemplates returns a collection of requisition template summaries, including the name, company, the date it was created, and the total number of goods and service lines. To get the goods and service line details for a specific requisition template, call GET /requisitionTemplates/{ID} where ID is a returned id from GET /requisitionTemplates.\n\nSecured By Domain: Process: Shared Requisition Template - View, Self-Service: Requisition Template\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [ { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/requisitionTemplateSummary_8d1b9d13e0511000210515a1bdba0000" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "e0327f064855100023691de3e87b0000", "x-workday-secured-by-domains": [ "Process: Shared Requisition Template - View", "Self-Service: Requisition Template" ] } }, "/values/requisitionsGroup/currencies/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "true" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/requisitions/{ID}": { "get": { "tags": [ "requisitions" ], "summary": "Retrieves a requisition.", "description": "Retrieves a requisition with the specified ID.\n\nSecured By Domain: Process: Requisition - Reporting, Process: Requisition - View, Process: Supplier Portal - Requisitions, Self-Service: Requisition, View: Organization Requisition\n\nSecured By Business Process Type: Requisition Event\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/requisitionSummary_4b60be2b856c1000091cded56022310a" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "4b60be2b856c1000083af1369bed30fd", "x-workday-secured-by-domains": [ "Process: Requisition - Reporting", "Process: Requisition - View", "Process: Supplier Portal - Requisitions", "Self-Service: Requisition", "View: Organization Requisition" ], "x-workday-secured-by-business-process-types": [ "Requisition Event" ] }, "patch": { "tags": [ "requisitions" ], "summary": "Updates the header of an existing requisition.", "description": "Partially updates the header attributes of the requisition with the specified ID. \n\n**Starting in v3:**\n\nYou can call these GET /values/requisitionsGroups subresources to retrieve values for the requisition and its requisition lines. These prompt value endpoints return the values that the user has access to.\n\n* currencies: Retrieves all prompt values for currency. You can filter the resources by requisitionDate and company.\n\n* deliverToLocation: Retrieves all prompt values for deliver-to location. Only applicable to non-inventory requisitions. You can filter the resources by company, req type, and requisitionLine. \n\n* shipToAddress: Retrieves all prompt values for ship-to address. You can filter the resources by requisitionDate, company, requester, and requisitionLine.\n\n* worktags: Retrieves prompt values for worktags. You can filter the resources by requisitionDate and requisitionLine.\n\n* resolvedWorktags: Retrieves worktag prompt values that have been resolved between the existingWorktags and selectedWorktags. The returned set will have only one worktag per worktag type and be valid for submission with a requisition or requisition line. Worktags passed under selectedWorktags will take precedence between selectedWorktags and existingWorktags in resolving duplicate worktags of a single type.\n\n* requisitionType: Retrieves all prompt values for requisition type. You can filter the resources by reqTypeShowAllTypes, reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, and requisitionType. More detail on how to filter using these parameters can be found in the description of each parameter.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nSecured By Business Process Type: Requisition Event\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "in": "body", "name": "editRequisitionRepresentation", "required": true, "schema": { "$ref": "#/definitions/editRequisitionRepresentation_3fafcba98b15100010029c8fb24a1255" } } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data. Updating resource.", "schema": { "$ref": "#/definitions/editRequisitionRepresentation_3fafcba98b15100010029c8fb24a1255" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A327 | The total extended amount of all lines must be greater than or equal to zero. |\n| Critical | A335 | Healthcare options are not enabled for this type of requisition. |\n| Critical | A682 | Requisition attributes cannot be edited. Remove the requisition lines to make changes to the attributes. |\n| Critical | A1074 | Submit values for both External System ID and External Sourceable ID. |\n| Critical | A1105 | No requisition ID generator has been configured. Unable to create this requisition. |\n| Critical | A1575 | You can only use the Purchase Items or Non-Catalog Item Requests on Supplier Contract requisition types. |\n| Critical | A1603 | Supplier Contract Request requisitions don't support these fields on the header: [Freight Amount, Other Charges]. |\n| Critical | A2377 | You can't edit this requisition because it either is invalid or isn't in Draft or In Progress status. |\n| Critical | A2435 | You can only use the Lot and Serial Number fields on lot and serial requisition types. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "3fafcba98b15100010221b0c3ef11257", "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ], "x-workday-secured-by-business-process-types": [ "Requisition Event" ] } }, "/requisitions/{ID}/attachments/{subresourceID}?type=getFileContent": { "get": { "tags": [ "requisitions" ], "description": "Get attachment information. Note that this operation can return either the metadata of the attachment, or the binary content of the attachment. The difference is based on whether the query parameter type is specified.\n\nSecured By Domain: REST API Public\n\nContains attachment(s) only", "produces": [ "application/octet-stream", "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "name": "subresourceID", "in": "path", "description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: File_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(File_ID)=\\S+)$" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "file" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A2377 | You can't edit this requisition because it either is invalid or isn't in Draft or In Progress status. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "65042b73eb40100007881202a7e200a7", "x-workday-secured-by-domains": [ "REST API Public" ] } }, "/values/requisitionsGroup/requestingEntity/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/purchaseOrders": { "get": { "tags": [ "purchaseOrders" ], "summary": "Retrieves a collection of purchase orders.", "description": "Retrieves all purchase orders. You can filter the purchase orders by status, date, buyer, supplier, and other filter parameters.\n\nSecured By Domain: Process: Purchase Order - View, Process: Supplier Invoice (OLD), Process: Supplier Invoice - View, Process: Supplier Portal - Purchase Orders, Self-Service: Purchase Order, View: Organization Purchase Order\n\nScope: Procurement, Supplier Accounts", "produces": [ "application/json" ], "parameters": [ { "name": "buyer", "in": "query", "description": "Filters the purchase orders by buyer. Specify the Workday ID of the worker assigned as buyer on the purchase order. You can specify multiple buyer query parameters.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "company", "in": "query", "description": "Filters the purchase orders by company. Specify the Workday ID of the company. You can specify multiple company query parameters.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "excludeCanceled", "in": "query", "description": "If true, this method excludes the purchase orders with Canceled status. The default is false.", "required": false, "type": "boolean" }, { "name": "excludeClosed", "in": "query", "description": "If true, this method excludes the purchase orders with Closed status. The default is false.", "required": false, "type": "boolean" }, { "name": "fromDate", "in": "query", "description": "Filters the purchase orders with document date on or after the specified date. Use the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "orderFromConnection", "in": "query", "description": "Filters the purchase orders by supplier order-from connections. Specify the Workday ID of the order-from connection. You can specify multiple order-from connection query parameters.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "status", "in": "query", "description": "Filters the purchase orders by status. Specify the Workday ID of the status. You can specify multiple status query parameters.\n\nValid values:\n\n* 8a54a80900cb4114b62f82ed86e495f7 - Pending Issue\n\n* dc76c312446c11de98360015c5e6daf6 - Issued \n\n* dc76c8bc446c11de98360015c5e6daf6 - In Progress\n\n* dc76c4fc446c11de98360015c5e6daf6 - Draft\n\n* dc76c7cc446c11de98360015c5e6daf6 - Denied\n\n* 24f0f71de78540cbb1445ba9e5e94d17 - Closed\n\n* bd5a732c160c4e84b350ba4d6f7c10c5 - Change Order In Progress\n\n* dc76c9b6446c11de98360015c5e6daf6 - Canceled\n\n* 91b0d382d50848e898733757caa9f84a - Approved", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "submittedBy", "in": "query", "description": "Filters the purchase orders by the worker who submitted the purchase order. Specify the Workday ID of the worker. You can specify multiple submittedBy query parameters. You can use a returned id from GET /workers in the Staffing REST web service.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "Filters the purchase orders by supplier. Specify the Workday ID of the supplier. You can specify multiple supplier query parameters.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "toDate", "in": "query", "description": "Filters the purchase orders with document date on or before the specified date. Use the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/purchaseOrderSummary_4c2f0151c56510000819ce72b3d500a8" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "cf195d74f9ec1000116ec1fd2d01001f", "x-workday-secured-by-domains": [ "Process: Purchase Order - View", "Process: Supplier Invoice (OLD)", "Process: Supplier Invoice - View", "Process: Supplier Portal - Purchase Orders", "Self-Service: Purchase Order", "View: Organization Purchase Order" ] } }, "/requisitions/{ID}/attachments": { "get": { "tags": [ "requisitions" ], "summary": "Retrieves the metadata of the attachments for the specified requisition.", "description": "Retrieves the metadata of the attachments for the requisition with the specified ID. \n \nTo get the file content of a single attachment, call GET /requisitions/{ID}/attachments/{subresourceID}?type=getFileContent.\n\nSecured By Domain: REST API Public", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/businessDocumenAttachmentRepresentationView_aff036e6348f1000136753063d7500a1" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A2377 | You can't edit this requisition because it either is invalid or isn't in Draft or In Progress status. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "c08b59edd9d610001d4608ce28ef009c", "x-workday-secured-by-domains": [ "REST API Public" ] }, "post": { "tags": [ "requisitions" ], "summary": "Creates a new attachment for the specified requisition.", "description": "Creates an attachment for the requisition with the specified ID. The maximum file size for a single attachment is 3072000 bytes (30mb).\n \nSet the Content-type HTTP header to multipart/form-data, and specify the file location in the attachmentContent form-data field.\n\nSecured By Business Process Type: Requisition Event\n\nScope: Procurement\n\nContains attachment(s)\n\nContains attachment(s)", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "in": "body", "name": "jsonData", "required": true, "schema": { "$ref": "#/definitions/businessDocumentAttachmentRepresentationCreate_c08b59edd9d610001c7f03721b53007c" }, "x-workday-multipart-root-part-name": "jsonData" } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/businessDocumentAttachmentRepresentationCreate_c08b59edd9d610001c7f03721b53007c" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A246 | One of the following file extensions must be used: [allowed file extensions]. |\n| Critical | A252 | Enter a file name. |\n| Critical | A280 | The file size should not exceed [file size]MB. |\n| Critical | A319 | You cannot attach an empty file. Please select another file to upload. |\n| Critical | A2377 | You can't edit this requisition because it either is invalid or isn't in Draft or In Progress status. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-multipart-root-part-name": "jsonData", "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "c08b59edd9d610001c7fb6d738f70083", "x-workday-secured-by-business-process-types": [ "Requisition Event" ] } }, "/values/requisitionsGroup/recurrence/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-confidence-level": "Production", "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/values/requisitionsGroup/requisitionTypes/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/requisitionTypes_72e9dc2aa56c10000e241e7846920000" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "true" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/values/requisitionsGroup/manufacturers/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-confidence-level": "Production", "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/values/requisitionsGroup/parLocation/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "true" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/values/requisitionsGroup/commodityCodes/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "false" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/requisitions/{ID}/requisitionEvents": { "post": { "tags": [ "requisitions" ], "summary": "Submit Requisition to Business Process", "description": "\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nSecured By Business Process Type: Requisition Event\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "in": "body", "name": "submitFinancialEventRepresentation", "required": true, "schema": { "$ref": "#/definitions/submitFinancialEventRepresentation_0e057f97262f10000d031ac5c3330000" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/submitFinancialEventRepresentation_0e057f97262f10000d031ac5c3330000" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A302 | You cannot submit this requisition due to Critical Custom Validations. Please fix the exceptions before submitting the requisition. |\n| Critical | A327 | The total extended amount of all lines must be greater than or equal to zero. |\n| Critical | A352 | A Deliverable, Service or Goods Line is required on the Requisition. |\n| Critical | A356 | You cannot submit this requisition. Either the requisition is not in submittable status, or you are not authorized to submit this requisition. |\n| Critical | A1090 | You can't submit a requisition with a requisition type that is inactive. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "68d94ddc0831100027abbe037b760000", "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ], "x-workday-secured-by-business-process-types": [ "Requisition Event" ] } }, "/values/requisitionsGroup/worktags/": { "get": { "tags": [ "Prompt Values" ], "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.\n\nSecured By Domain: Process: Requisition - Create/Edit, Self-Service: Requisition\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "$ref": "#/definitions/MULTIPLE_INSTANCE_MODEL_REFERENCE" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-protected-usage-enabled": false, "x-workday-internal-try-enabled": "true" }, "parameters": [ { "name": "additionalWorktags", "in": "query", "required": false, "type": "boolean" }, { "name": "allStandaloneTypes", "in": "query", "required": false, "type": "boolean" }, { "name": "commodityCode", "in": "query", "description": "The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code.", "required": false, "type": "string" }, { "name": "company", "in": "query", "description": "The Workday ID of the company.", "required": false, "type": "string" }, { "name": "currency", "in": "query", "description": "The Workday ID of the currency.", "required": false, "type": "string" }, { "name": "existingWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "itemDescription", "in": "query", "description": "The description of an item.", "required": false, "type": "string" }, { "name": "itemSpendCategory", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default and maximum is 1000.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" }, { "name": "procurementItem", "in": "query", "required": false, "type": "string" }, { "name": "reqTypeBillOnly", "in": "query", "description": "If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeBillOnly=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeBillOnly and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeBillOnly=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeConsignment", "in": "query", "description": "If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeConsignment=true and reqTypeBillOnly=true, this endpoint retrieves the requisition types whose reqTypeConsignment and reqTypeBillOnly are both true. It won't retrieve requisition types whose reqTypeConsignment=true and reqTypeBillOnly=false.", "required": false, "type": "boolean" }, { "name": "reqTypeInvReplenishment", "in": "query", "description": "If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeInvReplenishment=true and reqTypeJustInTime=true, this endpoint retrieves the requisition types whose reqTypeInvReplenishment and reqTypeJustInTime are both true. It won't retrieve requisition types whose reqTypeInvReplenishment=true and reqTypeJustInTime=false.", "required": false, "type": "boolean" }, { "name": "reqTypeJustInTime", "in": "query", "description": "If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeJustInTime=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeJustInTime and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeJustInTime=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeParReplenishment", "in": "query", "description": "If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. \n\nExample: If you specify the query parameters reqTypeParReplenishment=true and reqTypeConsignment=true, this endpoint retrieves the requisition types whose reqTypeParReplenishment and reqTypeConsignment are both true. It won't retrieve requisition types whose reqTypeParReplenishment=true and reqTypeConsignment=false.", "required": false, "type": "boolean" }, { "name": "reqTypeShowAllTypes", "in": "query", "description": "If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results.", "required": false, "type": "boolean" }, { "name": "reqTypeSupplierContract", "in": "query", "description": "If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract.", "required": false, "type": "boolean" }, { "name": "requester", "in": "query", "description": "The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005", "required": false, "type": "string" }, { "name": "requisition", "in": "query", "description": "The Workday ID of the requisition.", "required": false, "type": "string" }, { "name": "requisitionDate", "in": "query", "description": "The requisition date using the yyyy-mm-dd format.", "required": false, "type": "string", "format": "date" }, { "name": "requisitionLine", "in": "query", "description": "The Workday ID of the requisition line.", "required": false, "type": "string" }, { "name": "requisitionType", "in": "query", "description": "The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). \n\nIf not populated, the default is the combination of reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, and reqTypeConsignment.\n\nIgnored if reqTypeShowAllTypes is populated.", "required": false, "type": "string" }, { "name": "resourceProviderContract", "in": "query", "description": "The Workday ID of the supplier contract.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.", "required": false, "type": "string" }, { "name": "selectedWorktags", "in": "query", "description": "The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "supplier", "in": "query", "description": "The Workday ID of the resource provider.", "required": false, "type": "string" }, { "name": "typesWithoutService", "in": "query", "required": false, "type": "boolean" }, { "name": "validForRequestingEntity", "in": "query", "description": "This parameter holds a true value when Requesting Entity is selected.", "required": false, "type": "boolean" }, { "name": "worktagType", "in": "query", "required": false, "type": "string" }, { "name": "worktagTypeOrderIndex", "in": "query", "description": "The ordered index of the worktag type to search within. 0 targets additional (non-primary) worktags; 1..n target the configured primary worktag types in order. Used to constrain worktag prompt search for primary worktag types.", "required": false, "type": "integer", "format": "int64" } ], "x-workday-secured-by-domains": [ "Process: Requisition - Create/Edit", "Self-Service: Requisition" ] }, "/requisitions/{ID}/requisitionLines": { "get": { "tags": [ "requisitions" ], "summary": "Retrieves a collection of requisition lines.", "description": "Retrieves all requisition lines for the requisition with the specified ID.\n\nSecured By Domain: Process: Requisition - Reporting, Process: Requisition - View, Process: Supplier Portal - Requisitions, Self-Service: Requisition, View: Organization Requisition\n\nSecured By Business Process Type: Requisition Event\n\nScope: Procurement\n\nContains attachment(s)", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "name": "limit", "in": "query", "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.", "required": false, "type": "integer", "format": "int64" }, { "name": "offset", "in": "query", "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Successful response. A successful response can return no matched data.", "schema": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "data": { "type": "array", "items": { "$ref": "#/definitions/requisitionLineSummary_4b60be2b856c100017ffbcc376cf3169" } } } } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A2377 | You can't edit this requisition because it either is invalid or isn't in Draft or In Progress status. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "true", "x-workday-operation-id": "5ccaff216cbc1000051b4ee66f5800b8", "x-workday-secured-by-domains": [ "Process: Requisition - Reporting", "Process: Requisition - View", "Process: Supplier Portal - Requisitions", "Self-Service: Requisition", "View: Organization Requisition" ], "x-workday-secured-by-business-process-types": [ "Requisition Event" ] }, "post": { "tags": [ "requisitions" ], "summary": "Creates requisition lines for the specified requisition.", "description": "Creates requisition lines for the requisition with the specified ID. \n \nTo enable bulk support for multiple requisition lines, specify \"bulk=true\" as a query parameter. You must specify the data[] in the request body, where each array item is a requisition line. Note that if you're adding only a single requisition line, specify the required fields without the data[]. The maximum array size is 20.\n \nFor each requisition line of a catalog item, supplier item, or purchase item, specify at least item{id} and quantity. The item pricing information for the item will be derived and populated on the requisition line.\n\n**Starting in v3:**\n\nTo add a write-in requisition line, specify the requisition line either as a write-in goods line or a write-in services line:\n\n* For a write-in goods line: Set writeInGoods to true. Specify itemDescription, spendCategory{id}, unitOfMeasure{id}, and quantity.\n\n* For a write-in services line: Set writeInService to true. Specify itemDescription and spendCategory{id}.\n\nNote that item lines and write-in lines are mutually exclusive. If you specify an item{id}, the pricing information on the item will take precedence over any of the information passed in manually.\n\nYou can call these GET /values/requisitionsGroups subresources to retrieve values for the requisition and its requisition lines. These prompt value endpoints return the values that the user has access to.\n\n* supplierContract: Retrieves all prompt values for supplier contract. You can filter the resources by supplier and requisition.\n\n* deliverToLocation: Retrieves all prompt values for deliver-to location. Only applicable to non-inventory requisitions. You can filter the resources by company, req type, and requisitionLine. \n\n* shipToAddress: Retrieves all prompt values for ship-to address. You can filter the resources by requisitionDate, company, requester, and requisitionLine.\n\n* unitOfMeasure: Retrieves all prompt values for unit of measure.\n\n* spendCategory: Retrieves all prompt values for spend category.\n\n* resourceProvider: Retrieves all prompt values for resource provider. You can use these values for the supplier field. You can filter the resources by company, currency, supplier, and supplierContract.\n\n* worktags: Retrieves prompt values for worktags. You can filter the resources by requisitionDate and requisitionLine.\n\n* resolvedWorktags: Retrieves worktag prompt values that have been resolved between the existingWorktags and selectedWorktags. The returned set will have only one worktag per worktag type and be valid for submission with a requisition or requisition line. Worktags passed under selectedWorktags will take precedence between selectedWorktags and existingWorktags in resolving duplicate worktags of a single type.\n\nSecured By Business Process Type: Requisition Event\n\nScope: Procurement", "produces": [ "application/json" ], "parameters": [ { "name": "ID", "in": "path", "description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "required": true, "type": "string", "pattern": "^([0-9a-f]{32}|(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+)$" }, { "in": "body", "name": "addRequisitionLineRepresentation", "required": true, "schema": { "$ref": "#/definitions/addRequisitionLineRepresentation_85fe2adb40611000128e4ab1c92d018a" } } ], "responses": { "201": { "description": "Resource created.", "schema": { "$ref": "#/definitions/addRequisitionLineRepresentation_85fe2adb40611000128e4ab1c92d018a" } }, "400": { "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A84 | Only one worktag for each type is allowed for each document line. |\n| Critical | A118 | Select a balancing worktag for Worktags of the following type: [type] |\n| Critical | A293 | Worktags specified are of types not valid for this transaction. |\n| Critical | A295 | The Resource Provider provided must match the Resource Provider for the Item supplied. |\n| Critical | A298 | Enter a Document Date that is between the supplier contract start date and end date. |\n| Critical | A299 | Some worktags have invalid worktag type. |\n| Critical | A300 | Can not have any combination of Project, Project Phase or Project Task worktags for the same line. |\n| Critical | A301 | Certain required worktags are missing for the requisition line. |\n| Critical | A303 | The specified Item is Invalid. |\n| Critical | A305 | Worktags for the requisition line are not available for use with the company for the requisition. |\n| Critical | A309 | You are not authorized to request this item. |\n| Critical | A313 | For requisition lines tagged with a capital \\~project\\~ worktag, the company of the requisition must equal the company on the capital \\~project\\~. |\n| Critical | A314 | One of more of worktag values are not allowed because they are inactive. |\n| Critical | A316 | Item Description is required. |\n| Critical | A325 | Unit of measure is required on item lines. |\n| Critical | A326 | Required worktag types are missing. |\n| Critical | A329 | [invalid requisition line worktag value message] |\n| Critical | A348 | Service requests are not allowed for the selected company. |\n| Critical | A353 | Create or edit of requisition line for web item is currently not supported. |\n| Critical | A366 | Remove the RFQ Required option from the Requsition Line. You can't mark RFQ Required on requisition lines unless RFQ is configured for use. |\n| Critical | A367 | Select either Write-In Goods or Write-In Service. |\n| Critical | A1058 | Unable to add item. Someone submitted or saved your shopping cart as a requisition. Go back to your requisitions workarea and try again. |\n| Critical | A1083 | Requisitions with a source of Workday Strategic Sourcing cannot add lines. |\n| Critical | A1575 | You can only use the Purchase Items or Non-Catalog Item Requests on Supplier Contract requisition types. |\n| Critical | A1602 | Supplier Contract Request requisitions don't support these fields on the lines: [Supplier Contract, No Charge, RFQ Required, Requested Delivery Date, Supplier Item Identifier]. |\n| Critical | A1604 | The calculated extended amount on the requisition line can't be zero. |\n| Critical | A2377 | You can't edit this requisition because it either is invalid or isn't in Draft or In Progress status. |\n| Critical | A2435 | You can only use the Lot and Serial Number fields on lot and serial requisition types. |", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "401": { "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "403": { "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "404": { "description": "Resource not found. (https://community.workday.com/rest/error-messages)", "schema": { "$ref": "#/definitions/VALIDATION_ERROR_MODEL_REFERENCE" } }, "default": { "description": "An error occurred.", "schema": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } }, "x-workday-internal-try-enabled": "false", "x-workday-operation-id": "15b1827d5fef100013dfede1648a0052", "x-workday-secured-by-business-process-types": [ "Requisition Event" ] } } }, "securityDefinitions": { "OAuth2": { "type": "oauth2", "authorizationUrl": "https://", "flow": "implicit" } }, "definitions": { "INSTANCE_MODEL_REFERENCE": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "pattern": "^(([0-9a-f]{32})|(\\S+=\\S+))$" }, "descriptor": { "type": "string", "description": "The display name of the instance", "readOnly": true }, "href": { "type": "string", "description": "A link to the instance", "readOnly": true } } }, "ERROR_MODEL_REFERENCE": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "description": "A description of the error" }, "code": { "type": "string", "description": "The code that corresponds to the error message. Use the error code to drive programmatic error-handling behavior. Don't use error message strings for this purpose because they are subject to change" }, "field": { "type": "string", "description": "The field related to the error" }, "path": { "type": "string", "description": "The path of the field related to the error" }, "severity": { "type": "string", "description": "Severity of the validation (e.g. Critical, Warning)." }, "internalMessage": { "type": "string", "description": "Internal message providing additional context for the validation (e.g. representation content validation details)." } } }, "VALIDATION_ERROR_MODEL_REFERENCE": { "allOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string", "description": "A description of the error" }, "errors": { "type": "array", "description": "An array of validation errors", "items": { "$ref": "#/definitions/ERROR_MODEL_REFERENCE" } } } } ] }, "FACETS_MODEL_REFERENCE": { "type": "array", "items": { "type": "object", "description": "This object represents the possible facets for this resource", "readOnly": true, "properties": { "descriptor": { "type": "string", "description": "A description of the facet" }, "facetParameter": { "type": "string", "description": "The alias used to select the facet" }, "values": { "type": "array", "description": "the facet values", "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "description": "The number of instances returned by this facet" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "pattern": "^(([0-9a-f]{32})|(\\S+=\\S+))$" }, "descriptor": { "type": "string", "description": "A description of the facet" }, "href": { "type": "string", "description": "A link to the instance", "readOnly": true } }, "required": [ "id" ] } } } } }, "MULTIPLE_INSTANCE_MODEL_REFERENCE": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" } } } }, "WorkdayId": { "type": "string", "pattern": "^[0-9a-f]{32}$", "description": "Workday ID (32-character lowercase hexadecimal string).", "example": "a3f5b554007d20e98360015c5e6daf6" }, "WorkdayReferenceId_purchaseOrders": { "type": "string", "pattern": "^(Document_Number|Purchase_Order_Reference_ID|External_PO_Number)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Document_Number, Purchase_Order_Reference_ID, External_PO_Number", "example": "Document_Number=21002" }, "ResourceIdPathValue_purchaseOrders": {}, "shippingTerms_cf195d74f9ec100013504c247744003b": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The shipping terms selected for the purchase order. Shipping terms provide the details of transportation applicable to selected purchase order." }, "billToContact_cf195d74f9ec100013c9bbe838e2004c": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The bill-to contact on the purchase order. This value is always a worker in Workday. This field contains the contact details for billing for a purchase order." }, "paymentType_cf195d74f9ec100013504c3d615f003d": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The override payment type specified on the purchase order. The default is the Default Payment Type for the Supplier on the purchase order." }, "submittedBy_d35e83e8978810000961a7d787380104": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The worker who submitted the purchase order document." }, "shippingMethod_6e77418f30e110000a4a476d666d003e": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The shipping method for the purchase order. This field contains the freight carrier information for the transportation of the goods and services on the purchase order." }, "supplierContract_cf195d74f9ec100013504c0e9a770039": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The supplier contract referenced by the supplier business document." }, "currency_cf195d74f9ec100012b6c252dc4f0032": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The currency of the purchase order." }, "orderFromConnection_cf195d74f9ec100012b6c26427a90033": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The order-from connection for the supplier on the purchase order." }, "shipToAddress_cf195d74f9ec10000e604db33c4d0010": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The shipping address for the purchase order." }, "supplier_cf195d74f9ec1000125aaedc04020029": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The supplier for the purchase order." }, "buyer_cf195d74f9ec100013504bd6dd390035": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The buyer responsible for sourcing the purchase order." }, "paymentTerms_cf195d74f9ec100012b6c1ee4166002b": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The payment terms of the customer defined on the transaction or payment terms defined on the transaction directly. You can use this field to drill into details and access the related actions menu." }, "company_cf195d74f9ec10000e604de5de8d0013": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The company on the purchase order. The company represents the buying organization of the purchase order." }, "status_4c2f0151c565100007df5a1621bc00a6": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The status of the purchase order. Possible values: In Progress, Approved, Issued, or Canceled." }, "shipToContact_cf195d74f9ec100013c9bbc8e2d6004a": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The bill-to contact information for the purchase order." }, "creditCard_cf195d74f9ec100013504c3235bf003c": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The procurement credit card specified on the purchase order." }, "taxOption_6e77418f30e110000f5b188d6a340040": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The default tax option for the purchase order." }, "issueOption_cf195d74f9ec100013504be8d90b0036": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The issue option for the purchase order." }, "purchaseOrderDetail_cf195d74f9ec10000e604d7d51c6000f": { "allOf": [ { "type": "object", "properties": { "shippingTerms": { "$ref": "#/definitions/shippingTerms_cf195d74f9ec100013504c247744003b" }, "billToContact": { "$ref": "#/definitions/billToContact_cf195d74f9ec100013c9bbe838e2004c" }, "dueDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The due date for the purchase order.", "x-workday-type": "Date" }, "goodsLines": { "type": "array", "description": "The complete list of purchase order (PO) lines for goods on the PO. This field contains the details of goods ordered with the issued purchase order.", "items": { "$ref": "#/definitions/goodsLines_fdb911db39df10000bc72b4d29d50064" }, "x-workday-type": "Multi-instance" }, "memo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The memo on the purchase order. This field contains internal notes or reference text.", "x-workday-type": "Text" }, "paymentType": { "$ref": "#/definitions/paymentType_cf195d74f9ec100013504c3d615f003d" }, "submittedBy": { "$ref": "#/definitions/submittedBy_d35e83e8978810000961a7d787380104" }, "projectBasedServiceLines": { "type": "array", "description": "The project-based order lines for the purchase order.", "items": { "$ref": "#/definitions/projectBasedServiceLines_fdb911db39df100014c6c578722c0072" }, "x-workday-type": "Multi-instance" }, "shippingMethod": { "$ref": "#/definitions/shippingMethod_6e77418f30e110000a4a476d666d003e" }, "taxCodes": { "type": "array", "description": "The tax codes from the lines for the purchase order.", "items": { "$ref": "#/definitions/taxCodes_fdb911db39df10000d27c7d51697006f" }, "x-workday-type": "Multi-instance" }, "supplierContract": { "$ref": "#/definitions/supplierContract_cf195d74f9ec100013504c0e9a770039" }, "taxAmount": { "type": "object", "description": "The total tax amount for the document.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "currency": { "$ref": "#/definitions/currency_cf195d74f9ec100012b6c252dc4f0032" }, "orderFromConnection": { "$ref": "#/definitions/orderFromConnection_cf195d74f9ec100012b6c26427a90033" }, "otherCharges": { "type": "object", "description": "The total amount of other charges that are applicable to the taxable document.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "shipToAddress": { "$ref": "#/definitions/shipToAddress_cf195d74f9ec10000e604db33c4d0010" }, "supplier": { "$ref": "#/definitions/supplier_cf195d74f9ec1000125aaedc04020029" }, "billToContactDetail": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The bill-to contact information for the purchase order.", "x-workday-type": "Text" }, "internalMemo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The internal memo on a document. This type of memo is viewable by only internal workers of your company, and not any outside party.", "x-workday-type": "Text" }, "buyer": { "$ref": "#/definitions/buyer_cf195d74f9ec100013504bd6dd390035" }, "shippingInstructions": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The shipping instructions on the purchase order.", "x-workday-type": "Text" }, "paymentTerms": { "$ref": "#/definitions/paymentTerms_cf195d74f9ec100012b6c1ee4166002b" }, "documentDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The date of the purchase order. Users can manually update this value on the purchase order during creation.", "x-workday-type": "Date" }, "company": { "$ref": "#/definitions/company_cf195d74f9ec10000e604de5de8d0013" }, "lineTotalAmount": { "type": "object", "description": "The total extended amount for all purchase order lines.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "freightAmount": { "type": "object", "description": "The total amount of freight charges that are applicable for the taxable document.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "excludeFromMassClose": { "type": "boolean", "example": true, "description": "If true, indicates that the purchase order is manually excluded from mass close operations.", "x-workday-type": "Boolean" }, "serviceLines": { "type": "array", "description": "The complete list of lines for services on the purchase order.", "items": { "$ref": "#/definitions/serviceLines_fdb911db39df10000bef1fb190c70067" }, "x-workday-type": "Multi-instance" }, "status": { "$ref": "#/definitions/status_4c2f0151c565100007df5a1621bc00a6" }, "shipToContactDetail": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The ship-to contact for the purchase order. This field contains the contact information for questions on orders, such as expected shipment date.", "x-workday-type": "Text" }, "shipToContact": { "$ref": "#/definitions/shipToContact_cf195d74f9ec100013c9bbc8e2d6004a" }, "billToAddress": { "type": "array", "description": "The billing address for the purchase order.", "items": { "$ref": "#/definitions/billToAddress_cf195d74f9ec10000e604dce73960011" }, "x-workday-type": "Multi-instance" }, "creditCard": { "$ref": "#/definitions/creditCard_cf195d74f9ec100013504c3235bf003c" }, "taxOption": { "$ref": "#/definitions/taxOption_6e77418f30e110000f5b188d6a340040" }, "issueOption": { "$ref": "#/definitions/issueOption_cf195d74f9ec100013504be8d90b0036" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "issueOption_4c2f0151c56510000819cebed20a00af": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The purchase order issue option for the purchase order." }, "status_4c2f0151c56510000819ceb6285400ae": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The status for the purchase order." }, "currency_4c2f0151c56510000819ce8653d600a9": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The currency of the purchase order." }, "submittedBy_d35e83e8978810000991c7400cf00109": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The worker who submitted the purchase order." }, "orderFromConnection_ecd9fc23607110000ade921661f8014a": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The bill-to contact for the purchase order." }, "company_4c2f0151c56510000819cec7a02c00b0": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The bill-to company for the purchase order." }, "supplier_4c2f0151c56510000819cea2142a00ac": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The supplier for the purchase order." }, "buyer_4c2f0151c56510000819cead373300ad": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The sourcing buyer for the purchase order." }, "purchaseOrderSummary_4c2f0151c56510000819ce72b3d500a8": { "allOf": [ { "type": "object", "properties": { "issueOption": { "$ref": "#/definitions/issueOption_4c2f0151c56510000819cebed20a00af" }, "totalAmount": { "type": "object", "description": "The total extended amount of all purchase order lines for the purchase order.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "status": { "$ref": "#/definitions/status_4c2f0151c56510000819ceb6285400ae" }, "currency": { "$ref": "#/definitions/currency_4c2f0151c56510000819ce8653d600a9" }, "submittedBy": { "$ref": "#/definitions/submittedBy_d35e83e8978810000991c7400cf00109" }, "orderFromConnection": { "$ref": "#/definitions/orderFromConnection_ecd9fc23607110000ade921661f8014a" }, "company": { "$ref": "#/definitions/company_4c2f0151c56510000819cec7a02c00b0" }, "documentDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The date of the purchase order.", "x-workday-type": "Date" }, "supplier": { "$ref": "#/definitions/supplier_4c2f0151c56510000819cea2142a00ac" }, "buyer": { "$ref": "#/definitions/buyer_4c2f0151c56510000819cead373300ad" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "WorkdayReferenceId_requisitionTemplates": { "type": "string", "pattern": "^(Requisition_Template_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Requisition_Template_ID", "example": "Requisition_Template_ID=21002" }, "ResourceIdPathValue_requisitionTemplates": {}, "owner_0dcf47d882d910001957ebf72a660165": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The worker who created the requisition template. The creator is the only user that can edit the template." }, "currency_0dcf47d882d910001957ec400b0f0166": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The currency on the requisition template. The template automatically uses the default currency of the Created by Worker. You might need to update the unit cost or amount on the requisition if the template currency differs from the requisition currency." }, "requisitionTemplateDetail_8d1b9d13e05110002261c46350e40000": { "allOf": [ { "type": "object", "properties": { "owner": { "$ref": "#/definitions/owner_0dcf47d882d910001957ebf72a660165" }, "types": { "type": "array", "description": "The Requisition Types on the requisition template header.", "items": { "$ref": "#/definitions/types_25b4f9a028ac10001abc23b03e840000" }, "x-workday-type": "Multi-instance" }, "locations": { "type": "array", "description": "The Deliver-To locations on the requisition template header.", "items": { "$ref": "#/definitions/locations_25b4f9a028ac10001abc23b03e840001" }, "x-workday-type": "Multi-instance" }, "companies": { "type": "array", "description": "The companies and company hierarchies on the requisition template.", "items": { "$ref": "#/definitions/companies_8d1b9d13e05110001741f1e0a87d0000" }, "x-workday-type": "Multi-instance" }, "serviceLines": { "type": "array", "description": "All service lines on the requisition template.", "items": { "$ref": "#/definitions/serviceLines_1f42830d725f100006616b02cdbb0026" }, "x-workday-type": "Multi-instance" }, "createdOnDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The document date of the requisition template.", "x-workday-type": "Date" }, "currency": { "$ref": "#/definitions/currency_0dcf47d882d910001957ec400b0f0166" }, "name": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The name of the requisition template.", "x-workday-type": "Text" }, "worktags": { "type": "array", "description": "Returns the worktags for the document header.", "items": { "$ref": "#/definitions/worktags_6167bf5da15e1000186498034cba0000" }, "x-workday-type": "Multi-instance" }, "goodsLines": { "type": "array", "description": "All goods lines on the requisition template.", "items": { "$ref": "#/definitions/goodsLines_1f42830d725f100006616b1943270027" }, "x-workday-type": "Multi-instance" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "currency_1f42830d725f100005d3f90160490017": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The currency on the requisition template. The template automatically uses the default currency of the Created by Worker. You might need to update the unit cost or amount on the requisition if the template currency differs from the requisition currency." }, "owner_1f42830d725f100005d3f90e82e30018": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The worker who created the requisition template. The creator is the only user that can edit the template." }, "requisitionTemplateSummary_8d1b9d13e0511000210515a1bdba0000": { "allOf": [ { "type": "object", "properties": { "createdOnDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The document date of the requisition template.", "x-workday-type": "Date" }, "currency": { "$ref": "#/definitions/currency_1f42830d725f100005d3f90160490017" }, "owner": { "$ref": "#/definitions/owner_1f42830d725f100005d3f90e82e30018" }, "types": { "type": "array", "description": "The Requisition Types on the requisition template header.", "items": { "$ref": "#/definitions/types_25b4f9a028ac10001a55323bfe440000" }, "x-workday-type": "Multi-instance" }, "locations": { "type": "array", "description": "The Deliver-To locations on the requisition template header.", "items": { "$ref": "#/definitions/locations_25b4f9a028ac10001a55336fed1a0000" }, "x-workday-type": "Multi-instance" }, "companies": { "type": "array", "description": "The companies and company hierarchies on the requisition template.", "items": { "$ref": "#/definitions/companies_8d1b9d13e051100020a18307c29c0000" }, "x-workday-type": "Multi-instance" }, "name": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The name of the requisition template.", "x-workday-type": "Text" }, "lineCount": { "type": "integer", "example": "99999999999", "description": "The number of lines on the requisition template.", "x-workday-type": "Numeric" }, "worktags": { "type": "array", "description": "Returns the worktags for the document header.", "items": { "$ref": "#/definitions/worktags_6167bf5da15e100018d3d2a261f30000" }, "x-workday-type": "Multi-instance" }, "ownedByCurrentUser": { "type": "boolean", "example": true, "description": "True when the processing worker also owns the requisition template. Workers can create either shared or private templates.", "x-workday-type": "Boolean" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "WorkdayReferenceId_requisitions": { "type": "string", "pattern": "^(Requisition_Number|Requisition_ID_External|Requisition_Reference_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Requisition_Number, Requisition_ID_External, Requisition_Reference_ID", "example": "Requisition_Number=21002" }, "ResourceIdPathValue_requisitions": {}, "company_4b60be2b856c1000091ce668ad65310f": { "allOf": [ { "$ref": "#/definitions/companyReferenceSummary_1659877d377c100004bb760250f60021" }, {} ], "description": "The company for the requisition." }, "requester_4b60be2b856c1000091ce4c4d7bc310e": { "allOf": [ { "$ref": "#/definitions/workerSummary_51eee0e1cc8a1000119edd0c72164dd4" }, {} ], "description": "The worker that the items on the requisition were requested for. When workers submit requisitions on behalf of other workers, this value differs from the submitter." }, "currency_4b60be2b856c1000091cdfec85d3310c": { "allOf": [ { "$ref": "#/definitions/currencyReferenceSummary_cb124c4f53f0100013e8c4ae81de000e" }, {} ], "description": "The currency of the requisition. The currency of the requisition is based on the company default currency, unless the requester manually updated the currency." }, "reasonCode_4ddad5dc6a0a100012916c4bdfb14d4e": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The reason code for a canceled or closed requisition." }, "deliverToLocation_d5bc8669fe1710000bbe488124d70186": { "allOf": [ { "$ref": "#/definitions/locationReferenceSummary_1659877d377c100004d9240d45210025" }, {} ], "description": "The deliver-to location on the header of the requisition. The deliver-to location may represent a par location, an inventory site or stocking location for replenishment-type requisitions. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area.", "x-conditionally-required": true, "x-conditionally-hidden": true }, "parLocation_1fe25e2f325d10008f7ac24e01b70000": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Par Location" }, "inventorySite_1fe25e2f325d10008f7ac24e01b70001": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Requesting Inventory Site" }, "requisitionType_7953fdceab891000135e96d6b2070000": { "allOf": [ { "$ref": "#/definitions/metadata_1fe25e2f325d100082cb42c714e00000" }, {} ], "description": "The type of requisition, displayed on the header of the requisition. Example requisition types include consignment-type order or replenishment-type order for inventory. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area." }, "requestingEntity_858a3abfd4e7100008e7ce57b81d0a90": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The Requesting Entity for the requisition. Use this field to determine which requesting entity a requisition was submitted for.", "x-conditionally-required": true, "x-conditionally-hidden": true }, "sourcingBuyer_4bb4ea14b34d10000ce918c021b119cc": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The buyer responsible for sourcing the requisition. The values for the sourcing buyer depends on security permissions, sourcing rules, and manual entry on tasks.", "x-conditionally-required": true, "x-conditionally-hidden": true }, "status_73e0b4b1cb1e100005cde3246ad50043": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The status of the requisition. Possible values: Completed, In Progress, Canceled, Draft, Denied, or Closed." }, "shippingAddress_1424ef73f85610000c684c31ac2c006d": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The ship-to address on the header of the requisition. This value also populates on the requisition lines but can be changed." }, "submitter_211b955774b410000ea060ddeef1000c": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The worker who submitted the requisition. When workers submit requisitions on behalf of other workers, this value differs from the requester." }, "externalSystemId_e4f63cac49ed100026c091022f081e8e": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The External System ID for the requisition." }, "requisitionSummary_4b60be2b856c1000091cded56022310a": { "allOf": [ { "type": "object", "properties": { "requisitionDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The date when the items of the requisition were requested.", "x-workday-type": "Date" }, "procedureDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The procedure date that a particular requisition is being created to accommodate.", "x-workday-type": "Date" }, "criticalCustomValidations": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "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.", "x-workday-type": "Text", "x-workday-confidence-level": "Preview" }, "company": { "$ref": "#/definitions/company_4b60be2b856c1000091ce668ad65310f" }, "warningCustomValidations": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "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.", "x-workday-type": "Text", "x-workday-confidence-level": "Preview" }, "supplierRepresentative": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The supplier representative that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "requester": { "$ref": "#/definitions/requester_4b60be2b856c1000091ce4c4d7bc310e" }, "currency": { "$ref": "#/definitions/currency_4b60be2b856c1000091cdfec85d3310c" }, "additionalInformation": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The additional procedure details that a particular requisition is being created to accommodate.", "x-workday-type": "Rich Text" }, "amount": { "type": "object", "description": "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.", "properties": { "value": { "type": "string", "example": "99999999999.999", "description": "The amount, represented as a decimal string with up to 15 integer digit(s) and up to 3 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,15}(\\.\\d{1,3})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "verifiedBy": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The procedure verified by that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "reasonCode": { "$ref": "#/definitions/reasonCode_4ddad5dc6a0a100012916c4bdfb14d4e" }, "deliverToLocation": { "$ref": "#/definitions/deliverToLocation_d5bc8669fe1710000bbe488124d70186" }, "comments": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Comments for canceling or closing a requisition.", "x-workday-type": "Text" }, "medicalRecordNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The medical record number that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "parLocation": { "$ref": "#/definitions/parLocation_1fe25e2f325d10008f7ac24e01b70000" }, "inventorySite": { "$ref": "#/definitions/inventorySite_1fe25e2f325d10008f7ac24e01b70001" }, "formattedOtherCharges": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "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.", "x-workday-type": "Text" }, "formattedFreight": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "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.", "x-workday-type": "Text" }, "formattedSubtotal": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "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.", "x-workday-type": "Text" }, "physicianId": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The physician id that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "procedureNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The procedure number that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "patientId": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The patient id that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "formattedAmount": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "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.", "x-workday-type": "Text" }, "requisitionType": { "$ref": "#/definitions/requisitionType_7953fdceab891000135e96d6b2070000" }, "procedure": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The procedure that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "highPriority": { "type": "boolean", "example": true, "description": "Returns true if the \"High Priority\" checkbox was checked on the Requisition.", "x-workday-type": "Boolean", "x-conditionally-required": true, "x-conditionally-hidden": true }, "purchaseOrders": { "type": "array", "description": "The purchase order issued to fulfill this requisition.", "items": { "$ref": "#/definitions/purchaseOrders_9f1cd7abc4cd10001629cc4b51b90009" }, "x-workday-type": "Multi-instance" }, "requestingEntity": { "$ref": "#/definitions/requestingEntity_858a3abfd4e7100008e7ce57b81d0a90" }, "internalMemo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The internal memo on a document. This type of memo is viewable by only internal \\~workers\\~ of your company, and not any outside party.", "x-workday-type": "Text", "x-conditionally-required": true, "x-conditionally-hidden": true }, "freightAmount": { "type": "object", "description": "The total amount of freight charges that are applicable for the taxable document.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency", "x-conditionally-required": true, "x-conditionally-hidden": true }, "sourcingBuyer": { "$ref": "#/definitions/sourcingBuyer_4bb4ea14b34d10000ce918c021b119cc" }, "requisitionLines": { "type": "array", "description": "The requisition lines on the requisition. These lines may not be returned in the same order.", "items": { "$ref": "#/definitions/requisitionLines_a4a5fe393db110000addf2aa5dc90029" }, "x-workday-type": "Multi-instance" }, "memo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The transaction memo for the reporting transaction.", "x-workday-type": "Text", "x-conditionally-required": true, "x-conditionally-hidden": true }, "otherCharges": { "type": "object", "description": "The total amount of other charges that are applicable for the taxable document.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency", "x-conditionally-required": true, "x-conditionally-hidden": true }, "formattedShippingAddress": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The shipping address for the requisition as a single string. Each line of the shipping address is delimited by HTML encoded line feed character.", "x-workday-type": "Text" }, "deliverToLocationChain": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "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.", "x-workday-type": "Text" }, "worktags": { "type": "array", "description": "All of the worktags for the requisition that are used for defaulting when the requisition lines are added to the requisition. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area.", "items": { "$ref": "#/definitions/worktags_801199b6f414100008f45effa3af0d7b" }, "x-workday-type": "Multi-instance", "x-conditionally-required": true, "x-conditionally-hidden": true }, "status": { "$ref": "#/definitions/status_73e0b4b1cb1e100005cde3246ad50043" }, "supplierSalesOrderNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The supplier sales order number that a particular requisition is being created to accommodate.", "maxLength": 80, "x-workday-type": "Text" }, "shippingAddress": { "$ref": "#/definitions/shippingAddress_1424ef73f85610000c684c31ac2c006d" }, "submitter": { "$ref": "#/definitions/submitter_211b955774b410000ea060ddeef1000c" }, "externalSystemId": { "$ref": "#/definitions/externalSystemId_e4f63cac49ed100026c091022f081e8e" }, "externalSourceableId": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The External Sourceable ID for the requisition.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "externalSystemId_50e493fe797b100014f0e574d88b4b74": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The External System ID for the requisition." }, "sourcingBuyer_8e198fd5c45010000bd8dd8a30b80012": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The buyer responsible for sourcing the requisition." }, "company_8e198fd5c45010000bd8dd9d99440014": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The company for the requisition." }, "requestingEntity_8a4e1935cc71100010886fa78c2b4afa": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Requesting Entity" }, "requisitionType_8e198fd5c45010000bd8dd93c09d0013": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The type of requisition. Examples of such requisition types include consignment and inventory replenishment. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area." }, "requester_7b5e81579f911000211bbd3e405300d2": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The worker that the items on the requisition were requested for. When workers submit requisitions on behalf of other workers, this value differs from the submitter." }, "currency_8e198fd5c45010000bd8dd79e4c90011": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The currency of the requisition. The currency of the requisition is based on the company default currency, unless the requester manually updated the currency." }, "createRequisitionRepresentation_7b5e81579f91100020cd39bdc84800c3": { "allOf": [ { "type": "object", "properties": { "externalSourceableId": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The External Sourceable ID for the requisition.", "x-workday-type": "Text" }, "requisitionLines": { "type": "array", "description": "The requisition lines on the requisition. These lines may not be returned in the same order.", "items": { "$ref": "#/definitions/requisitionLines_3500b3bcf67710000ec797f68acd006c" }, "x-workday-type": "Multi-instance" }, "otherCharges": { "type": "object", "description": "The total amount of other charges that are applicable for the requisition.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "freightAmount": { "type": "object", "description": "The total amount of freight charges that are applicable for the requisition.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "externalSystemId": { "$ref": "#/definitions/externalSystemId_50e493fe797b100014f0e574d88b4b74" }, "sourcingBuyer": { "$ref": "#/definitions/sourcingBuyer_8e198fd5c45010000bd8dd8a30b80012" }, "criticalCustomValidations": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "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.", "x-workday-type": "Text", "x-workday-confidence-level": "Preview" }, "warningCustomValidations": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "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.", "x-workday-type": "Text", "x-workday-confidence-level": "Preview" }, "medicalRecordNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The medical record number that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "additionalInformation": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The additional procedure details that a particular requisition is being created to accommodate.", "x-workday-type": "Rich Text" }, "supplierRepresentative": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The supplier representative that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "procedure": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The procedure that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "internalMemo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The internal memo on the requisition.", "x-workday-type": "Text" }, "verifiedBy": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The procedure verified by that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "physicianId": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The physician id that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "highPriority": { "type": "boolean", "example": true, "description": "If true, the requisition is high priority.", "x-workday-type": "Boolean" }, "patientId": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The patient id that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "procedureDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The procedure date that a particular requisition is being created to accommodate.", "x-workday-type": "Date" }, "procedureNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The procedure number that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "company": { "$ref": "#/definitions/company_8e198fd5c45010000bd8dd9d99440014" }, "requestingEntity": { "$ref": "#/definitions/requestingEntity_8a4e1935cc71100010886fa78c2b4afa" }, "requisitionType": { "$ref": "#/definitions/requisitionType_8e198fd5c45010000bd8dd93c09d0013" }, "requester": { "$ref": "#/definitions/requester_7b5e81579f911000211bbd3e405300d2" }, "memo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The public memo for the requisition.", "x-workday-type": "Text" }, "currency": { "$ref": "#/definitions/currency_8e198fd5c45010000bd8dd79e4c90011" }, "supplierSalesOrderNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The supplier sales order number that a particular requisition is being created to accommodate.", "maxLength": 80, "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "sourcingBuyer_3fafcba98b15100010c8219e0a9b125b": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The buyer responsible for sourcing the requisition." }, "externalSystemId_e4f63cac49ed100014997e9b7f921295": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The External System ID for the requisition." }, "requisitionType_3fafcba98b15100010c821ae318a125c": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The type of requisition. Examples of such requisition types include consignment and inventory replenishment. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area." }, "requester_7d40fc9ba816100007030eefd8900240": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The worker that the items on the requisition were requested for. When workers submit requisitions on behalf of other workers, this value differs from the submitter." }, "shippingAddress_7d40fc9ba816100007f9f83585f90291": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The ship-to address on the header of the requisition. This value also populates on the requisition lines but can be changed." }, "currency_21a06722e5c1100018e0d663d4e71460": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The currency of the requisition. The currency of the requisition is based on the company default currency, unless the requester manually updated the currency." }, "company_7d40fc9ba816100005435ebb752e01a4": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The company for the requisition." }, "deliverToLocation_7d40fc9ba81610000783356ef48f028e": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The deliver-to location on the header of the requisition. The deliver-to location may represent a par location, an inventory site or stocking location for replenishment-type requisitions. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area." }, "editRequisitionRepresentation_3fafcba98b15100010029c8fb24a1255": { "allOf": [ { "type": "object", "properties": { "criticalCustomValidations": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "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.", "x-workday-type": "Text", "x-workday-confidence-level": "Preview" }, "otherCharges": { "type": "object", "description": "The total amount of other charges that are applicable for the requisition.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "sourcingBuyer": { "$ref": "#/definitions/sourcingBuyer_3fafcba98b15100010c8219e0a9b125b" }, "externalSourceableId": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The External Sourceable ID for the requisition.", "x-workday-type": "Text" }, "externalSystemId": { "$ref": "#/definitions/externalSystemId_e4f63cac49ed100014997e9b7f921295" }, "internalMemo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The internal memo on the requisition.", "x-workday-type": "Text" }, "memo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The public memo for the requisition.", "x-workday-type": "Text" }, "freightAmount": { "type": "object", "description": "The total amount of freight charges that are applicable for the requisition.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "highPriority": { "type": "boolean", "example": true, "description": "If true, the requisition is high priority.", "x-workday-type": "Boolean" }, "physicianId": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The physician id that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "requisitionType": { "$ref": "#/definitions/requisitionType_3fafcba98b15100010c821ae318a125c" }, "procedure": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The procedure that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "patientId": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The patient id that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "warningCustomValidations": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "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.", "x-workday-type": "Text", "x-workday-confidence-level": "Preview" }, "supplierRepresentative": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The supplier representative that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "procedureNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The procedure number that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "requisitionLines": { "type": "array", "description": "The requisition lines on the requisition. These lines may not be returned in the same order.", "items": { "$ref": "#/definitions/requisitionLines_51435ed0dc1110001a81735dc9be0282" }, "x-workday-type": "Multi-instance" }, "verifiedBy": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The procedure verified by that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "medicalRecordNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The medical record number that a particular requisition is being created to accommodate.", "x-workday-type": "Text" }, "procedureDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The procedure date that a particular requisition is being created to accommodate.", "x-workday-type": "Date" }, "additionalInformation": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The additional procedure details that a particular requisition is being created to accommodate.", "x-workday-type": "Rich Text" }, "requester": { "$ref": "#/definitions/requester_7d40fc9ba816100007030eefd8900240" }, "worktags": { "type": "array", "description": "All of the worktags for the requisition that are used for defaulting when the requisition lines are added to the requisition. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area.", "items": { "$ref": "#/definitions/worktags_9f8a91a361e71000104edd32b88519dd" }, "x-workday-type": "Multi-instance" }, "shippingAddress": { "$ref": "#/definitions/shippingAddress_7d40fc9ba816100007f9f83585f90291" }, "currency": { "$ref": "#/definitions/currency_21a06722e5c1100018e0d663d4e71460" }, "company": { "$ref": "#/definitions/company_7d40fc9ba816100005435ebb752e01a4" }, "deliverToLocation": { "$ref": "#/definitions/deliverToLocation_7d40fc9ba81610000783356ef48f028e" }, "supplierSalesOrderNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The supplier sales order number that a particular requisition is being created to accommodate.", "maxLength": 80, "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "WorkdayReferenceId_attachments": { "type": "string", "pattern": "^(File_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: File_ID", "example": "File_ID=21002" }, "ResourceIdPathValue_attachments": {}, "attachmentCategory_fe358601de1910001ff5f5d016330000": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The attachment category for the attachment. You can find a list of attachment categories through the Get Spend Attachment Categories SOAP web service or the Maintain Spend Attachment Categories task." }, "businessDocumenAttachmentRepresentationEdit_fb7b966900c210000b9c29aa7eff00d6": { "allOf": [ { "type": "object", "properties": { "attachmentCategory": { "$ref": "#/definitions/attachmentCategory_fe358601de1910001ff5f5d016330000" }, "comment": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The comment for the attachment.", "x-workday-type": "Text" }, "external": { "type": "boolean", "example": true, "description": "If true, an external supplier can view the attachment on the purchase order once the purchase order has been issued.", "x-workday-type": "Boolean" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "attachmentCategory_febfc5accac8100023aef8d27d1e0000": { "allOf": [ { "$ref": "#/definitions/attachmentCategoryReferenceSummary_f38a185fa6b410000c241261e4b00000" }, {} ], "description": "The attachment category for the attachment." }, "contentType_65042b73eb4010000a789d7db18200af": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The content type of the attachment. Example: image/jpeg - mime_image" }, "businessDocumenAttachmentRepresentationView_aff036e6348f1000136753063d7500a1": { "allOf": [ { "type": "object", "properties": { "attachmentCategory": { "$ref": "#/definitions/attachmentCategory_febfc5accac8100023aef8d27d1e0000" }, "fileLength": { "type": "integer", "example": "99999999999", "description": "The length of the attachment.", "x-workday-type": "Numeric" }, "fileName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The file name of the attachment.", "maxLength": 255, "x-workday-type": "Text" }, "comment": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The comment for the attachment.", "x-workday-type": "Text" }, "external": { "type": "boolean", "example": true, "description": "If true, an external supplier can view the attachment on the purchase order once the purchase order has been issued.", "x-workday-type": "Boolean" }, "contentType": { "$ref": "#/definitions/contentType_65042b73eb4010000a789d7db18200af" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "submitFinancialEventRepresentation_0e057f97262f10000d031ac5c3330000": { "allOf": [ { "type": "object", "properties": { "autoComplete": { "type": "boolean", "example": true, "description": "Yes if the event autocompleted from a web service or by selecting the Enable Autocomplete check box on the business process definition.", "x-workday-type": "Boolean" }, "comment": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Returns the comment for the last event record done by the processing person, without security filtering. If no comment was entered, the result will be empty. This CRF is for Integration use only.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "reasonCode_cb89da27c55a100013b98f254c6c14c8": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The reason code for canceling a requisition." }, "cancelRequisitionRepresentation_b8474d2ad32110001ab4918eb9b80087": { "allOf": [ { "type": "object", "properties": { "comments": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Comments for canceling a requisition.", "x-workday-type": "Text" }, "reasonCode": { "$ref": "#/definitions/reasonCode_cb89da27c55a100013b98f254c6c14c8" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "reasonCode_6c39965e8af9100013d2cfe3026b4ea6": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The reason code indicated during closing or canceling a requisition." }, "closeRequisitionRepresentation_7a5a9e9d07dc100007da452c6b3216bc": { "allOf": [ { "type": "object", "properties": { "reasonCode": { "$ref": "#/definitions/reasonCode_6c39965e8af9100013d2cfe3026b4ea6" }, "comments": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The comments provided when closing or canceling a requisition.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "WorkdayReferenceId_requisitionLines": { "type": "string", "pattern": "^(Requisition_Line_ID)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Requisition_Line_ID", "example": "Requisition_Line_ID=21002" }, "ResourceIdPathValue_requisitionLines": {}, "shipToAddress_5db5e3f7dcd5100016165dd8424b00cd": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The ship-to address for the requisition line. If line ship-to address is empty, the ship-to address in the requisition header is returned. \n\nMigration Note: For v3 and later, the shipToAddress field contains the actual ship to address. The shipToAddressReference field contains the shipToAddress information provided with v1 and v2." }, "supplier_08abdc29646510000d7a31eab90b00e9": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The resource provider for the requisition line. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area." }, "shipToAddressReference_5db5e3f7dcd5100016165dac30c500cc": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The address reference related to the ship-to address of the requisition line. \n\nMigration Note: The shipToAddressReference field contains the shipToAddress information provided with v1 and v2. For v3 and later, the shipToAddress field contains the actual ship to address." }, "lineCompany_76412a376b31100016c92fca2693170f": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The company for the requisition line." }, "lotSerialInformation_534926b8b63f1000070c9e474f6d045c": { "allOf": [ { "$ref": "#/definitions/createLotSerialInformationRepresentation_5e69f73e461f10000b0710411362049d" }, {} ], "description": "The lot serial information for the requisition line." }, "unitOfMeasure_85fe2adb40611000128e4add74750192": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The unit of measure for the requisition line." }, "shipToContact_85fe2adb40611000128e4b06606f019b": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The ship-to contact worker for the requisition line." }, "spendCategory_85fe2adb40611000128e4ae275de0193": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The spend category for the requisition line. This is represented as a worktag object." }, "commodityCode_bccd7e4e61361000194bc450c3680000": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The code that identifies the type of goods or service. You can use this field to drill into the commodity code details such as description, level name, or associated spend categories." }, "item_85fe2adb40611000128e4ace5f19018f": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The item for the requisition line." }, "orderFromConnection_2e9327fce65e10001fb9906dc5780d21": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "Order-from supplier connection to use when sourcing this requisition line. Must be valid for supplier." }, "deliverToLocation_85fe2adb40611000128e4aefdc0c0196": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The deliver-to location on the header of the requisition. The deliver-to location may represent a par location, an inventory site or stocking location for replenishment-type requisitions.\n\nVersioning Note: As of v3, this field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area." }, "supplierContract_85fe2adb40611000128e4afdba410199": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The supplier contract for the requisition line.\n\nVersioning Note: As of v3, this field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area." }, "addRequisitionLineRepresentation_85fe2adb40611000128e4ab1c92d018a": { "allOf": [ { "type": "object", "properties": { "criticalCustomValidations": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "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.", "x-workday-type": "Text", "x-workday-confidence-level": "Preview" }, "shipToAddress": { "$ref": "#/definitions/shipToAddress_5db5e3f7dcd5100016165dd8424b00cd" }, "supplier": { "$ref": "#/definitions/supplier_08abdc29646510000d7a31eab90b00e9" }, "warningCustomValidations": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "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.", "x-workday-type": "Text", "x-workday-confidence-level": "Preview" }, "shipToAddressReference": { "$ref": "#/definitions/shipToAddressReference_5db5e3f7dcd5100016165dac30c500cc" }, "itemRanking": { "type": "number", "example": 99999999999.99, "description": "itemRanking", "x-workday-type": "Numeric" }, "writeInGoods": { "type": "boolean", "example": true, "description": "If true, the requisition line is a goods line with no purchase item, supplier item, or catalog item.", "x-workday-type": "Boolean" }, "itemDescription": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The line item description for the requisition line.", "x-workday-type": "Text" }, "writeInService": { "type": "boolean", "example": true, "description": "If true, the requisition line is a service line with no purchase item, supplier item, or catalog item.", "x-workday-type": "Boolean" }, "lineCompany": { "$ref": "#/definitions/lineCompany_76412a376b31100016c92fca2693170f" }, "lotSerialInformation": { "$ref": "#/definitions/lotSerialInformation_534926b8b63f1000070c9e474f6d045c" }, "searchTerm": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "Search term used to query through Search Catalog for current item on this requisition line.", "x-workday-type": "Text" }, "unitOfMeasure": { "$ref": "#/definitions/unitOfMeasure_85fe2adb40611000128e4add74750192" }, "rfqRequired": { "type": "boolean", "example": true, "description": "If true, a request for quote is required for the requisition line.", "x-workday-type": "Boolean" }, "noCharge": { "type": "boolean", "example": true, "description": "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.", "x-workday-type": "Boolean" }, "requestedDeliveryDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "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.\n\nVersioning Note: As of v3, this field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area.", "x-workday-type": "Date" }, "shipToContact": { "$ref": "#/definitions/shipToContact_85fe2adb40611000128e4b06606f019b" }, "unitCost": { "type": "object", "description": "The unit cost for the requisition line.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "spendCategory": { "$ref": "#/definitions/spendCategory_85fe2adb40611000128e4ae275de0193" }, "commodityCode": { "$ref": "#/definitions/commodityCode_bccd7e4e61361000194bc450c3680000" }, "endDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The end date requested for the service on the requisition line.", "x-workday-type": "Date" }, "worktags": { "type": "array", "description": "The worktags for the requisition line.", "items": { "$ref": "#/definitions/worktags_85fe2adb40611000128e4ac34f22018d" }, "x-workday-type": "Multi-instance" }, "item": { "$ref": "#/definitions/item_85fe2adb40611000128e4ace5f19018f" }, "supplierItemIdentifier": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The alphanumeric identifier assigned by a supplier to an item. This can be different from the manufacturer identification number.", "x-workday-type": "Text" }, "orderFromConnection": { "$ref": "#/definitions/orderFromConnection_2e9327fce65e10001fb9906dc5780d21" }, "deliverToLocation": { "$ref": "#/definitions/deliverToLocation_85fe2adb40611000128e4aefdc0c0196" }, "startDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The start date requested for the service on the requisition line.", "x-workday-type": "Date" }, "quantity": { "type": "number", "example": 99999999999.99, "description": "The quantity on the requisition line. This value can have 20 integer places, is precise to 2 decimal places, and cannot be negative.", "x-workday-type": "Numeric" }, "extendedAmount": { "type": "object", "description": "The extended amount for the document line. Excludes Extended Amounts on Tax Only Invoices.", "properties": { "value": { "type": "string", "example": "99999999999.999", "description": "The amount, represented as a decimal string with up to 15 integer digit(s) and up to 3 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,15}(\\.\\d{1,3})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "supplierContract": { "$ref": "#/definitions/supplierContract_85fe2adb40611000128e4afdba410199" }, "memo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The public memo for the requisition line.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "WorkdayReferenceId_relatedPurchaseOrders": { "type": "string", "pattern": "^(Document_Number|Purchase_Order_Reference_ID|External_PO_Number)=\\S+$", "description": "Workday reference ID (Type=Value). Valid types: Document_Number, Purchase_Order_Reference_ID, External_PO_Number", "example": "Document_Number=21002" }, "ResourceIdPathValue_relatedPurchaseOrders": {}, "documentStatus_cb124c4f53f010001af61981359e001f": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The status for the purchase order." }, "relatedPurchaseOrderSummary_cb124c4f53f010001af6190a9802001d": { "allOf": [ { "type": "object", "properties": { "poNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The document number for the purchase order.", "x-workday-type": "Text" }, "documentStatus": { "$ref": "#/definitions/documentStatus_cb124c4f53f010001af61981359e001f" }, "poDocumentDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The date for the purchase order.", "x-workday-type": "Date" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "The id for Purchase Order" } } } ] }, "metadata_1fe25e2f325d100082ce7d2a4b150000": { "allOf": [ { "$ref": "#/definitions/metadata_1fe25e2f325d100082cb42c714e00000" }, {} ], "description": "Generic wrapper for tenanted data." }, "metadataWrapper_72e9dc2aa56c10000eb2cc578ec50000": { "allOf": [ { "type": "object", "properties": { "metadata": { "$ref": "#/definitions/metadata_1fe25e2f325d100082ce7d2a4b150000" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "requisitionTypes_72e9dc2aa56c10000e241e7846920000": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/metadataWrapper_72e9dc2aa56c10000eb2cc578ec50000" } } } }, "requisitionCompanies_0f17db65c95810001192551d2fce0000": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." }, "Company_Reference_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "companies_79938b33b430100016e942b7cee50000": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/requisitionCompanies_0f17db65c95810001192551d2fce0000" } } } }, "spendCategory_30cd9bbfbe261000216693aacc8c0000": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." }, "Spend_Category_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "spendCategory_30cd9bbfbe2610001dc6e7eb9a4a0000": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/spendCategory_30cd9bbfbe261000216693aacc8c0000" } } } }, "unitOfMeasure_d1b9eb68ca141000112ddd4c98670000": { "allOf": [ { "type": "object", "properties": { "unCefactCommonCode": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The UN CEFACT Common Code associated with the unit of measure. Units of measure can have both a UN CEFACT Common Code and EDI Code.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "unitOfMeasure_d1b9eb68ca14100010158ba233da0000": { "type": "object", "properties": { "total": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/unitOfMeasure_d1b9eb68ca141000112ddd4c98670000" } } } }, "worktagType_6b452996a9281000081fa45c5b950016": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The worktag type for the worktag." }, "worktagOutputSummary_4f941c252ef610001a8bf98a974f000e": { "allOf": [ { "type": "object", "properties": { "worktagType": { "$ref": "#/definitions/worktagType_6b452996a9281000081fa45c5b950016" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "The id for Worktag Representation (Derived)" } } } ] }, "location_6e77418f30e110001848cc170d50004a": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The location worktag for a purchase order line split." }, "worktags_6e77418f30e110001848cc2d320f004b": { "allOf": [ { "$ref": "#/definitions/worktagOutputSummary_4f941c252ef610001a8bf98a974f000e" }, { "properties": { "id": { "type": "string", "description": "The id for Accounting Worktag" } } } ] }, "purchaseOrderLineSplitSummary_cf195d74f9ec1000175cda6ac4b2008a": { "allOf": [ { "type": "object", "properties": { "quantity": { "type": "number", "example": 100000000000, "description": "The quantity for the purchase order line split.", "x-workday-type": "Numeric" }, "location": { "$ref": "#/definitions/location_6e77418f30e110001848cc170d50004a" }, "amount": { "type": "object", "description": "The amount on the purchase order transaction line split.", "properties": { "value": { "type": "string", "example": "99999999999.999", "description": "The amount, represented as a decimal string with up to 15 integer digit(s) and up to 3 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,15}(\\.\\d{1,3})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "memo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The memo for a purchase order line split.", "x-workday-type": "Text" }, "worktags": { "type": "array", "description": "The worktags for a purchase order line split.", "items": { "$ref": "#/definitions/worktags_6e77418f30e110001848cc2d320f004b" }, "x-workday-type": "Multi-instance" }, "percent": { "type": "number", "example": 999.999999, "description": "The percentage for a purchase order line split.", "x-workday-type": "Numeric" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Purchase Order Line Split" } } } ] }, "addressSummary_cf195d74f9ec10001224e99d9b0f0025": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Address" } } } ] }, "taxRecoverabilitySummary_cf195d74f9ec1000164002143624006b": { "allOf": [ { "type": "object", "properties": { "percentRecoverable": { "type": "number", "example": 999.999, "description": "The tax recoverable percentage for tax recoverability.", "x-workday-type": "Numeric" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Tax Recoverability" } } } ] }, "taxCodeSummary_cf195d74f9ec1000137c599764990041": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Tax Code" } } } ] }, "shipToContact_cf195d74f9ec1000172ada158cc40083": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The ship-to contact for the purchase order line." }, "deliverTo_cf195d74f9ec1000172ada055ffa0082": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The final location where the goods or services are delivered. Example: an employee work station or stock room." }, "splits_cf195d74f9ec1000172ad9a0f9b3007d": { "allOf": [ { "$ref": "#/definitions/purchaseOrderLineSplitSummary_cf195d74f9ec1000175cda6ac4b2008a" }, { "properties": { "id": { "type": "string", "description": "The id for Purchase Order Line Split" } } } ] }, "shipToAddress_cf195d74f9ec1000172ada267aea0084": { "allOf": [ { "$ref": "#/definitions/addressSummary_cf195d74f9ec10001224e99d9b0f0025" }, {} ], "description": "The shipping address for the purchase order line. If the line shipToAddress is empty, the header shipToAddress is returned." }, "location_cf195d74f9ec1000172ad9d215af007f": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The location of the purchase order line. The location can be a delivery location or a worker's workspace. Example: Suite 100, Cubicle 1001." }, "deliveryType_cf195d74f9ec1000172ada5a6a5f0087": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The delivery type for the item order line. This value can indicate special orders for inventory such as consignment or replenishment. Example: Inventory replenishment, or par replenishment." }, "spendCategory_cf195d74f9ec100016cbdadf81ff007a": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The spend category defined on the purchase order line." }, "taxApplicability_cf195d74f9ec100016cbdac79ee10078": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The tax applicability of the taxable purchase order line." }, "taxRecoverability_cf195d74f9ec100016cbda9d126c0075": { "allOf": [ { "$ref": "#/definitions/taxRecoverabilitySummary_cf195d74f9ec1000164002143624006b" }, { "properties": { "id": { "type": "string", "description": "The id for Tax Recoverability" } } } ] }, "taxCode_cf195d74f9ec100016cbdaada70c0076": { "allOf": [ { "$ref": "#/definitions/taxCodeSummary_cf195d74f9ec1000137c599764990041" }, {} ], "description": "The tax code for the taxable purchase order line." }, "itemName_cf195d74f9ec1000153166b8a6640052": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The name of the item for the purchase order line." }, "unitOfMeasure_cf195d74f9ec100016cbda858e190073": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The unit of measure for the purchase order line." }, "worktags_cf195d74f9ec1000172ad9bc8e15007e": { "allOf": [ { "$ref": "#/definitions/worktagOutputSummary_4f941c252ef610001a8bf98a974f000e" }, { "properties": { "id": { "type": "string", "description": "The id for Accounting Worktag" } } } ] }, "itemOrderLineSummary_cf195d74f9ec10001531669fb7cf0051": { "allOf": [ { "type": "object", "properties": { "quantityInvoiced": { "type": "number", "example": 99999999999.99, "description": "The quantity on a document line associated to 1 or more supplier invoice lines. You can use this field to identify fully invoiced purchase orders with 2 or more separate invoice lines that partially fulfill the quantity on the purchase order.", "x-workday-type": "Numeric" }, "leadTime": { "type": "integer", "example": "99999999999", "description": "The lead time for the purchase order goods line.", "x-workday-type": "Numeric" }, "shipToContact": { "$ref": "#/definitions/shipToContact_cf195d74f9ec1000172ada158cc40083" }, "quantityReceived": { "type": "number", "example": 99999999999.99, "description": "The quantity received. If a Return exists, the quantity returned is deducted from the quantity received.", "x-workday-type": "Numeric" }, "deliverTo": { "$ref": "#/definitions/deliverTo_cf195d74f9ec1000172ada055ffa0082" }, "itemDescription": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The line item description for the purchase order line.", "x-workday-type": "Text" }, "extendedAmount": { "type": "object", "description": "The extended amount for the purchase order line. Excludes the extended amounts on Tax Only Invoices.", "properties": { "value": { "type": "string", "example": "99999999999.999", "description": "The amount, represented as a decimal string with up to 15 integer digit(s) and up to 3 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,15}(\\.\\d{1,3})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "splits": { "type": "array", "description": "The line splits on the purchase order. This field contains details of the line splits. This field is empty when the purchase order doesn't have line splits.", "items": { "$ref": "#/definitions/splits_cf195d74f9ec1000172ad9a0f9b3007d" }, "x-workday-type": "Multi-instance" }, "shipToAddress": { "$ref": "#/definitions/shipToAddress_cf195d74f9ec1000172ada267aea0084" }, "retention": { "type": "boolean", "example": true, "description": "If true, the purchase order line has retention.", "x-workday-type": "Boolean" }, "prepaid": { "type": "boolean", "example": true, "description": "If true, the purchase order line is prepaid.", "x-workday-type": "Boolean" }, "location": { "$ref": "#/definitions/location_cf195d74f9ec1000172ad9d215af007f" }, "deliveryType": { "$ref": "#/definitions/deliveryType_cf195d74f9ec1000172ada5a6a5f0087" }, "spendCategory": { "$ref": "#/definitions/spendCategory_cf195d74f9ec100016cbdadf81ff007a" }, "supplierItemIdentifier": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The alphanumeric identifier assigned by a supplier to an item. This value can be unique for each supplier of the item, and is different from the manufacturer identification number.", "x-workday-type": "Text" }, "taxApplicability": { "$ref": "#/definitions/taxApplicability_cf195d74f9ec100016cbdac79ee10078" }, "dueDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The date when the purchase order line is due for delivery. This value is based on the creation date of the purchase order and lead time for the item.", "x-workday-type": "Date" }, "taxRecoverability": { "type": "array", "description": "The tax recoverability percentage on a taxable purchase order line.", "items": { "$ref": "#/definitions/taxRecoverability_cf195d74f9ec100016cbda9d126c0075" }, "x-workday-type": "Multi-instance" }, "memo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The memo on the purchase order line. This field contains internal notes or reference text.", "x-workday-type": "Text" }, "taxCode": { "$ref": "#/definitions/taxCode_cf195d74f9ec100016cbdaada70c0076" }, "itemName": { "$ref": "#/definitions/itemName_cf195d74f9ec1000153166b8a6640052" }, "unitCost": { "type": "object", "description": "The unit cost for the purchase order line.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "requestedAsNoCharge": { "type": "boolean", "example": true, "description": "If true, the document line is associated to a No Charge requisition line. Requesters select No Charge when there is no expected cost for the requisition line.", "x-workday-type": "Boolean" }, "unitOfMeasure": { "$ref": "#/definitions/unitOfMeasure_cf195d74f9ec100016cbda858e190073" }, "worktags": { "type": "array", "description": "The Worktags for the purchase order line.", "items": { "$ref": "#/definitions/worktags_cf195d74f9ec1000172ad9bc8e15007e" }, "x-workday-type": "Multi-instance" }, "quantityShipped": { "type": "number", "example": 100000000000, "description": "The total quantity shipped for the purchase order line.", "x-workday-type": "Numeric" }, "quantityOrdered": { "type": "number", "example": 99999999999.99, "description": "The quantity on the purchase order line.", "x-workday-type": "Numeric" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Goods Order Line" } } } ] }, "projectPlanPhaseSummary_fdb911db39df100016a858ffafd0007d": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The name of the phrase associated with a project plan.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for \\~Project Plan Phase\\~" } } } ] }, "phase_d35e83e8978810001adc60817ed10130": { "allOf": [ { "$ref": "#/definitions/projectPlanPhaseSummary_fdb911db39df100016a858ffafd0007d" }, {} ], "description": "The project plan phase for a project. The project plan phase is unique to the project and the project phase is unique to the tenant." }, "projectPlanTaskSummary_fdb911db39df10001d0a349e858d00b0": { "allOf": [ { "type": "object", "properties": { "startDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The project plan task start date.", "x-workday-type": "Date" }, "endDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The project plan task end date.", "x-workday-type": "Date" }, "phase": { "$ref": "#/definitions/phase_d35e83e8978810001adc60817ed10130" }, "name": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The project plan task name.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for \\~Project Plan Task\\~" } } } ] }, "task_d35e83e8978810001a939eb15f14012e": { "allOf": [ { "$ref": "#/definitions/projectPlanTaskSummary_fdb911db39df10001d0a349e858d00b0" }, {} ], "description": "The project plan task associated with the project subtask." }, "projectSubtaskSummary_fdb911db39df10001d069e16a7ef00ad": { "allOf": [ { "type": "object", "properties": { "description": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The description of a project subtask on the document line. The project subtasks are always on the \nproject based service lines for procurement transactions.", "x-workday-type": "Text" }, "task": { "$ref": "#/definitions/task_d35e83e8978810001a939eb15f14012e" }, "amount": { "type": "object", "description": "The amount for the project subtask. The value can be negative and will be precise up to 6 decimal places.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for \\~Project\\~ Subtask" } } } ] }, "projectSummary_fdb911db39df10001874a16694be0089": { "allOf": [ { "type": "object", "properties": { "name": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The approved project name.", "x-workday-type": "Text" }, "endDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The approved project end date.", "x-workday-type": "Date" }, "reference": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The reference ID of a project from an external or third-party system.", "x-workday-type": "Text" }, "startDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The approved project start date.", "x-workday-type": "Date" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for \\~Project\\~" } } } ] }, "subtasks_d35e83e8978810001a38c58506dd0129": { "allOf": [ { "$ref": "#/definitions/projectSubtaskSummary_fdb911db39df10001d069e16a7ef00ad" }, { "properties": { "id": { "type": "string", "description": "The id for \\~Project\\~ Subtask" } } } ] }, "worktags_fdb911db39df10001b5ebf11fca500a4": { "allOf": [ { "$ref": "#/definitions/worktagOutputSummary_4f941c252ef610001a8bf98a974f000e" }, { "properties": { "id": { "type": "string", "description": "The id for Accounting Worktag" } } } ] }, "project_fdb911db39df10001a9b02cc9c07009e": { "allOf": [ { "$ref": "#/definitions/projectSummary_fdb911db39df10001874a16694be0089" }, {} ], "description": "The project for the project based purchase order line." }, "splits_fdb911db39df10001b5ebeffeac800a3": { "allOf": [ { "$ref": "#/definitions/purchaseOrderLineSplitSummary_cf195d74f9ec1000175cda6ac4b2008a" }, { "properties": { "id": { "type": "string", "description": "The id for Purchase Order Line Split" } } } ] }, "spendCategory_fdb911db39df10001846507529030087": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The spend category defined on the purchase order line." }, "projectBasedOrderLineSummary_fdb911db39df100014d0c71046a80074": { "allOf": [ { "type": "object", "properties": { "extendedAmount": { "type": "object", "description": "The extended amount for the purchase order line. Excludes the extended amounts on Tax Only Invoices.", "properties": { "value": { "type": "string", "example": "99999999999.999", "description": "The amount, represented as a decimal string with up to 15 integer digit(s) and up to 3 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,15}(\\.\\d{1,3})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "subtasks": { "type": "array", "description": "The project subtask for the project based purchase order line. Projects are always on project based service lines.", "items": { "$ref": "#/definitions/subtasks_d35e83e8978810001a38c58506dd0129" }, "x-workday-type": "Multi-instance" }, "prepaid": { "type": "boolean", "example": true, "description": "If true, the purchase order line is prepaid.", "x-workday-type": "Boolean" }, "retention": { "type": "boolean", "example": true, "description": "If true, retention check box is selected.", "x-workday-type": "Boolean" }, "memo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The memo for the project based purchase order line.", "x-workday-type": "Text" }, "worktags": { "type": "array", "description": "The worktags for the project based purchase order line.", "items": { "$ref": "#/definitions/worktags_fdb911db39df10001b5ebf11fca500a4" }, "x-workday-type": "Multi-instance" }, "amountReceived": { "type": "object", "description": "The total extended line amount of all receipt lines for the project based purchase order line.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "project": { "$ref": "#/definitions/project_fdb911db39df10001a9b02cc9c07009e" }, "amountInvoiced": { "type": "object", "description": "The total extended line amount of all invoice lines for the project based purchase order line.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "splits": { "type": "array", "description": "The line splits for the project based purchase order line. The field is empty if the line doesn't have splits.", "items": { "$ref": "#/definitions/splits_fdb911db39df10001b5ebeffeac800a3" }, "x-workday-type": "Multi-instance" }, "spendCategory": { "$ref": "#/definitions/spendCategory_fdb911db39df10001846507529030087" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for \\~Project\\~-Based Order Line" } } } ] }, "location_cf195d74f9ec100015fcfdab3812005f": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The location of the purchase order line. The location can be a delivery location or a worker's workspace. Example: Suite 100, Cubicle 1001." }, "deliverTo_cf195d74f9ec100015fcfdc4c3d30060": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The final location where the goods or services are delivered. Example: an employee work station or stock room." }, "spendCategory_cf195d74f9ec100015a9c8fb9a7b005c": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The spend category defined on the purchase order line." }, "shipToContact_cf195d74f9ec100015a9c8cb15dc0058": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The ship-to contact for the purchase order line." }, "worktags_cf195d74f9ec100015a9c8b384980056": { "allOf": [ { "$ref": "#/definitions/worktagOutputSummary_4f941c252ef610001a8bf98a974f000e" }, { "properties": { "id": { "type": "string", "description": "The id for Accounting Worktag" } } } ] }, "splits_fdb911db39df10000a06ce86baee0054": { "allOf": [ { "$ref": "#/definitions/purchaseOrderLineSplitSummary_cf195d74f9ec1000175cda6ac4b2008a" }, { "properties": { "id": { "type": "string", "description": "The id for Purchase Order Line Split" } } } ] }, "taxApplicability_cf195d74f9ec100015a9c8ef5d2b005b": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The tax applicability of the taxable invoice line." }, "taxRecoverability_cf195d74f9ec100015a9c8a1341a0055": { "allOf": [ { "$ref": "#/definitions/taxRecoverabilitySummary_cf195d74f9ec1000164002143624006b" }, { "properties": { "id": { "type": "string", "description": "The id for Tax Recoverability" } } } ] }, "itemName_cf195d74f9ec10001517e8f83ab8004f": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The name of the item for the purchase order line." }, "taxCode_cf195d74f9ec100015a9c8e171a1005a": { "allOf": [ { "$ref": "#/definitions/taxCodeSummary_cf195d74f9ec1000137c599764990041" }, {} ], "description": "The tax code for the taxable purchase order line." }, "shipToAddress_cf195d74f9ec100015fcfdd702890061": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The shipping address for the purchase order line. If the line shipToAddress is empty, the header shipToAddress is returned." }, "orderServiceLineSummary_cf195d74f9ec10001517e8cf7095004e": { "allOf": [ { "type": "object", "properties": { "location": { "$ref": "#/definitions/location_cf195d74f9ec100015fcfdab3812005f" }, "extendedAmount": { "type": "object", "description": "The extended amount for the purchase order line. Excludes extended amounts on tax only invoices.", "properties": { "value": { "type": "string", "example": "99999999999.999", "description": "The amount, represented as a decimal string with up to 15 integer digit(s) and up to 3 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,15}(\\.\\d{1,3})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "deliverTo": { "$ref": "#/definitions/deliverTo_cf195d74f9ec100015fcfdc4c3d30060" }, "spendCategory": { "$ref": "#/definitions/spendCategory_cf195d74f9ec100015a9c8fb9a7b005c" }, "amountReceived": { "type": "object", "description": "The total extended line amount of all receipt lines for the purchase order line.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "shipToContact": { "$ref": "#/definitions/shipToContact_cf195d74f9ec100015a9c8cb15dc0058" }, "startDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The start date for the simple service order line.", "x-workday-type": "Date" }, "amountInvoiced": { "type": "object", "description": "The total extended line amount of all invoice lines for the purchase order line. This field works with Goods and Service lines. The currency is the currency of the purchase order.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "endDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The end date for the simple service order line.", "x-workday-type": "Date" }, "retention": { "type": "boolean", "example": true, "description": "If true, the purchase order line has retention.", "x-workday-type": "Boolean" }, "itemDescription": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The line item description for the purchase order line.", "x-workday-type": "Text" }, "prepaid": { "type": "boolean", "example": true, "description": "If true, the purchase order line is prepaid.", "x-workday-type": "Boolean" }, "worktags": { "type": "array", "description": "The Worktags for the purchase order line.", "items": { "$ref": "#/definitions/worktags_cf195d74f9ec100015a9c8b384980056" }, "x-workday-type": "Multi-instance" }, "splits": { "type": "array", "description": "The line splits on the purchase order line. Empty when the purchase order line doesn't have splits.", "items": { "$ref": "#/definitions/splits_fdb911db39df10000a06ce86baee0054" }, "x-workday-type": "Multi-instance" }, "memo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The line memo for the purchase order line.", "x-workday-type": "Text" }, "dueDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The date when the purchase order line is due for delivery. This value is based on the creation date of the purchase order and lead time for the item.", "x-workday-type": "Date" }, "amountOrdered": { "type": "object", "description": "The extended amount for the purchase order line. Excludes extended amounts on Tax Only Invoices.", "properties": { "value": { "type": "string", "example": "99999999999.999", "description": "The amount, represented as a decimal string with up to 15 integer digit(s) and up to 3 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,15}(\\.\\d{1,3})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "taxApplicability": { "$ref": "#/definitions/taxApplicability_cf195d74f9ec100015a9c8ef5d2b005b" }, "taxRecoverability": { "type": "array", "description": "The tax recoverability percentage on a taxable purchase order line.", "items": { "$ref": "#/definitions/taxRecoverability_cf195d74f9ec100015a9c8a1341a0055" }, "x-workday-type": "Multi-instance" }, "itemName": { "$ref": "#/definitions/itemName_cf195d74f9ec10001517e8f83ab8004f" }, "taxCode": { "$ref": "#/definitions/taxCode_cf195d74f9ec100015a9c8e171a1005a" }, "shipToAddress": { "$ref": "#/definitions/shipToAddress_cf195d74f9ec100015fcfdd702890061" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Service Order Line" } } } ] }, "goodsLines_fdb911db39df10000bc72b4d29d50064": { "allOf": [ { "$ref": "#/definitions/itemOrderLineSummary_cf195d74f9ec10001531669fb7cf0051" }, { "properties": { "id": { "type": "string", "description": "The id for Goods Order Line" } } } ] }, "projectBasedServiceLines_fdb911db39df100014c6c578722c0072": { "allOf": [ { "$ref": "#/definitions/projectBasedOrderLineSummary_fdb911db39df100014d0c71046a80074" }, { "properties": { "id": { "type": "string", "description": "The id for \\~Project\\~-Based Order Line" } } } ] }, "taxCodes_fdb911db39df10000d27c7d51697006f": { "allOf": [ { "$ref": "#/definitions/taxCodeSummary_cf195d74f9ec1000137c599764990041" }, { "properties": { "id": { "type": "string", "description": "The id for Tax Code" } } } ] }, "serviceLines_fdb911db39df10000bef1fb190c70067": { "allOf": [ { "$ref": "#/definitions/orderServiceLineSummary_cf195d74f9ec10001517e8cf7095004e" }, { "properties": { "id": { "type": "string", "description": "The id for Service Order Line" } } } ] }, "billToAddress_cf195d74f9ec10000e604dce73960011": { "allOf": [ { "$ref": "#/definitions/addressSummary_cf195d74f9ec10001224e99d9b0f0025" }, { "properties": { "id": { "type": "string", "description": "The id for Address" } } } ] }, "types_6cba5b54c13910000e49a56391a20000": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Requisition Type \nExample(s): Requisition_Type_Reference_ID=Sample_Value" }, "Requisition_Type_Reference_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "location_6cba5b54c13910000fe4cab1f61d0000": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Location" } } } ] }, "companies_8d1b9d13e051100026cf54bda2180000": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Organization \nExample(s): Organization_Reference_ID=Sample_Value" }, "Organization_Reference_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "requisitionLineSupplierSummary_1f42830d725f100006e7b88250ba004b": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Supplier" } } } ] }, "worktags_1f42830d725f100006d5036af1050047": { "allOf": [ { "$ref": "#/definitions/worktagOutputSummary_4f941c252ef610001a8bf98a974f000e" }, { "properties": { "id": { "type": "string", "description": "The id for Accounting Worktag" } } } ] }, "requisitionLineSplitSummary_1f42830d725f100006d5031fce6b0042": { "allOf": [ { "type": "object", "properties": { "percent": { "type": "number", "example": 999.999999, "description": "The Percentage specified for the Requisition Line distribution line split.", "x-workday-type": "Numeric" }, "worktags": { "type": "array", "description": "The Worktags specified for the Requisition Line distribution line split.", "items": { "$ref": "#/definitions/worktags_1f42830d725f100006d5036af1050047" }, "x-workday-type": "Multi-instance" }, "amount": { "type": "object", "description": "The amount on the Requisition line split. This value displays in the same currency of the Requisition.", "properties": { "value": { "type": "string", "example": "99999999999.999", "description": "The amount, represented as a decimal string with up to 15 integer digit(s) and up to 3 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,15}(\\.\\d{1,3})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "memo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The memo for a Requisition Line split on the requisition or purchase order.", "x-workday-type": "Text" }, "quantity": { "type": "number", "example": 100000000000, "description": "The Quantity specified for the Requisition Line distribution line split.", "x-workday-type": "Numeric" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Requisition Line Split" } } } ] }, "spendCategory_1f42830d725f1000071ed8d84e5a0050": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The spend category of the service line on the requisition." }, "worktags_1f42830d725f1000071ed978688d005d": { "allOf": [ { "$ref": "#/definitions/worktagOutputSummary_4f941c252ef610001a8bf98a974f000e" }, { "properties": { "id": { "type": "string", "description": "The id for Accounting Worktag" } } } ] }, "supplier_1f42830d725f1000071ed968707e005c": { "allOf": [ { "$ref": "#/definitions/requisitionLineSupplierSummary_1f42830d725f100006e7b88250ba004b" }, { "properties": { "id": { "type": "string", "description": "The id for Supplier" } } } ] }, "itemName_1f42830d725f1000071ed8fe6b010053": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The item of the service line on the requisition." }, "shipToAddress_1f42830d725f1000071ed94d2ed5005a": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The ship-to address of the service line on the requisition. Workday uses the ship-to address on the requisition when you don't specify a ship-to address for the service line." }, "orderFromConnection_1f42830d725f1000071ed92249e40056": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The order-from supplier connection of the service line on the requisition. Based on sourcing rules, but you can manually specify a different connection." }, "deliverTo_1f42830d725f1000071ed8c935fb004f": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The final destination of the services. Example: An employee's work station or the stock room." }, "splits_1f42830d725f1000071ed92ad1f60057": { "allOf": [ { "$ref": "#/definitions/requisitionLineSplitSummary_1f42830d725f100006d5031fce6b0042" }, { "properties": { "id": { "type": "string", "description": "The id for Requisition Line Split" } } } ] }, "shipToContact_1f42830d725f1000071ed95acae3005b": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The ship-to contact worker of the service line on the requisition." }, "fulfillmentSource_1f42830d725f1000071ed8f060830052": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The method that fulfills the services on the requisition. Possible fulfillment sources are: Purchase Order, Inventory, Other, Storage." }, "templateServiceLineDetail_1f42830d725f1000071ed8a9159b004e": { "allOf": [ { "type": "object", "properties": { "spendCategory": { "$ref": "#/definitions/spendCategory_1f42830d725f1000071ed8d84e5a0050" }, "worktags": { "type": "array", "description": "The accounting worktags that apply to the service line on the requisition.", "items": { "$ref": "#/definitions/worktags_1f42830d725f1000071ed978688d005d" }, "x-workday-type": "Multi-instance" }, "itemDescription": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The description for the item of the service line on the requisition.", "x-workday-type": "Text" }, "extendedAmount": { "type": "object", "description": "The extended amount of the service line on the requisition. Doesn't include the extended amounts of tax-only invoices.", "properties": { "value": { "type": "string", "example": "99999999999.999", "description": "The amount, represented as a decimal string with up to 15 integer digit(s) and up to 3 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,15}(\\.\\d{1,3})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "supplier": { "type": "array", "description": "The supplier or resource provider of the service line on the requisition. Helps determine the supplier for each line on a purchase order when your order includes multiple suppliers.", "items": { "$ref": "#/definitions/supplier_1f42830d725f1000071ed968707e005c" }, "x-workday-type": "Multi-instance" }, "memo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The memo of the service line on the requisition.", "x-workday-type": "Text" }, "itemName": { "$ref": "#/definitions/itemName_1f42830d725f1000071ed8fe6b010053" }, "shipToAddress": { "$ref": "#/definitions/shipToAddress_1f42830d725f1000071ed94d2ed5005a" }, "startDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The requested start date of the service line on the requisition. Provided by the user who submits the requisition. Can determine the start of a service contract.", "x-workday-type": "Date" }, "orderFromConnection": { "$ref": "#/definitions/orderFromConnection_1f42830d725f1000071ed92249e40056" }, "deliverTo": { "$ref": "#/definitions/deliverTo_1f42830d725f1000071ed8c935fb004f" }, "splits": { "type": "array", "description": "The line splits of the service line on the requisition.", "items": { "$ref": "#/definitions/splits_1f42830d725f1000071ed92ad1f60057" }, "x-workday-type": "Multi-instance" }, "shipToContact": { "$ref": "#/definitions/shipToContact_1f42830d725f1000071ed95acae3005b" }, "fulfillmentSource": { "$ref": "#/definitions/fulfillmentSource_1f42830d725f1000071ed8f060830052" }, "endDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The requested end date of the service line on the requisition. Provided by the user who submits the requisition. Can determine the end of the service contract.", "x-workday-type": "Date" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Service Requisition Line" } } } ] }, "worktagType_cf195d74f9ec10001623690e4da90069": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The Accounting Worktag type for the Accounting Worktag." }, "accountingWorktagSummary_cf195d74f9ec1000162368e7d88f0068": { "allOf": [ { "type": "object", "properties": { "worktagType": { "$ref": "#/definitions/worktagType_cf195d74f9ec10001623690e4da90069" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Accounting Worktag" } } } ] }, "requisitionLineAlternateItemIdentifierSummary_1f42830d725f100006b67666ad25003e": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Alternate Item Identifier" } } } ] }, "requisitionLineTagSummary_1f42830d725f100006be070a818b0040": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Item Tag" } } } ] }, "splits_1f42830d725f100006a4a80072ee0032": { "allOf": [ { "$ref": "#/definitions/requisitionLineSplitSummary_1f42830d725f100006d5031fce6b0042" }, { "properties": { "id": { "type": "string", "description": "The id for Requisition Line Split" } } } ] }, "shipToAddress_1f42830d725f100006a4a80d0c330033": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The ship-to address of the goods line on the requisition. Workday uses the ship-to address on the requisition when you don't specify a ship-to address for the goods line." }, "fulfillmentSource_24f79e31e63e10001aac406c7040018c": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The method that fulfills the goods on the requisition. Possible fulfillment sources are: Purchase Order, Inventory, Other, Storage." }, "inventorySite_381009cc175310002536f74617620000": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The inventory site for requisition line. The inventory site is for an inventory-replenishment type requisition." }, "orderFromConnection_1f42830d725f100006a4a7d2927b002f": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The order-from supplier connection of the goods line on the requisition. Based on sourcing rules, but you can manually specify a different connection." }, "unitOfMeasure_1f42830d725f100006a4a84c03270038": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The unit of measure of the goods line on the requisition." }, "shipToContact_1f42830d725f100006a4a81a42b70034": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The ship-to contact worker of the goods line on the requisition." }, "itemIdentifiers_1f42830d725f100006a4a8678c7e003a": { "allOf": [ { "$ref": "#/definitions/requisitionLineAlternateItemIdentifierSummary_1f42830d725f100006b67666ad25003e" }, { "properties": { "id": { "type": "string", "description": "The id for Alternate Item Identifier" } } } ] }, "itemName_1f42830d725f100006a4a7ed1ec00030": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The item of the goods line on the requisition. This can't be a catalog or supplier item." }, "worktags_1f42830d725f100006a4a859b7c20039": { "allOf": [ { "$ref": "#/definitions/worktagOutputSummary_4f941c252ef610001a8bf98a974f000e" }, { "properties": { "id": { "type": "string", "description": "The id for Accounting Worktag" } } } ] }, "supplier_1f42830d725f100006a4a824438b0035": { "allOf": [ { "$ref": "#/definitions/requisitionLineSupplierSummary_1f42830d725f100006e7b88250ba004b" }, { "properties": { "id": { "type": "string", "description": "The id for Supplier" } } } ] }, "deliverTo_1f42830d725f100006a4a798a2cb002a": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The final destination of the goods. Example: An employee's work station or the stock room." }, "itemTags_1f42830d725f100006a4a7af2516002c": { "allOf": [ { "$ref": "#/definitions/requisitionLineTagSummary_1f42830d725f100006be070a818b0040" }, { "properties": { "id": { "type": "string", "description": "The id for Item Tag" } } } ] }, "spendCategory_1f42830d725f100006a4a875e093003b": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The spend category of the goods line on the requisition." }, "templateGoodsLineDetail_1f42830d725f100006a4a777ba970029": { "allOf": [ { "type": "object", "properties": { "splits": { "type": "array", "description": "The line splits of the goods line on the requisition.", "items": { "$ref": "#/definitions/splits_1f42830d725f100006a4a80072ee0032" }, "x-workday-type": "Multi-instance" }, "shipToAddress": { "$ref": "#/definitions/shipToAddress_1f42830d725f100006a4a80d0c330033" }, "supplierItemIdentifier": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The alphanumeric identifier that a supplier assigns to an item. Each supplier can provide a unique identifier for the item. This identifier differs from the manufacturer identification number.", "x-workday-type": "Text" }, "fulfillmentSource": { "$ref": "#/definitions/fulfillmentSource_24f79e31e63e10001aac406c7040018c" }, "inventorySite": { "$ref": "#/definitions/inventorySite_381009cc175310002536f74617620000" }, "orderFromConnection": { "$ref": "#/definitions/orderFromConnection_1f42830d725f100006a4a7d2927b002f" }, "unitOfMeasure": { "$ref": "#/definitions/unitOfMeasure_1f42830d725f100006a4a84c03270038" }, "shipToContact": { "$ref": "#/definitions/shipToContact_1f42830d725f100006a4a81a42b70034" }, "memo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The memo of the goods line on the requisition.", "x-workday-type": "Text" }, "itemIdentifiers": { "type": "array", "description": "The alternate item identifiers associated with the inventory item on the goods line of the requisition.", "items": { "$ref": "#/definitions/itemIdentifiers_1f42830d725f100006a4a8678c7e003a" }, "x-workday-type": "Multi-instance" }, "itemName": { "$ref": "#/definitions/itemName_1f42830d725f100006a4a7ed1ec00030" }, "itemDescription": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The description for the item of the goods line on the requisition.", "x-workday-type": "Text" }, "worktags": { "type": "array", "description": "The accounting worktags that apply to the goods line on the requisition.", "items": { "$ref": "#/definitions/worktags_1f42830d725f100006a4a859b7c20039" }, "x-workday-type": "Multi-instance" }, "supplier": { "type": "array", "description": "The supplier or resource provider of the goods line on the requisition. Helps determine the supplier for each line on a purchase order when your order includes multiple suppliers.", "items": { "$ref": "#/definitions/supplier_1f42830d725f100006a4a824438b0035" }, "x-workday-type": "Multi-instance" }, "deliverTo": { "$ref": "#/definitions/deliverTo_1f42830d725f100006a4a798a2cb002a" }, "itemTags": { "type": "array", "description": "The item tags associated with a delivery run on a goods line.", "items": { "$ref": "#/definitions/itemTags_1f42830d725f100006a4a7af2516002c" }, "x-workday-type": "Multi-instance" }, "unitCost": { "type": "object", "description": "The unit cost of the goods line on the requisition.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "spendCategory": { "$ref": "#/definitions/spendCategory_1f42830d725f100006a4a875e093003b" }, "quantity": { "type": "number", "example": 99999999999.99, "description": "The quantity of the item for the goods line on the requisition.", "x-workday-type": "Numeric" }, "extendedAmount": { "type": "object", "description": "The extended amount of the goods line on the requisition. Doesn't include the extended amounts of tax-only invoices.", "properties": { "value": { "type": "string", "example": "99999999999.999", "description": "The amount, represented as a decimal string with up to 15 integer digit(s) and up to 3 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,15}(\\.\\d{1,3})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Goods Requisition Line" } } } ] }, "types_25b4f9a028ac10001abc23b03e840000": { "allOf": [ { "$ref": "#/definitions/types_6cba5b54c13910000e49a56391a20000" }, { "properties": { "id": { "type": "string", "description": "The id for Requisition Type \nExample(s): Requisition_Type_Reference_ID=Sample_Value" } } } ] }, "locations_25b4f9a028ac10001abc23b03e840001": { "allOf": [ { "$ref": "#/definitions/location_6cba5b54c13910000fe4cab1f61d0000" }, { "properties": { "id": { "type": "string", "description": "The id for Location" } } } ] }, "companies_8d1b9d13e05110001741f1e0a87d0000": { "allOf": [ { "$ref": "#/definitions/companies_8d1b9d13e051100026cf54bda2180000" }, { "properties": { "id": { "type": "string", "description": "The id for Organization \nExample(s): Organization_Reference_ID=Sample_Value" } } } ] }, "serviceLines_1f42830d725f100006616b02cdbb0026": { "allOf": [ { "$ref": "#/definitions/templateServiceLineDetail_1f42830d725f1000071ed8a9159b004e" }, { "properties": { "id": { "type": "string", "description": "The id for Service Requisition Line" } } } ] }, "worktags_6167bf5da15e1000186498034cba0000": { "allOf": [ { "$ref": "#/definitions/accountingWorktagSummary_cf195d74f9ec1000162368e7d88f0068" }, { "properties": { "id": { "type": "string", "description": "The id for Accounting Worktag" } } } ] }, "goodsLines_1f42830d725f100006616b1943270027": { "allOf": [ { "$ref": "#/definitions/templateGoodsLineDetail_1f42830d725f100006a4a777ba970029" }, { "properties": { "id": { "type": "string", "description": "The id for Goods Requisition Line" } } } ] }, "types_25b4f9a028ac10001a55323bfe440000": { "allOf": [ { "$ref": "#/definitions/types_6cba5b54c13910000e49a56391a20000" }, { "properties": { "id": { "type": "string", "description": "The id for Requisition Type \nExample(s): Requisition_Type_Reference_ID=Sample_Value" } } } ] }, "locations_25b4f9a028ac10001a55336fed1a0000": { "allOf": [ { "$ref": "#/definitions/location_6cba5b54c13910000fe4cab1f61d0000" }, { "properties": { "id": { "type": "string", "description": "The id for Location" } } } ] }, "companies_8d1b9d13e051100020a18307c29c0000": { "allOf": [ { "$ref": "#/definitions/companies_8d1b9d13e051100026cf54bda2180000" }, { "properties": { "id": { "type": "string", "description": "The id for Organization \nExample(s): Organization_Reference_ID=Sample_Value" } } } ] }, "worktags_6167bf5da15e100018d3d2a261f30000": { "allOf": [ { "$ref": "#/definitions/accountingWorktagSummary_cf195d74f9ec1000162368e7d88f0068" }, { "properties": { "id": { "type": "string", "description": "The id for Accounting Worktag" } } } ] }, "companyReferenceSummary_1659877d377c100004bb760250f60021": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Company \nExample(s): Company_Reference_ID=Sample_Value" }, "Company_Reference_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "imageContent_51eee0e1cc8a100013fadcc84ce3506c": { "allOf": [ { "type": "object", "properties": { "url": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The relative url for this image in UI Server.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "The id for Image" } } } ] }, "image_51eee0e1cc8a1000119edd3295734dd5": { "allOf": [ { "$ref": "#/definitions/imageContent_51eee0e1cc8a100013fadcc84ce3506c" }, {} ], "description": "Returns the photo for the role." }, "workerSummary_51eee0e1cc8a1000119edd0c72164dd4": { "allOf": [ { "type": "object", "properties": { "image": { "$ref": "#/definitions/image_51eee0e1cc8a1000119edd3295734dd5" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for \\~Worker\\~" } } } ] }, "currencyReferenceSummary_cb124c4f53f0100013e8c4ae81de000e": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The full name of the currency.", "x-workday-type": "Text" }, "currencySymbol": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The three letter currency symbol for the currency.", "x-workday-type": "Text" }, "id": { "type": "string", "description": "The id for Currency \nExample(s): Currency_ID=Sample_Value" }, "Currency_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "locationReferenceSummary_1659877d377c100004d9240d45210025": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Location \nExample(s): Location_ID=Sample_Value" }, "Location_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "requisitionTypeDetails_72e9dc2aa56c1000131c41de93e60000": { "allOf": [ { "type": "object", "properties": { "billOnly": { "type": "boolean", "example": true, "description": "Bill Only flag defined on Maintain Requisition Types Task.", "x-workday-type": "Boolean" }, "parReplenishment": { "type": "boolean", "example": true, "description": "Par Replenishment flag defined on Maintain Requisition Types Task.", "x-workday-type": "Boolean" }, "inactive": { "type": "boolean", "example": true, "description": "Inactive flag defined on Maintain Requisition Types Task.", "x-workday-type": "Boolean" }, "justInTime": { "type": "boolean", "example": true, "description": "Just In Time flag defined on Maintain Requisition Types Task.", "x-workday-type": "Boolean" }, "consignment": { "type": "boolean", "example": true, "description": "Consignment flag defined on Maintain Requisition Types Task.", "x-workday-type": "Boolean" }, "inventoryReplenishment": { "type": "boolean", "example": true, "description": "Inventory Replenishment flag defined on Maintain Requisition Types Task.", "x-workday-type": "Boolean" }, "procedureInformation": { "type": "boolean", "example": true, "description": "Procedure Information flag defined on Maintain Requisition Types Task.", "x-workday-type": "Boolean" }, "hasService": { "type": "boolean", "example": true, "description": "Does the requisition type have a service.", "x-workday-type": "Boolean" }, "supplierContractRequest": { "type": "boolean", "example": true, "description": "Supplier Contract Request flag defined on Maintain Requisition Types Task", "x-workday-type": "Boolean" } } } ] }, "requisitionTypeDetails_1fe25e2f325d100082cb437c7caa0000": { "allOf": [ { "$ref": "#/definitions/requisitionTypeDetails_72e9dc2aa56c1000131c41de93e60000" }, {} ], "description": "Details about the type of requisition defined on the Maintain Requisition Types Task." }, "metadata_1fe25e2f325d100082cb42c714e00000": { "allOf": [ { "type": "object", "properties": { "requisitionTypeDetails": { "$ref": "#/definitions/requisitionTypeDetails_1fe25e2f325d100082cb437c7caa0000" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Instance" } } } ] }, "lotSerialInformationSummary_534926b8b63f10000402c93f59be0437": { "allOf": [ { "type": "object", "properties": { "serialNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The lot serial number for the lot and serial transaction.", "x-workday-type": "Text" }, "lotNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The lot number for the lot and serial transaction.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Lot Serial Information" } } } ] }, "imageFileContent_64345f878dcb1000115957fe7d8d00b2": { "allOf": [ { "type": "object", "properties": { "internalURL": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The URL for the image in Workdays UI Server.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "The id for Image" } } } ] }, "orderFromConnectionSummary_a390d639b28d1000160aed065d3e50e8": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Order-From Connection" } } } ] }, "shipToContact_6d3015ddfd3910001217c89b868700b4": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The ship-to contact worker for the requisition line." }, "unitOfMeasure_ab8f5f8e8be010000853aa8344a80066": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The unit of measure for the requisition line." }, "shipToAddressReference_08abdc29646510000c9be044dcc800e4": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The address reference related to the ship-to address of the requisition line. \n\nMigration Note: The shipToAddressReference field contains the shipToAddress information provided with v1 and v2. For v3 and later, the shipToAddress field contains the actual ship to address." }, "item_4b60be2b856c100017ffbedcd66d316e": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The item for the requisition line." }, "supplier_08abdc29646510000d901d201aac00eb": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The resource provider for the requisition line. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area.", "x-conditionally-required": true, "x-conditionally-hidden": true }, "spendCategory_4b60be2b856c100017ffbe8a7969316d": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The spend category for the requisition line. This is represented as a worktag object." }, "shipToAddress_08abdc29646510000c9be0a51fd300e5": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The ship-to address for the requisition line. If line ship-to address is empty, the ship-to address in the requisition header is returned. \n\nMigration Note: For v3 and later, the shipToAddress field contains the actual ship to address. The shipToAddressReference field contains the shipToAddress information provided with v1 and v2." }, "worktags_4b60be2b856c100017ffbd52fe79316a": { "allOf": [ { "$ref": "#/definitions/worktagOutputSummary_4f941c252ef610001a8bf98a974f000e" }, { "properties": { "id": { "type": "string", "description": "The id for Accounting Worktag" } } } ] }, "lotSerialInformation_534926b8b63f100004072e611cfa043b": { "allOf": [ { "$ref": "#/definitions/lotSerialInformationSummary_534926b8b63f10000402c93f59be0437" }, {} ], "description": "The lot serial information for the requisition line." }, "lineCompany_0a09bb80d02a1000113481131e201358": { "allOf": [ { "$ref": "#/definitions/companyReferenceSummary_1659877d377c100004bb760250f60021" }, {} ], "description": "The company for the requisition line.", "x-conditionally-hidden": true }, "supplierContract_6ecbe9a89eb3100021ddfbdb8787003e": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The supplier contract for the requisition line. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area.", "x-conditionally-required": true, "x-conditionally-hidden": true }, "deliverToLocation_6ecbe9a89eb3100015f2f35490340028": { "allOf": [ { "$ref": "#/definitions/locationReferenceSummary_1659877d377c100004d9240d45210025" }, {} ], "description": "The deliver-to location on the requisition line. The deliver-to location may represent a par location, an inventory site or stocking location for replenishment-type requisitions. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area.", "x-conditionally-required": true, "x-conditionally-hidden": true }, "itemImage_64345f878dcb100011232977e64f00af": { "allOf": [ { "$ref": "#/definitions/imageFileContent_64345f878dcb1000115957fe7d8d00b2" }, {} ], "description": "The image for the item on the requisition line." }, "commodityCode_bccd7e4e613610001c6323d916f00000": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The code that identifies the type of goods or service. You can use this field to drill into the commodity code details such as description, level name, or associated spend categories." }, "orderFromConnection_dd013619a2181000106f3ec5f9ff4e87": { "allOf": [ { "$ref": "#/definitions/orderFromConnectionSummary_a390d639b28d1000160aed065d3e50e8" }, {} ], "description": "The order-from supplier connection to use when sourcing this requisition line.", "x-conditionally-required": true, "x-conditionally-hidden": true }, "requisitionLineSummary_4b60be2b856c100017ffbcc376cf3169": { "allOf": [ { "type": "object", "properties": { "shipToContact": { "$ref": "#/definitions/shipToContact_6d3015ddfd3910001217c89b868700b4" }, "unitOfMeasure": { "$ref": "#/definitions/unitOfMeasure_ab8f5f8e8be010000853aa8344a80066" }, "itemURL": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The Workday Instance View URL for a Procurement Item Instance - From a Line", "x-workday-type": "Text" }, "shipToAddressReference": { "$ref": "#/definitions/shipToAddressReference_08abdc29646510000c9be044dcc800e4" }, "item": { "$ref": "#/definitions/item_4b60be2b856c100017ffbedcd66d316e" }, "supplier": { "$ref": "#/definitions/supplier_08abdc29646510000d901d201aac00eb" }, "spendCategory": { "$ref": "#/definitions/spendCategory_4b60be2b856c100017ffbe8a7969316d" }, "shipToAddress": { "$ref": "#/definitions/shipToAddress_08abdc29646510000c9be0a51fd300e5" }, "unitCost": { "type": "object", "description": "The unit cost for the requisition line.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "quantity": { "type": "number", "example": 99999999999.99, "description": "The quantity on the requisition line. This value can have 20 integer places, is precise to 2 decimal places, and cannot be negative.", "x-workday-type": "Numeric" }, "worktags": { "type": "array", "description": "The worktags for the requisition line.", "items": { "$ref": "#/definitions/worktags_4b60be2b856c100017ffbd52fe79316a" }, "x-workday-type": "Multi-instance" }, "catalogItem": { "type": "boolean", "example": true, "description": "If true, the business document line is for a catalog item.", "x-workday-type": "Boolean" }, "webItemImageURL": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The URL for the supplier's image of the web item on the requisition line. This field returns blank when the line is not for a web item, or when configuration in Workday prevents external images from that supplier website.", "x-workday-type": "Text" }, "lotSerialInformation": { "$ref": "#/definitions/lotSerialInformation_534926b8b63f100004072e611cfa043b" }, "lineCompany": { "$ref": "#/definitions/lineCompany_0a09bb80d02a1000113481131e201358" }, "formattedUnitCost": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The unit cost for the business document line showing the currency symbol. Positive/negative display format, currency symbol placement, grouping separator, and decimal separator is based on the locale of the current logged in user.", "x-workday-type": "Text" }, "writeInService": { "type": "boolean", "example": true, "description": "If true, the requisition line is a service line with no purchase item, supplier item, or catalog item.", "x-workday-type": "Boolean" }, "writeInGoods": { "type": "boolean", "example": true, "description": "If true, the requisition line is a goods line with no purchase item, supplier item, or catalog item.", "x-workday-type": "Boolean" }, "endDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The end date requested for the service on the requisition line. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area.", "x-workday-type": "Date", "x-conditionally-required": true, "x-conditionally-hidden": true }, "supplierContract": { "$ref": "#/definitions/supplierContract_6ecbe9a89eb3100021ddfbdb8787003e" }, "createdMoment": { "type": "string", "format": "date-time", "example": "2026-11-02T08:00:00.000Z", "description": "The moment at which the requisition line was originally created.", "x-workday-type": "Date" }, "webItem": { "type": "boolean", "example": true, "description": "If true, the requisition line is for a web item.", "x-workday-type": "Boolean" }, "memo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The line memo for the requisition line. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area.", "x-workday-type": "Text", "x-conditionally-required": true, "x-conditionally-hidden": true }, "requestedDeliveryDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "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. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area.", "x-workday-type": "Date", "x-conditionally-required": true, "x-conditionally-hidden": true }, "deliverToLocation": { "$ref": "#/definitions/deliverToLocation_6ecbe9a89eb3100015f2f35490340028" }, "startDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The start date requested for the service on the requisition line. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area.", "x-workday-type": "Date", "x-conditionally-required": true, "x-conditionally-hidden": true }, "formattedExtendedAmount": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The extended amount for the business document line 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.", "x-workday-type": "Text" }, "serviceRequisitionLine": { "type": "boolean", "example": true, "description": "If true, the requisition line is for a service.", "x-workday-type": "Boolean" }, "itemImage": { "$ref": "#/definitions/itemImage_64345f878dcb100011232977e64f00af" }, "noCharge": { "type": "boolean", "example": true, "description": "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.", "x-workday-type": "Boolean", "x-conditionally-hidden": true }, "formattedShippingAddress": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The shipping address for the requisition line as a single string. Each line of the shipping address is delimited by HTML encoded line feed character.", "x-workday-type": "Text" }, "lineDeliverToLocationChain": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The deliver-to location and the associated hierarchy of deliver-to locations for the requisition line.", "x-workday-type": "Text" }, "commodityCode": { "$ref": "#/definitions/commodityCode_bccd7e4e613610001c6323d916f00000" }, "supplierItemIdentifier": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The alphanumeric identifier assigned by a supplier to an item. This value can be unique for each supplier of the item, and is different from the manufacturer identification number.", "x-workday-type": "Text" }, "rfqRequired": { "type": "boolean", "example": true, "description": "If true, a request for quote is required for the requisition line.", "x-workday-type": "Boolean" }, "extendedAmount": { "type": "object", "description": "The extended amount for the requisition line. Excludes extended amounts on tax only invoices.", "properties": { "value": { "type": "string", "example": "99999999999.999", "description": "The amount, represented as a decimal string with up to 15 integer digit(s) and up to 3 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,15}(\\.\\d{1,3})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "orderFromConnection": { "$ref": "#/definitions/orderFromConnection_dd013619a2181000106f3ec5f9ff4e87" }, "criticalCustomValidations": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "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.", "x-workday-type": "Text", "x-workday-confidence-level": "Preview" }, "itemDescription": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The line item description for the requisition line.", "x-workday-type": "Text" }, "warningCustomValidations": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "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.", "x-workday-type": "Text", "x-workday-confidence-level": "Preview" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "The id for Requisition Line \nExample(s): Requisition_Line_ID=Sample_Value" }, "Requisition_Line_ID": { "type": "string", "description": "Reference id of the instance" } } } ] }, "purchaseOrders_9f1cd7abc4cd10001629cc4b51b90009": { "allOf": [ { "$ref": "#/definitions/relatedPurchaseOrderSummary_cb124c4f53f010001af6190a9802001d" }, { "properties": { "id": { "type": "string", "description": "The id for Purchase Order" } } } ] }, "requisitionLines_a4a5fe393db110000addf2aa5dc90029": { "allOf": [ { "$ref": "#/definitions/requisitionLineSummary_4b60be2b856c100017ffbcc376cf3169" }, { "properties": { "id": { "type": "string", "description": "The id for Requisition Line \nExample(s): Requisition_Line_ID=Sample_Value" } } } ] }, "worktags_801199b6f414100008f45effa3af0d7b": { "allOf": [ { "$ref": "#/definitions/worktagOutputSummary_4f941c252ef610001a8bf98a974f000e" }, { "properties": { "id": { "type": "string", "description": "The id for Worktag" } } } ] }, "createLotSerialInformationRepresentation_5e69f73e461f10000b0710411362049d": { "allOf": [ { "type": "object", "properties": { "serialNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The lot serial number for the lot and serial transaction.", "x-workday-type": "Text" }, "lotNumber": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The lot number for the lot and serial transaction.", "x-workday-type": "Text" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Lot Serial Information Representation (Derived)" } } } ] }, "supplier_8e198fd5c45010001106a2abf240001a": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The supplier for the requisition line. This is represented as a worktag object." }, "lotSerialInformation_5e69f73e461f10000a58ce7bfb38049b": { "allOf": [ { "$ref": "#/definitions/createLotSerialInformationRepresentation_5e69f73e461f10000b0710411362049d" }, {} ], "description": "The lot serial information for the requisition line." }, "spendCategory_b5310fb7db7810002b5220edde690036": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The spend category for the requisition line." }, "shipToAddress_295148f8ac9d10000cb08c5155620028": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The address reference related to the ship-to address of the requisition line." }, "deliverToLocation_295148f8ac9d100012f3c1a6d03f003f": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The final location where the goods or services are delivered. Example: an employee's work station or stock room. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area." }, "lineCompany_0a09bb80d02a1000111c89e2640a1355": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The company for the requisition line." }, "supplierContract_b5310fb7db78100028b21512ebd70030": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The supplier contract for the requisition line." }, "shipToContact_295148f8ac9d10000f0808cd1d81003b": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The ship-to contact worker for the requisition line." }, "worktags_c08b59edd9d61000425d944efbab00a8": { "allOf": [ { "$ref": "#/definitions/worktagOutputSummary_4f941c252ef610001a8bf98a974f000e" }, { "properties": { "id": { "type": "string", "description": "The id for Worktag Representation (Derived)" } } } ] }, "item_7b5e81579f91100021173cf3872200ce": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The item for the requisition line." }, "unitOfMeasure_7b5e81579f9110002117386f972f00cb": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The unit of measure for the requisition line." }, "orderFromConnection_dd013619a218100010125939eb484e55": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The order-from supplier connection to use when sourcing this requisition line." }, "commodityCode_bccd7e4e613610001d0ebe572e490000": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The code that identifies the type of goods or service. You can use this field to drill into the commodity code details such as description, level name, or associated spend categories." }, "createRequisitionLineRepresentation_7b5e81579f9110002117318c90d900c9": { "allOf": [ { "type": "object", "properties": { "supplier": { "$ref": "#/definitions/supplier_8e198fd5c45010001106a2abf240001a" }, "startDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The start date requested for the service on the requisition line.", "x-workday-type": "Date" }, "criticalCustomValidations": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "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.", "x-workday-type": "Text", "x-workday-confidence-level": "Preview" }, "itemDescription": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The line item description for the requisition line.", "x-workday-type": "Text" }, "lotSerialInformation": { "$ref": "#/definitions/lotSerialInformation_5e69f73e461f10000a58ce7bfb38049b" }, "writeInService": { "type": "boolean", "example": true, "description": "If true, the requisition line is a service line with no purchase item, supplier item, or catalog item.", "x-workday-type": "Boolean" }, "writeInGoods": { "type": "boolean", "example": true, "description": "If true, the requisition line is a goods line with no purchase item, supplier item, or catalog item.", "x-workday-type": "Boolean" }, "spendCategory": { "$ref": "#/definitions/spendCategory_b5310fb7db7810002b5220edde690036" }, "shipToAddress": { "$ref": "#/definitions/shipToAddress_295148f8ac9d10000cb08c5155620028" }, "deliverToLocation": { "$ref": "#/definitions/deliverToLocation_295148f8ac9d100012f3c1a6d03f003f" }, "lineCompany": { "$ref": "#/definitions/lineCompany_0a09bb80d02a1000111c89e2640a1355" }, "rfqRequired": { "type": "boolean", "example": true, "description": "If true, a request for quote is required for the requisition line.", "x-workday-type": "Boolean" }, "supplierItemIdentifier": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The alphanumeric identifier assigned by a supplier to an item. This can be different from the manufacturer identification number.", "x-workday-type": "Text" }, "supplierContract": { "$ref": "#/definitions/supplierContract_b5310fb7db78100028b21512ebd70030" }, "shipToContact": { "$ref": "#/definitions/shipToContact_295148f8ac9d10000f0808cd1d81003b" }, "worktags": { "type": "array", "description": "The worktags for the requisition line.", "items": { "$ref": "#/definitions/worktags_c08b59edd9d61000425d944efbab00a8" }, "x-workday-type": "Multi-instance" }, "requestedDeliveryDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "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.", "x-workday-type": "Date" }, "noCharge": { "type": "boolean", "example": true, "description": "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.", "x-workday-type": "Boolean" }, "item": { "$ref": "#/definitions/item_7b5e81579f91100021173cf3872200ce" }, "memo": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The line memo for the requisition line.", "x-workday-type": "Text" }, "quantity": { "type": "number", "example": 99999999999.99, "description": "The quantity on the requisition line. This value can have 20 integer places, is precise to 2 decimal places, and cannot be negative.", "x-workday-type": "Numeric" }, "unitOfMeasure": { "$ref": "#/definitions/unitOfMeasure_7b5e81579f9110002117386f972f00cb" }, "unitCost": { "type": "object", "description": "The unit cost for the requisition line.", "properties": { "value": { "type": "string", "example": "99999999999.999999", "description": "The amount, represented as a decimal string with up to 20 integer digit(s) and up to 6 decimal digit(s). May be negative. Omitted from the response when the amount is zero.", "pattern": "^-?\\d{1,20}(\\.\\d{1,6})?$" }, "currency": { "type": "string", "example": "USD", "description": "The ISO 4217 code identifying the currency of the amount." } }, "x-workday-type": "Currency" }, "orderFromConnection": { "$ref": "#/definitions/orderFromConnection_dd013619a218100010125939eb484e55" }, "commodityCode": { "$ref": "#/definitions/commodityCode_bccd7e4e613610001d0ebe572e490000" }, "warningCustomValidations": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "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.", "x-workday-type": "Text", "x-workday-confidence-level": "Preview" }, "endDate": { "type": "string", "format": "date", "example": "2026-11-02T08:00:00.000Z", "description": "The end date requested for the service on the requisition line.", "x-workday-type": "Date" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Requisition Line Representation (Derived)" } } } ] }, "requisitionLines_3500b3bcf67710000ec797f68acd006c": { "allOf": [ { "$ref": "#/definitions/createRequisitionLineRepresentation_7b5e81579f9110002117318c90d900c9" }, { "properties": { "id": { "type": "string", "description": "The id for Requisition Line Representation (Derived)" } } } ] }, "requisitionLines_51435ed0dc1110001a81735dc9be0282": { "allOf": [ { "$ref": "#/definitions/createRequisitionLineRepresentation_7b5e81579f9110002117318c90d900c9" }, { "properties": { "id": { "type": "string", "description": "The id for Requisition Line Representation (Derived)" } } } ] }, "worktags_9f8a91a361e71000104edd32b88519dd": { "allOf": [ { "$ref": "#/definitions/worktagOutputSummary_4f941c252ef610001a8bf98a974f000e" }, { "properties": { "id": { "type": "string", "description": "The id for Worktag Representation (Derived)" } } } ] }, "contentType_c08b59edd9d610001c7f039fba1a007e": { "allOf": [ { "$ref": "#/definitions/INSTANCE_MODEL_REFERENCE" }, {} ], "description": "The content type of the attachment. Example: image/jpeg - mime_image" }, "businessDocumentAttachmentRepresentationCreate_c08b59edd9d610001c7f03721b53007c": { "allOf": [ { "type": "object", "properties": { "contentType": { "$ref": "#/definitions/contentType_c08b59edd9d610001c7f039fba1a007e" }, "fileLength": { "type": "integer", "example": "99999999999", "description": "The length of the attachment.", "x-workday-type": "Numeric" }, "fileName": { "type": "string", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "description": "The file name of the attachment.", "maxLength": 255, "x-workday-type": "Text" }, "attachmentContent": { "type": "string", "format": "binary", "description": "If true, an external supplier can view the attachment on the purchase order once the purchase order has been issued.", "x-workday-type": "File" }, "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "href": { "type": "string", "description": "A link to the instance" }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance." } } } ] }, "attachmentCategoryReferenceSummary_f38a185fa6b410000c241261e4b00000": { "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "example": "Lorem ipsum dolor sit ame", "description": "The display name of the instance" }, "id": { "type": "string", "description": "The id for Attachment Category" } } } ] }, "worktags_85fe2adb40611000128e4ac34f22018d": { "allOf": [ { "$ref": "#/definitions/worktagOutputSummary_4f941c252ef610001a8bf98a974f000e" }, { "properties": { "id": { "type": "string", "description": "The id for Worktag Representation (Derived)" } } } ] } } }