Service Directory > v33.1 > Resource_Management > Submit_Supplier_Contract_Lease_Amendment
 

Operation: Submit_Supplier_Contract_Lease_Amendment

Adds or updates lease amendments for supplier contracts. Updates require a full replace of the customer’s data. Uses the Supplier Contract Amendment Event business process.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Submit_Supplier_Contract_Lease_Amendment_Request

Submit Supplier Contract Lease Amendment Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Supplier_Contract_Lease_Amendment_Reference  Supplier_Contract_AmendmentObject  [0..1]  Reference to an existing Supplier Contract Lease Amendment for update only purposes.   
Supplier_Contract_Lease_Amendment_Data  Supplier_Contract_Lease_Amendment_Data  [0..1]  Lease Contract Amendment Data 
Validation Description
Before submission of your lease contract, you must first create all fiscal periods between your Contract Start Date and your Contract End Date. Workday can't generate the expense recognition schedule for your lease contract without the necessary fiscal periods.   
Enter a lease liability reassessment date that's at the start of a payment installment period.   
Enter a contract end date that's after the end date on the previous contract version.   
Enter a payment effective date that's on or before your contract end date.   
Enter a lease liability reassessment date that's on or before the contract end date.   
The Amendment cannot be created when a related asset has business process in progress.   
Enter a payment date that matches your payment frequency.   
Enter payment dates that are within the range of your payment frequency.   
Enter a payment date that matches your payment frequency.   
Before submission of your lease contract, you must first create all fiscal periods between your Contract Start Date and your Contract End Date. Workday can't generate the expense recognition schedule for your lease contract without the necessary fiscal periods.   
Enter a new payment amount for your amendment   
You can only create lease amendments for lease-type supplier contracts.   
You can't amend a variable payment amount when the lease-type supplier contract uses a fixed payment type.   
You can't amend multicompany lease-type supplier contracts.   
Remove the amended lease-type supplier contract. You can only amend a lease-type supplier contract once.   
The payment dates you submit with your Lease Payment Information lines must be unique.   
You can't change payment dates on your contract when the payment date is after the payment effective date of your amendment and before the end date of your original lease-type supplier contract.   
You must submit a total of [number of payments] Lease Payment Information lines to match the number of lines calculated using your payment effective date and contract end date.   
 
Validation Description
The web service is set to Add Only, but the supplier contract amendment already exists.   
top
 

Response Element: Submit_Supplier_Contract_Lease_Amendment_Response

Submit Supplier Contract Lease Amendment Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Supplier_Contract_Lease_Amendment_Reference  Supplier_Contract_AmendmentObject  [0..1]  Supplier Contract Lease Amendment Reference   
top
 

Supplier_Contract_AmendmentObject

part of: Submit_Supplier_Contract_Lease_Amendment_Response, Submit_Supplier_Contract_Lease_Amendment_Request
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Supplier_Contract_AmendmentObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Supplier_Contract_AmendmentObjectID

part of: Supplier_Contract_AmendmentObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Supplier_Contract_Amendment_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Supplier_Contract_Lease_Amendment_Data

part of: Submit_Supplier_Contract_Lease_Amendment_Request
Supplier Contract Amendment Data
 
Parameter name Type/Value Cardinality Description Validations
Submit  boolean  [0..1]  Submit   
Supplier_Contract_To_Amend_Reference  Supplier_ContractObject  [1..1]  Supplier Contract Reference for Amendment 
Validation Description
The Amendment cannot be created when a related asset has business process in progress.   
Both your amendment signed date and lease liability reassessment date must be in the same fiscal period.   
Submit an amendment signed date that's on or after your contract start date.   
Both your lease liability reassessment date and payment effective date must be in the same payment installment period.   
Enter a lease liability reassessment date that's on or after the contract start date.   
Enter a payment effective date that's on a payment installment period or payment frequency on your expense recognition schedule   
You can't enter a payment effective date that's before the fiscal period of your lease liability reassessment date.   
Remove any lease-type supplier contracts with amendments in progress. You can only amend a lease-type supplier contract once you approve all previous versions.   
Enter a payment effective date that's on or after your contract start date.   
Enter an amendment signed date that's in an open fiscal period.   
Enter a lease liability reassessment date that's in the earliest payment installment period available on or after the fiscal period of your amendment signed date.   
Enter an amendment signed date that's before the end date on the previous contract version.   
Enter an amendment signed date that's after your previous amendment signed date.   
Approve your lease-type supplier contract before you create a lease amendment. You can't amend canceled or unapproved lease-type supplier contracts.   
You can't amend the supplier contract you entered. Confirm that the contract has no other amendments and is an appropriate lease-type supplier contract with all necessary approvals, generated accounting, and business asset registrations.   
Create receipts and register the associated asset before you create an amendment.   
Your payment effective date must be the same as a scheduled payment date.   
Enter a payment effective date on the first day of the earliest available payment installment period. The installment period must be on or after the fiscal period of the end date on the previous contract version.   
 
