yearendforms
API resource to retrieve year end form details for an employee.
Method: GET
Path:/yearendforms/{fromDate}
This end point retrieves year end report details for the employee, for a given date.
| Request Parameters | Description |
|---|---|
|
fromDate |
From date. |
| Response Parameters | Response Result Type | Description |
|---|---|---|
|
taxformidOut |
Success |
Tax form ID out. Description of the year end tax form (for example, W-2). |
|
titleValue |
Success |
Title value (year end form details, such as company and date). |
|
headerValue |
Success |
Header value (year end form details, such as tax form issue date, description, and so forth). |
|
urlDetails |
Success |
URL details. URL to download PDF version of year end forms. |
|
buttonDescr |
Success |
Button description (button label in Digital Assistant). |
|
consentForm |
Success |
Consent form flag. |
Method: GET
Path: /yearendforms/{fromDate}/{taxformID}
This end point retrieves employee year end forms for the given date and for a particular tax form ID.
| Request Parameters | Description |
|---|---|
|
fromDate |
From date. |
|
taxformID |
Tax form ID |
| Response Parameters | Response Result Type | Description |
|---|---|---|
|
taxformidOut |
Success |
Tax form ID out. Description of the year end tax form (for example, W-2). |
|
titleValue |
Success |
Title value (year end form details, such as company and date). |
|
headerValue |
Success |
Header value (year end form details, such as tax form issue date, description, and so forth). |
|
urlDetails |
Success |
URL details. URL to download PDF version of year end forms. |
|
buttonDescr |
Success |
Button description (button label in Digital Assistant). |
|
consentForm |
Success |
Consent form flag. |
Method: GET
Path: /yearendforms/{fromDate}/{taxformID}/{formAvailability}
This end point retrieves year end availability date for a given tax form ID and for a given date.
| Request Parameters | Description |
|---|---|
|
formAvailability |
Tax form availability. |
|
fromDate |
From date. |
|
taxformID |
Tax form ID. |
| Response Parameters | Response Result Type | Description |
|---|---|---|
|
taxformidOut |
Success |
Tax form ID out. Description of the year end tax form (for example, W-2). |
|
titleValue |
Success |
Title value (year end form details, such as company and date). |
|
headerValue |
Success |
Header value (year end form details, such as tax form issue date, description, and so forth). |
|
urlDetails |
Success |
URL details. URL to download PDF version of year end forms. |
|
buttonDescr |
Success |
Button description (button label in Digital Assistant). |
|
consentForm |
Success |
Consent form flag. |
Method: GET
Path: /yearendforms/{fromDate}/{taxformID}/ConsentCheck/{consentAvailability}
This end point retrieves consent availability for year end forms for the employee for the given date and tax form ID.
| Request Parameters | Description |
|---|---|
|
consentAvailability |
Consent form availability. |
|
fromDate |
From date. |
|
taxformID |
Tax form ID. |
| Response Parameters | Response Result Type | Description |
|---|---|---|
|
taxformidOut |
Success |
Tax form ID out. Description of the year end tax form (for example, W-2). |
|
titleValue |
Success |
Title value (year end form details, such as company and date). |
|
headerValue |
Success |
Header value (year end form details, such as tax form issue date, description, and so forth). |
|
urlDetails |
Success |
URL details. URL to download PDF version of year end forms. |
|
buttonDescr |
Success |
Button description (button label in Digital Assistant). |
|
consentForm |
Success |
Consent form flag. |
Method: GET
Path: /yearendforms/{fromDate}/{taxformID}/{formAvailability}/{consentAvailability}/{countFilter}/{searchText}
This end point retrieves year end forms details or consent details or availability date details for a given date and taxform id or based on forms count.
| Request Parameters | Description |
|---|---|
|
consentAvailability |
Consent form availability. |
|
countFilter |
Count filter. |
|
formAvailability |
Form availability. |
|
fromDate |
From date. |
|
searchText |
Search text. |
|
taxformID |
Tax form ID. |
| Response Parameters | Response Result Type | Description |
|---|---|---|
|
taxformidOut |
Success |
Tax form ID out. Description of the year end tax form (for example, W-2). |
|
titleValue |
Success |
Title value (year end form details, such as company and date). |
|
headerValue |
Success |
Header value (year end form details, such as tax form issue date, description, and so forth). |
|
urlDetails |
Success |
URL details. URL to download PDF version of year end forms. |
|
buttonDescr |
Success |
Button description (button label in Digital Assistant). |
|
consentForm |
Success |
Consent form flag. |