Service Directory > v32.1 > Payroll > Get_Periodic_Company_CAN_Tax_Remittance_Data
 

Operation: Get_Periodic_Company_CAN_Tax_Remittance_Data

This web service operation retrieves the periodic tax remittance data for a company. The tax remittance data is aggregated by Payment Date and Tax Account Number and Deduction Code.


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

Get Periodic Company CAN Tax Remittance Data Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Periodic_CAN_Tax_Remittance_Data_Request_Criteria  [1..1]  Request Criteria for Periodic Company CAN Tax Remittance Data 
Validation Description
None of the Pay Groups selected belongs to the Company selected. Please select a new set of Pay Groups from within the specified Company.   
The provided Company is not registered as a Canadian Company, please enter a correct Canadian Company value.   
 
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  Periodic_CAN_Tax_Remittance_Data_Response_Group  [0..1]  Response Group for Periodic Company CAN Tax Remittance   
top
 

Response Element: Get_Periodic_Company_CAN_Tax_Remittance_Data_Response

Get Periodic Company CAN Tax Remittance Data Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Periodic_CAN_Tax_Remittance_Data_Request_Criteria  [1..1]  Request Criteria for Periodic Company CAN Tax Remittance Data 
Validation Description
None of the Pay Groups selected belongs to the Company selected. Please select a new set of Pay Groups from within the specified Company.   
The provided Company is not registered as a Canadian Company, please enter a correct Canadian Company value.   
 
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  Periodic_CAN_Tax_Remittance_Data_Response_Group  [0..1]  Response Group for Periodic Company CAN Tax Remittance   
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  Periodic_Company_CAN_Tax_Remittance_Data_Response_Data  [0..1]  Periodic Company CAN Tax Remittance Data Response Data element   
top
 

Periodic_CAN_Tax_Remittance_Data_Request_Criteria

part of: Get_Periodic_Company_CAN_Tax_Remittance_Data_Request, Get_Periodic_Company_CAN_Tax_Remittance_Data_Response
Request Criteria for Periodic Company CAN Tax Remittance Data
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..1]  Company selected for tax remittance data.   
Include_Related_Companies_for_Legal_Entity  boolean  [0..1]  If the requested company is a single legal entity, the response will include results from other companies in the relationship when this flag is true.   
Result_Completed_From  dateTime  [0..1]  Start Date Time stamp for when payroll results were completed as part of the selection criteria.   
Result_Completed_To  dateTime  [0..1]  End Date Time stamp for when payroll results were completed as part of the selection criteria.   
Pay_Group_Reference  Pay_GroupObject  [0..*]  Valid Pay Groups for selected Company.   
Period_Reference  PeriodObject  [0..*]  Valid Periods for selected Company and Pay Groups.   
Include_WCB  boolean  [0..1]  If 1 is provided, then the WCB information is included in the response. If 0 is provided WCB information is excluded from the response   
Payment_Date  date  [0..1]  Payment Date.   
Validation Description
None of the Pay Groups selected belongs to the Company selected. Please select a new set of Pay Groups from within the specified Company.   
The provided Company is not registered as a Canadian Company, please enter a correct Canadian Company value.   
top
 

CompanyObject

part of: Periodic_CAN_Tax_Remittance_Data_Request_Criteria, Periodic_Company_CAN_Tax_Remittance_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  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
 

Pay_GroupObject

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

Pay_GroupObjectID

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

PeriodObject

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

PeriodObjectID

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

Periodic_CAN_Tax_Remittance_Data_Response_Group

part of: Get_Periodic_Company_CAN_Tax_Remittance_Data_Request, Get_Periodic_Company_CAN_Tax_Remittance_Data_Response
Response Group for Periodic Company CAN Tax Remittance
 
Parameter name Type/Value Cardinality Description Validations
Include_MTD_Data  boolean  [0..1]  Indicate whether MTD Data element will be included in the response.   
Include_QTD_Data  boolean  [0..1]  Indicate whether QTD Data element will be included in the response.   
Include_YTD_Data  boolean  [0..1]  Indicate whether YTD Data element will be included in the response.   
top
 

Response_Results

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

Periodic_Company_CAN_Tax_Remittance_Data_Response_Data

part of: Get_Periodic_Company_CAN_Tax_Remittance_Data_Response
Periodic Company CAN Tax Remittance Data Response Data element
 
Parameter name Type/Value Cardinality Description Validations
Periodic_Company_CAN_Tax_Remittance_Data  Periodic_Company_CAN_Tax_Remittance_Data  [0..*]  Periodic Company CAN Tax Remittance Data element   
top
 