Supplier_Contract_Lease_Amendment_Type_Reference  Supplier_Contract_Lease_Amendment_TypeObject  [1..1]  Amendment Type for Lease Contract Amendment   
Amendment_Signed_Date  date  [1..1]  Supplier Contract Amendment Signed Date 
Validation Description
Your amendment signed date is after today’s date. Enter an amendment sign date that is on or before today’s date.   
Enter an amendment signed date that's in a different fiscal period than the contract start date.   
 
Lease_Liability_Reassessment_Date  date  [0..1]  Lease Liability Reassessment Date 
Validation Description
Remove the lease liability reassessment date from lease-type supplier contracts that use straight line expense. You only need to provide a lease liability reassessment date on contracts that use straight line expense when there's an associated alternate contract.   
 
Payment_Effective_Date  date  [1..1]  Amendment Payment Effective Date   
Contract_End_Date  date  [0..1]  Contract End Date 
Validation Description
Enter the original contract end date or change the lease amendment type. You can only change the contract end date when the amendment type is an extension.   
For the final projected payment installment period, enter a contract end date that matches your payment frequency.   
 
Amendment_Description  string  [0..1]  Supplier Contract Amendment Description   
Amendment_Number  string  [0..1]  Supplier Contract Amendment Number   
Total_Contract_Amount  decimal (26, 6) >0   [1..1]  Total Contract Amount 
Validation Description
Your Total Contract Amount needs to be equal to or greater than Total Lease Payments.   
 
Override_Payment_Type_Reference  Payment_TypeObject  [0..1]  The payment type to use if it differs from the default payment type from the Supplier. This is used for all contract types except ones that have scheduled invoices   
Lease_Details_Data  Lease_Details_Amendment_Data  [0..1]  Element that contains details specific to Lease Contract Amendment   
Lease_Payment_Line_Replacement_Data  Lease_Payment_Line_Replacement_Data  [0..*]  Represents a single payment for the amount on the provided payment date. Only applies to Variable Payment lease contracts.   
Alternate_Contract_Interest_Rate_Data  Alternate_Contract_Interest_Rate_Data  [0..*]  Alternate Contract(s) Reference for Interest Rate Modification   
Attachment_Data  Financials_Attachment_Data  [0..*]  Encapsulating element containing all Business Document Attachment data. 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
Validation Description
Before submission of your lease contract, you must first create all fiscal periods between your Contract Start Date and your Contract End Date. Workday can't generate the expense recognition schedule for your lease contract without the necessary fiscal periods.   
Enter a lease liability reassessment date that's at the start of a payment installment period.   
Enter a contract end date that's after the end date on the previous contract version.   
Enter a payment effective date that's on or before your contract end date.   
Enter a lease liability reassessment date that's on or before the contract end date.   
The Amendment cannot be created when a related asset has business process in progress.   
Enter a payment date that matches your payment frequency.   
Enter payment dates that are within the range of your payment frequency.   
Enter a payment date that matches your payment frequency.   
Before submission of your lease contract, you must first create all fiscal periods between your Contract Start Date and your Contract End Date. Workday can't generate the expense recognition schedule for your lease contract without the necessary fiscal periods.   
Enter a new payment amount for your amendment   
You can only create lease amendments for lease-type supplier contracts.   
You can't amend a variable payment amount when the lease-type supplier contract uses a fixed payment type.   
You can't amend multicompany lease-type supplier contracts.   
Remove the amended lease-type supplier contract. You can only amend a lease-type supplier contract once.   
The payment dates you submit with your Lease Payment Information lines must be unique.   
You can't change payment dates on your contract when the payment date is after the payment effective date of your amendment and before the end date of your original lease-type supplier contract.   
You must submit a total of [number of payments] Lease Payment Information lines to match the number of lines calculated using your payment effective date and contract end date.   
top
 

