Service Directory > v31.2 > Financial_Management > Get_Company_Tax_Details
 

Operation: Get_Company_Tax_Details

Web Service to get Company Tax Details, include Tax ID Data.


@ - 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_Company_Tax_Details_Request

Get Company Tax Details Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Company_Tax_Details_Request_References  [0..1]  Company Tax Details Request References   
Response_Filter  Response_Filter  [0..1]  Company Tax Details Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Company_Tax_Details_Response_Group  [0..1]  Company Tax Details Response Group   
top
 

Response Element: Get_Company_Tax_Details_Response

Get Company Tax Details Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Company_Tax_Details_Request_References  [0..1]  Company Tax Details Request References   
Response_Filter  Response_Filter  [0..1]  Get Company Tax Details Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Company_Tax_Details_Response_Group  [0..1]  Get Company Tax Details Response Group   
Response_Results  Response_Results  [0..1]  Get Company Tax Details Response Results   
Response_Data  Company_Tax_Details_Response_Data  [0..1]  Get Company Tax Details Response Data   
top
 

Company_Tax_Details_Request_References

part of: Get_Company_Tax_Details_Request, Get_Company_Tax_Details_Response
Company Tax Details Request References
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..*]  Company Tax Details Request References   
top
 

CompanyObject

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

CompanyObjectID

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

Response_Filter

part of: Get_Company_Tax_Details_Request, Get_Company_Tax_Details_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
 

Company_Tax_Details_Response_Group

part of: Get_Company_Tax_Details_Request, Get_Company_Tax_Details_Response
Company Tax Details Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Company Tax Details Response Group Include Reference   
top
 

Response_Results

part of: Get_Company_Tax_Details_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
 

Company_Tax_Details_Response_Data

part of: Get_Company_Tax_Details_Response
Company Tax Details Response Data
 
Parameter name Type/Value Cardinality Description Validations
Company_Tax_Details  Company_Tax_Details  [0..*]  Company Tax Details   
top
 

Company_Tax_Details

part of: Company_Tax_Details_Response_Data
Company Tax Details
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..1]  Company Reference   
Company_Tax_Details_Data  Company_Tax_Details_Data  [0..1]  Company Tax Details Data 
Validation Description
You can't edit or delete the Tax ID; the Company is part of a UK Employer Reference for UK Payroll.   
You can only use value added tax on payments for single legal entities and free-standing companies.   
 
top
 

Company_Tax_Details_Data

part of: Company_Tax_Details
Company Tax Details Data
 
Parameter name Type/Value Cardinality Description Validations
Company_ID  string  [0..1]  Company ID 
Validation Description
Company Reference is missing or does not exist for the specified Tax ID(s). Enter a valid Company Reference.  Exception: Company Reference is missing or doesn't exist for the specified Tax ID(s). Enter a valid Company Reference. 
 
Tax_ID_Data  Tax_ID_Data  [0..*]  Tax ID Data 
Validation Description
Transaction Tax ID can only be selected when the Tax ID Type is selected as a Transaction Tax ID. Otherwise it must be blank.  Transaction Tax ID can only be selected when the Tax ID Type is selected as a Transaction Tax ID. Otherwise it must be blank. 
Enter the Identification # for the Transaction Tax ID.  Enter the Identification # for the Transaction Tax ID. 
You can only select 1 Transaction Tax ID for a country. Unselect the Transaction Tax ID check box for the Tax IDs that you don't want to use for recording transaction tax.  You can only select 1 Transaction Tax ID for a country. Unselect the Transaction Tax ID check box for the Tax IDs that you don't want to use for recording transaction tax. 
You can only have 1 Primary Tax ID.  You can only have 1 Primary Tax ID. 
You can only select the Tax ID Type once for a Country.  You can only select the Tax ID Type once for a Country. 
Tax ID Type cannot be used for a [businessEntityType]  The Tax ID Type selected for this Tax ID cannot be used in this webservice. 
The Country has conflicting Tax ID Types. Select 1 of these Tax ID Types for the Country: [taxIDTypes].  The Tax ID Type used is mutually exclusive with other Tax ID Types in the set. Only one can be used for the country. 
You can't change or delete tax IDs when they are in use on taxable documents. Delete the taxable documents or enter these tax IDs: [tax id]   
If HMRC Office Number, Employer PAYE Reference, or Employer Accounts Office Reference Number is defined, the three Tax IDs need to be defined.   
 
Tax_Status_Data  Tax_Status_Data  [0..*]  Tax Status Data element to specify 1 or more Tax Statuses for a company. 
Validation Description
Select a Transaction Tax Status or Withholding Tax Status for the Country.   
The selected Country is already in use.   
 
Company_Tax_Recovery_Pro_Rata_Factor_Percentage  decimal (8, 5) >0   [0..1]  Workday uses the Tax Recovery Pro Rata Factor Percentage to reduce the tax recoverability amount on transactions for this company. The value ranges from 0 to 1 with 3 decimal places of precision. Set to 1 in order to use the full amount (100%) of the calculated tax recoverability. There is no tax recoverability on transactions for this company if you don't specify a value or set it to 0. 
Validation Description
Value must be between 0 and 1  Value must be between 0 and 1 
 
VAT_on_Payment  boolean  [0..1]  VAT on Payment, set to true for VAT on Payment option for Company, otherwise set to false.   
Default_Tax_Applicability_Reference  Tax_ApplicabilityObject  [0..1]  Used for posting tax in payment transaction that aren't related to an invoice. 
Validation Description
Default Tax Applicability can only be set if the VAT (value added tax) on Payment option is selected.  Default Tax Applicability can only be set if the VAT (value added tax) on Payment option is selected. 
 