Periodic_Company_CAN_Tax_Remittance_Data

part of: Periodic_Company_CAN_Tax_Remittance_Data_Response_Data
Periodic Company CAN Tax Remittance Data element
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..1]  Company Reference   
Period_End_Date  date  [0..1]  Period End Date. If the Tax Data includes multiple periods having the same payment date, the date returned for this attribute will be the End Date of the latest period included in the results.   
Payment_Date  date  [0..1]  Payment Date.   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference.   
Payroll_Tax_Authority_Reference  Metadata_Payroll_WorktagObject  [0..1]  Payroll Tax Authority Reference.   
Payroll_Tax_Account_Number  string  [0..1]  Payroll Tax Account Number for the Tax Authority.   
WCB_Classification_Code_Reference  Workers_Compensation_CodeObject  [0..1]  Element containing reference instance for a Workers' Compensation Code   
WCB_Payroll_Report_Id  string  [0..1]  Element for Workers Compensation Payroll Report Id   
WCB_E_Banking_Number  string  [0..1]  Element for Workers Compensation E Banking Number   
Number_Employees_Paid_Last_Period  decimal (12, 0) >0   [0..1]  Count of workers whose wages are reported for this tax authority in the last pay Period being reported   
Pay_Group_Data  Periodic_Company_Tax_Filing_Pay_Group_Data  [0..*]  Pay Group Data element containing Pay Group References.   
Period_Reference  PeriodObject  [0..*]  Pay Period Reference.   
Employer_Paid  boolean  [0..1]  Indicates whether the deduction is paid by the employer (vs. paid the employee).   
Deduction_Reference  Payroll_CalculationObject  [0..1]  Deduction Reference.   
Tax_Filing_Code  string  [0..1]  Concatenated Code: Deduction Code + Payroll Tax Authority Code.   
Tax_Rate  decimal (9, 6) >0   [0..1]  Element for EHT Tax Rate   
WCB_Tax_Rate  decimal (9, 6) >0   [0..1]  Workers Compensation Tax Rate   
Tax_Withheld  decimal (26, 6)   [0..1]  Tax Withheld Amount for the Pay Period.   
Taxable_Wages  decimal (26, 6)   [0..1]  Taxable Wages Amount for the Pay Period.   
Subject_Wages  decimal (26, 6)   [0..1]  Subject Wages Amount for the Pay Period.   
Exempt_Wages  decimal (26, 6)   [0..1]  Exempt Wages Amount for the Pay Period.   
WCB_Insurable_Wages  decimal (22, 2)   [0..1]  Element for Workers Compensation Insurable Wages   
WCB_Gross_Wages  decimal (22, 2)   [0..1]  Element for Workers Compensation Gross Wages   
WCB_Other_Wages  decimal (22, 2)   [0..1]  Element for Workers Compensation Other Wages   
WCB_Excess_Wages  decimal (22, 2)   [0..1]  Element for Workers Compensation Excess Wages   
MTD_Data  MTD_Tax_Remittance_Data_for_Periodic_Company  [0..1]  Month to date data for the deduction for Tax_Withheld, Taxable_Wages, Subject_Wages and Exempt_Wages   
QTD_Data  QTD_Tax_Remittance_Data_for_Periodic_Company  [0..1]  Quarter to date data for the deduction for Tax_Withheld, Taxable_Wages, Subject_Wages and Exempt_Wages   
YTD_Data  YTD_Tax_Remittance_Data_for_Periodic_Company  [0..1]  Year to date data for the deduction for Tax_Withheld, Taxable_Wages, Subject_Wages and Exempt_Wages   
top
 

CurrencyObject

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

CurrencyObjectID

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

Metadata_Payroll_WorktagObject

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

Metadata_Payroll_WorktagObjectID

part of: Metadata_Payroll_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, NI_Category_Letter, Payroll_Federal_Authority_Tax_Code, Payroll_Income_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code, Rubric_Value_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
 

Workers_Compensation_CodeObject

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

Workers_Compensation_CodeObjectID

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

Periodic_Company_Tax_Filing_Pay_Group_Data

part of: Periodic_Company_CAN_Tax_Remittance_Data
Pay Group Data element for Pay Group Rerences
 
Parameter name Type/Value Cardinality Description Validations
Pay_Group_Reference  Pay_GroupObject  [0..1]  Pay Group Reference   
top
 