Supplier_ContractObject

part of: Supplier_Contract_Lease_Amendment_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Supplier_ContractObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Supplier_ContractObjectID

part of: Supplier_ContractObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Supplier_Contract_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Supplier_Contract_Lease_Amendment_TypeObject

part of: Supplier_Contract_Lease_Amendment_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Supplier_Contract_Lease_Amendment_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Supplier_Contract_Lease_Amendment_TypeObjectID

part of: Supplier_Contract_Lease_Amendment_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Supplier_Contract_Lease_Amendment_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Payment_TypeObject

part of: Supplier_Contract_Lease_Amendment_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Payment_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payment_TypeObjectID

part of: Payment_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payment_Type_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Lease_Details_Amendment_Data

part of: Supplier_Contract_Lease_Amendment_Data
Element that contains details specific to Lease Contract Details
 
Parameter name Type/Value Cardinality Description Validations
Interest_Rate  decimal (18, 6) >0   [0..1]  Interest Rate (%) 
Validation Description
Remove the interest rate from lease-type supplier contracts that use straight line expense.   
Your Interest Rate must be below 100   
 
Fixed_Payment_Amount  decimal (26, 6)   [0..1]  Fixed Payment Amount 
Validation Description
You can't amend the fixed payment amount when the lease-type supplier contract uses a variable payment type.   
 
top
 

Lease_Payment_Line_Replacement_Data

part of: Supplier_Contract_Lease_Amendment_Data
Represents a single payment for the amount on the provided payment date. Only applies to Variable Payment lease contracts.
 
Parameter name Type/Value Cardinality Description Validations
Payment_Date  date  [1..1]  The date of the lease payment. 
Validation Description
Enter a Payment Date between the Contract Start Date and Contract End Date.   
You can't enter a variable payment that occurs before the payment effective date of the amendment.   
You can't change payment dates on your contract when the payment date is after the payment effective date of your amendment and before the end date of your original lease-type supplier contract.   
You can only enter payment dates that are after the end date of the original contract when the amendment type is a lease extension.   
 
Amount  decimal (26, 6)   [0..1]  The payment amount for this lease payment line. 
Validation Description
Amount cannot be negative.   
 
top
 

Alternate_Contract_Interest_Rate_Data

part of: Supplier_Contract_Lease_Amendment_Data
Alternate Contract(s) Reference for Interest Rate Modification
 
Parameter name Type/Value Cardinality Description Validations
Alternate_Supplier_Contract_ID  string  [1..1]  Alternate Supplier Lease Contract Reference for Lease Contract Amendment 
Validation Description
Please enter a valid alternate contract associated with your lease type supplier contract.   
 
Interest_Rate  decimal (18, 6) >0   [1..1]  Alternate Contract Interest Rate for Lease Contract Amendment 
Validation Description
Remove the interest rate from alternate lease-type supplier contracts that use straight line expense.   
 
top
 

Financials_Attachment_Data

part of: Supplier_Contract_Lease_Amendment_Data
Encapsulating element containing all Business Document Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File_Content  base64Binary  [0..1]  File content in binary format.   
Comment  string  [0..1]  Comment   
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
top
 

Supplier_Contract_AmendmentReferenceEnumeration

part of: Supplier_Contract_AmendmentObjectID
Base Type
string
top
 

Supplier_ContractReferenceEnumeration

part of: Supplier_ContractObjectID
Base Type
string
top
 

Supplier_Contract_Lease_Amendment_TypeReferenceEnumeration

part of: Supplier_Contract_Lease_Amendment_TypeObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top