Default_Tax_Code_Reference  Tax_CodeObject  [0..1]  Used in tax calculation for payment transactions that aren't related to an invoice. 
Validation Description
Default Tax Code can only be set if the VAT (value added tax) on Payment option is selected.  Default Tax Code can only be set if the VAT (value added tax) on Payment option is selected. 
 
Validation Description
You can't edit or delete the Tax ID; the Company is part of a UK Employer Reference for UK Payroll.   
You can only use value added tax on payments for single legal entities and free-standing companies.   
top
 

Tax_ID_Data

part of: Company_Tax_Details_Data
Tax ID Data element to specify 1 or more Tax IDs for a company.
 
Parameter name Type/Value Cardinality Description Validations
Tax_ID_Text  string  [0..1]  Enter the Tax ID value for the respective Tax Type. 
Validation Description
Invalid HMRC Office Number. HMRC Office Number must be 3 characters, numeric and in the range 001 – 999. Where applicable, leading zeroes must be present.   
Invalid Employer PAYE Reference number. Employer PAYE Reference must not exceed 10 characters, and must contain only alpha-numeric or special characters.   
Invalid Employer Accounts Office Reference number: Characters 1-3 of Employer Accounts Office Reference number must be numeric. Character 4 of Employer Accounts Office Reference number must be 'P'. Character 5 of Employer Accounts Office Reference number must be alpha. Characters 6-12 of Employer Accounts Office Reference number must be numeric. Last digit of Employer Accounts Office Reference number must be numeric or ‘X’.   
Invalid ECON. ECON is nine characters in length and is formatted as follows: 1. Character 1 must be alpha - "E". 2. Characters 2 - 8 must be numeric in the range 3000000 - 3999999. 3. Character 9 must be Alpha. 4. The 9th character must pass the modulus 19 check. 5. Character 9 may not be "G", "I", "O", "S", "U", "V" or "Z".   
 
Tax_ID_Type_Reference  Tax_ID_TypeObject  [0..1]  Enter the Tax Type tied to the Tax ID value entered.   
Transaction_Tax_ID  boolean  [0..1]  Indicates if the Tax ID is used as the Transaction Tax ID for the country.   
Primary_Tax_ID  boolean  [0..1]  Indicates if the Tax ID is used as the Primary Tax ID.   
Validation Description
Transaction Tax ID can only be selected when the Tax ID Type is selected as a Transaction Tax ID. Otherwise it must be blank.  Transaction Tax ID can only be selected when the Tax ID Type is selected as a Transaction Tax ID. Otherwise it must be blank. 
Enter the Identification # for the Transaction Tax ID.  Enter the Identification # for the Transaction Tax ID. 
You can only select 1 Transaction Tax ID for a country. Unselect the Transaction Tax ID check box for the Tax IDs that you don't want to use for recording transaction tax.  You can only select 1 Transaction Tax ID for a country. Unselect the Transaction Tax ID check box for the Tax IDs that you don't want to use for recording transaction tax. 
You can only have 1 Primary Tax ID.  You can only have 1 Primary Tax ID. 
You can only select the Tax ID Type once for a Country.  You can only select the Tax ID Type once for a Country. 
Tax ID Type cannot be used for a [businessEntityType]  The Tax ID Type selected for this Tax ID cannot be used in this webservice. 
The Country has conflicting Tax ID Types. Select 1 of these Tax ID Types for the Country: [taxIDTypes].  The Tax ID Type used is mutually exclusive with other Tax ID Types in the set. Only one can be used for the country. 
You can't change or delete tax IDs when they are in use on taxable documents. Delete the taxable documents or enter these tax IDs: [tax id]   
If HMRC Office Number, Employer PAYE Reference, or Employer Accounts Office Reference Number is defined, the three Tax IDs need to be defined.   
top
 

Tax_ID_TypeObject

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

Tax_ID_TypeObjectID

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

Tax_Status_Data

part of: Company_Tax_Details_Data
Tax Status Data element to specify 1 or more Tax Statuses for a company.
 
Parameter name Type/Value Cardinality Description Validations
Tax_Status_Reference  Unique_IdentifierObject  [0..1]  Tax Status Reference   
Country_Reference  CountryObject  [1..1]  Country for Tax Status   
Transaction_Tax_Status_Reference  Transaction_Tax_StatusObject  [0..1]  Company's Transaction Tax Status for the country.   
Withholding_Tax_Status_Reference  Withholding_Tax_StatusObject  [0..1]  Company's Withholding Tax Status for the country.   
Validation Description
Select a Transaction Tax Status or Withholding Tax Status for the Country.   
The selected Country is already in use.   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [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
 

Transaction_Tax_StatusObject

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

Transaction_Tax_StatusObjectID

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

Withholding_Tax_StatusObject

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

Withholding_Tax_StatusObjectID

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

Tax_ApplicabilityObject

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

Tax_ApplicabilityObjectID

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

Tax_CodeObject

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

Tax_CodeObjectID

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

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Tax_ID_TypeReferenceEnumeration

part of: Tax_ID_TypeObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Transaction_Tax_StatusReferenceEnumeration

part of: Transaction_Tax_StatusObjectID
Base Type
string
top
 

Withholding_Tax_StatusReferenceEnumeration

part of: Withholding_Tax_StatusObjectID
Base Type
string
top
 

Tax_ApplicabilityReferenceEnumeration

part of: Tax_ApplicabilityObjectID
Base Type
string
top
 

Tax_CodeReferenceEnumeration

part of: Tax_CodeObjectID
Base Type
string
top