Payroll_CalculationObject

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

Payroll_CalculationObjectID

part of: Payroll_CalculationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Deduction_Code, Earning_Code, Pay_Accumulation_Code, Pay_Balance_Code, Pay_Component_Group_Code, Pay_Component_Related_Calculation_Code, Workday_Deduction_Code, Workday_Earning_Code, Workday_Pay_Accumulation_Code, Workday_Pay_Balance_Code, Workday_Pay_Component_Group_Code, Workday_Pay_Component_Related_Calculation_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
 

MTD_Tax_Remittance_Data_for_Periodic_Company

part of: Periodic_Company_CAN_Tax_Remittance_Data
MTD Tax Remittance Data for Periodic Company
 
Parameter name Type/Value Cardinality Description Validations
Tax_Withheld  decimal (26, 6)   [0..1]  MTD Tax Withheld Amount   
Taxable_Wages  decimal (26, 6)   [0..1]  MTD Taxable Wages Amount   
Subject_Wages  decimal (26, 6)   [0..1]  MTD Subject Wages Amount   
Exempt_Wages  decimal (26, 6)   [0..1]  MTD Exempt Wages Amount   
WCB_Insurable_Wages  decimal (26, 6)   [0..1]  Element for MTD Workers Compensation Insurable Wages   
WCB_Gross_Wages  decimal (26, 6)   [0..1]  Element for MTD Workers Compensation Gross Wages   
WCB_Other_Wages  decimal (26, 6)   [0..1]  Element for MTD Workers Compensation Other Wages   
WCB_Excess_Wages  decimal (26, 6)   [0..1]  Element for MTD Workers Compensation Excess Wages   
top
 

QTD_Tax_Remittance_Data_for_Periodic_Company

part of: Periodic_Company_CAN_Tax_Remittance_Data
QTD Tax Remittance Data for Periodic Company
 
Parameter name Type/Value Cardinality Description Validations
Tax_Withheld  decimal (26, 6)   [0..1]  QTD Tax Withheld Amount   
Taxable_Wages  decimal (26, 6)   [0..1]  QTD Taxable Wages Amount   
Subject_Wages  decimal (26, 6)   [0..1]  QTD Subject Wages Amount   
Exempt_Wages  decimal (26, 6)   [0..1]  QTD Exempt Wages Amount   
WCB_Insurable_Wages  decimal (26, 6)   [0..1]  Element for QTD Workers Compensation Insurable Wages   
WCB_Gross_Wages  decimal (26, 6)   [0..1]  Element for QTD Workers Compensation Gross Wages   
WCB_Other_Wages  decimal (26, 6)   [0..1]  Element for QTD Workers Compensation Other Wages   
WCB_Excess_Wages  decimal (26, 6)   [0..1]  Element for QTD Workers Compensation Excess Wages   
top
 

YTD_Tax_Remittance_Data_for_Periodic_Company

part of: Periodic_Company_CAN_Tax_Remittance_Data
YTD Tax Remittance Data for Periodic Company
 
Parameter name Type/Value Cardinality Description Validations
Tax_Withheld  decimal (26, 6)   [0..1]  YTD Tax Withheld Amount   
Taxable_Wages  decimal (32, 6)   [0..1]  YTD Taxable Wages Amount   
Subject_Wages  decimal (26, 6)   [0..1]  YTD Subject Wages Amount   
Exempt_Wages  decimal (26, 6)   [0..1]  YTD Exempt Wages Amount   
WCB_Insurable_Wages  decimal (26, 6)   [0..1]  Element for YTD Workers Compensation Insurable Wages   
WCB_Gross_Wages  decimal (26, 6)   [0..1]  Element for YTD Workers Compensation Gross Wages   
WCB_Other_Wages  decimal (26, 6)   [0..1]  Element for YTD Workers Compensation Other Wages   
WCB_Excess_Wages  decimal (36, 6)   [0..1]  YTD Workers Compensation Excess Wages   
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Pay_GroupReferenceEnumeration

part of: Pay_GroupObjectID
Base Type
string
top
 

PeriodReferenceEnumeration

part of: PeriodObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Metadata_Payroll_WorktagReferenceEnumeration

part of: Metadata_Payroll_WorktagObjectID
Base Type
string
top
 

Workers_Compensation_CodeReferenceEnumeration

part of: Workers_Compensation_CodeObjectID
Base Type
string
top
 

Payroll_CalculationReferenceEnumeration

part of: Payroll_CalculationObjectID
Base Type
string
top