W2

Employee W2 Tax Data.

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/erp/hr/w2

Version: v1

Default response content-types: application/json, application/xml, application/pdf
Schemes: https

Summary

Path Operation Description
/{byu_id}* GET

Paths

GET /{byu_id}*

Specify the byu_id to get the tax years and companies where W2 data is available. Add the tax_year and company parameters to get the base64 encoded W2 PDF.

byu_id

BYU ID

path string , must match ^[0-9]{9}$ #/parameters/byu_id
tax_year

4 digit year

query string #/parameters/tax_year
company

3 character company code

query string #/parameters/company

Uses default content-types: application/json application/xml application/pdf

200 OK

Service request is OK and the data is in the response body.

w2s
204 No Content

Service request is OK and no data is available.

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

500 Internal Server Error #/responses/500

Internal Server Error

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Parameter definitions

byu_id byu_id

BYU ID

path string , must match ^[0-9]{9}$
tax_year tax_year

4 digit year

query string
company company

3 character company code

query string

Response definitions

400

Invalid Request - unable to interpret request

401

Authentication required to access data

403

Access denied to protected data

500

Internal Server Error

504

Gateway Timeout

default

Unexpected error

Schema definitions

byu_id: string , must match ^[0-9]{9}$

company: string , must match ^[A-Z]{3}$

tax_year: string , must match ^[0-9]{4}$

w2: object

byu_id: byu_id
tax_year: tax_year
company: company

w2s: object[]

w2

w2s_error: object

status: object
message: string
Service Path: 
/domains/erp/hr/w2
Domain or University API: 
D

Community

 

Don't see your question listed here? Ask!

Tags