Service Directory > v32.1 > Financial_Management > Get_Payment_Terms
 

Operation: Get_Payment_Terms

This service operation will get Payment Terms data for the specified criteria. Data includes Payment Terms ID, Payment Terms Name, Due Days, Payment Discount Days, Payment Discount Percent, and Grace Days. The request criteria can be for specific Payment Terms based on reference(s), or Payment Terms Name (partial match ok) search criteria. If no criteria are specified, all Payment Terms will be retrieved.


@ - 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: Get_Payment_Terms_Request

Contains request reference, criteria, filter and response group for getting Payment Term data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payment_Term_Request_References  [0..1]  Payment Term Request References   
Request_Criteria [Choice]   Payment_Term_Request_Criteria  [0..1]  Payment Term Request Criteria   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Payment_Term_Response_Group  [0..1]  Payment Type Response Group   
top
 

Response Element: Get_Payment_Terms_Response

Element containing Payment Term response elements including received criteria, references, data based on criteria and grouping, and response filter
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payment_Term_Request_References  [0..1]  Payment Term Request References   
Request_Criteria  Payment_Term_Request_Criteria  [0..1]  Payment Term Request Criteria   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Payment_Term_Response_Group  [0..1]  Payment Term Response Group   
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Payment_Term_Response_Data  [0..1]  Wrapper Element that includes Payment Term Reference(s) and Payment Term Data   
top
 

Payment_Term_Request_References

part of: Get_Payment_Terms_Request, Get_Payment_Terms_Response
Payment Term Request References
 
Parameter name Type/Value Cardinality Description Validations
Payment_Term_Reference  Payment_TermsObject  [1..*]  Payment Term Reference   
top
 

Payment_TermsObject

part of: Payment_Term_Request_References, Payment_Term
 
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_TermsObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payment_TermsObjectID

part of: Payment_TermsObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payment_Terms_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_Term_Request_Criteria

part of: Get_Payment_Terms_Request, Get_Payment_Terms_Response
Payment Term Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Payment_Terms_Name  string  [0..1]  Search by Payment Terms Name. Can be a match of a partial string.   
top
 

Response_Filter

part of: Get_Payment_Terms_Request, Get_Payment_Terms_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Payment_Term_Response_Group

part of: Get_Payment_Terms_Request, Get_Payment_Terms_Response
Payment Term Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Payment_Terms_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Payment_Term_Response_Data

part of: Get_Payment_Terms_Response
Wrapper Element that includes Payment Term Reference Instance and Payment Term Data
 
Parameter name Type/Value Cardinality Description Validations
Payment_Term  Payment_Term  [0..*]  Contains data for a given Payment Term object   
top
 

Payment_Term

part of: Payment_Term_Response_Data
Element containing Payment Term reference and data
 
Parameter name Type/Value Cardinality Description Validations
Payment_Term_Reference  Payment_TermsObject  [0..1]  Payment Term Reference   
Payment_Term_Data  Payment_Terms_Data  [0..1]  Payment Term Data   
top
 

Payment_Terms_Data

part of: Payment_Term
Payment Terms Data
 
Parameter name Type/Value Cardinality Description Validations
Payment_Terms_ID  string  [0..1]  The unique identifier for the Payment Terms   
Payment_Terms_Name  string  [1..1]  Payment Terms Name 
Validation Description
Enter a unique Payment Terms Name. [name] is already in use.  The Payment Terms Name is already in use. 
 
Payment_Term_Rules_Data  Payment_Term_Rule_Data  [1..*]  The Element for the Payment Term Rule Data used in the Put/Get WWS 
Validation Description
You can't apply a cut off to Add Months as it's a required Rule Type when you select Day of Month.  You can't apply a cut off to Add Months as it's a required Rule Type when you select Day of Month. 
Select Apply Cutoff for at least 1 Due Date Rule Type when you've entered a number for Cut-Off Day.  Select Apply Cutoff for at least 1 Due Date Rule Type when you've entered a number for Cut-Off Day. 
You must have at least 1 Due Date Rule Type without Apply Cut Off.  You must have at least 1 Due Date Rule Type without Apply Cut Off. 
 
Cut-Off_Day  decimal (2, 0) >0   [0..1]  Day of the month to apply the cut-off. 
Validation Description
Enter a number that isn't greater than 30 for Cut-Off Day.   
 
Payment_Discount_Days  decimal (4, 0) >0   [0..1]  Payment Discount Days   
Payment_Discount_Percent  decimal (5, 2) >0   [0..1]  Payment Discount Percent   
Grace_Days  decimal (4, 0) >0   [0..1]  Grace Days   
top
 

Payment_Term_Rule_Data

part of: Payment_Terms_Data
The Element for the Payment Term Rule Data used in the Put/Get WWS
 
Parameter name Type/Value Cardinality Description Validations
Payment_Term_Rule_ID  string  [0..1]  The reference ID instance.   
Payment_Term_Rule_Reference  Payment_Terms_RuleObject  [0..*]  Payment Terms Rule instance   
Order  string (6)   [1..1]  The order in which the rule is to be processed.   
Payment_Rule_Type_Reference  Payment_Terms_Rule_TypeObject  [1..1]  The rule type. Can be 1 of the these: - Add Days - Add Month - Day of Month - End of Month 
Validation Description
You must use [rule_types_required] with [current_rule_type].   
You can't select [previous_rule_type] before [current_rule_type] on the Due Date Rule order.   
You can't select 2 consecutive [current_rule_type] rule types.   
 
Rule_Modifier_Value  decimal (4, 0) >0   [0..1]  The numeric value to select for a specific rule type. 
Validation Description
Enter a number other than zero for [current_rule_type].   
Enter a number from 1 through [rule_modifier_max_value] for [current_rule_type].   
 
Apply_Cut-Off_Condition  boolean  [0..1]  Apply the cut-off condition to the specific rule type. 
Validation Description
Clear Apply Cut-Off for the Day of Month Rule Type.  Clear Apply Cut-Off for the Day of Month Rule Type. 
Do not Apply Cut-Off without specifying a Cut-Off Day.  Do not Apply Cut-Off without specifying a Cut-Off Day. 
 
top
 

Payment_Terms_RuleObject

part of: Payment_Term_Rule_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_Terms_RuleObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payment_Terms_RuleObjectID

part of: Payment_Terms_RuleObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payment_Terms_Rule_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_Terms_Rule_TypeObject

part of: Payment_Term_Rule_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_Terms_Rule_TypeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payment_Terms_Rule_TypeObjectID

part of: Payment_Terms_Rule_TypeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payment_Terms_Rule_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_TermsReferenceEnumeration

part of: Payment_TermsObjectID
Base Type
string
top
 

Payment_Terms_RuleReferenceEnumeration

part of: Payment_Terms_RuleObjectID
Base Type
string
top
 

Payment_Terms_Rule_TypeReferenceEnumeration

part of: Payment_Terms_Rule_TypeObjectID
Base Type
string
top