--- title: "Retrieve a paycode" url: "https://docs.unified.to/hris/paycode/Retrieve_a_paycode" description: "Retrieve a paycode with Unified's Paycode API (GET /hris/{connection_id}/paycode/{id}). Filter by fields and raw. Supported by 3 Paycode integrations." --- # Retrieve a paycode GET/hris/{connection\_id}/paycode/{id} ## Parameters **fields**string array id created\_at updated\_at company\_id name code description type detail\_type is\_pre\_tax is\_employer is\_active raw Fields to return **raw**string Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar **connection\_id**string required ID of the connection **id**string required ID of the Paycode ## Returns [HrisPaycode](https://docs.unified.to/hris/paycode/model.md) | Response field | Type | Required | Description | | -------------- | ------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | string | No | | | created\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | company\_id | string | No | (reference to HrisCompany) | | name | string | No | | | code | string | No | the payroll system's code for this item | | description | string | No | | | type | enum | No | Values: EARNING, DEDUCTION, TAX, CONTRIBUTION, REIMBURSEMENT | | detail\_type | enum | No | the normalized payslip-line type this code produces Values: EARNING\_SALARY, EARNING\_OVERTIME, EARNING\_TIP, EARNING\_BONUS, EARNING\_COMMISSION, EARNING\_ADJUSTMENT, EARNING, PRETAX\_DEDUCTION, PRETAX\_DEDUCTION\_HEALTH\_INSURANCE, PRETAX\_DEDUCTION\_RETIREMENT, PRETAX\_DEDUCTION\_HRA, TAX\_FEDERAL, TAX\_REGION, TAX\_LOCAL, POSTTAX\_BENEFIT, POSTTAX\_GARNISHMENT, REIMBURSEMENT, EARNING\_REGULAR, EARNING\_DOUBLE\_OVERTIME, EARNING\_PTO, EARNING\_SICK, EARNING\_HOLIDAY, EARNING\_SEVERANCE, EARNING\_REIMBURSEMENT, TAX\_SOCIAL\_SECURITY, TAX\_MEDICARE, TAX\_UNEMPLOYMENT, TAX\_EMPLOYER, PRETAX\_DEDUCTION\_HSA, PRETAX\_DEDUCTION\_FSA, PRETAX\_DEDUCTION\_DEPENDENT\_CARE, PRETAX\_DEDUCTION\_COMMUTER, PRETAX\_DEDUCTION\_DENTAL, PRETAX\_DEDUCTION\_VISION, POSTTAX\_DEDUCTION, POSTTAX\_RETIREMENT\_ROTH, POSTTAX\_LOAN\_REPAYMENT, EMPLOYER\_CONTRIBUTION, PENSION | | is\_pre\_tax | boolean | No | | | is\_employer | boolean | No | | | is\_active | boolean | No | | ## Errors Errors return the HTTP status code and a JSON body with `statusCode`, `error` (the short label) and `message` (a human-readable detail). ```json { "statusCode": 429, "error": "Too Many Requests", "message": "Too many requests to unified.to API; max requests per minute: N" } ``` | Status | Error | Meaning | | ------ | --------------------- | ------------------------------------------------- | | 400 | Bad Request | The request was malformed or failed validation. | | 401 | Unauthorized | The connection is likely broken; re-authorize it. | | 403 | Forbidden | The connection is missing permissions or scopes. | | 404 | Not Found | The requested resource does not exist. | | 429 | Too Many Requests | Rate limit exceeded (see the two sources below). | | 500 | Internal Server Error | An unexpected error occurred. | | 501 | Not Implemented | Not supported by this integration. | Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message. ### 429 Too Many Requests A 429 has two possible sources: * The integration's own rate limit, passed through. * Unified's workspace limit: a rolling 60 seconds, set by plan, with the message `Too many requests to unified.to API; max requests per minute: N`. ## Code Samples ### Node.js SDK ```javascript import { UnifiedTo } from '@unified-api/typescript-sdk'; const sdk = new UnifiedTo({ security: { jwt: '', }, }); const connectionId = '5de520f96e439b002043d8dc'; const id = '1234'; const results = await sdk.hris.getHrisPaycode({ connectionId, id, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'GET', url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/paycode/5de520f96e439b002043d8d8', headers: { authorization: 'bearer .....' }, params: { fields: '', raw: '', } }; const results = await axios.request(options); ``` ### Java ```java AsyncHttpClient client = new DefaultAsyncHttpClient(); client.prepare("GET", "https://api.unified.to/hris/5de520f96e439b002043d8dc/paycode/5de520f96e439b002043d8d8?fields=&raw=") .setHeader("accept", "application/json") .setHeader("authorization", ".....") .execute() .toCompletableFuture() .thenAccept(System.out::println) .join(); client.close(); ``` ### Go ```go import ( "fmt" "net/http" "io/ioutil" ) url := `https://api.unified.to/hris/5de520f96e439b002043d8dc/paycode/5de520f96e439b002043d8d8?fields=&raw= req, _ := http.NewRequest("GET", url, nil) req.Header.Add("accept", "application/json") req.Header.Add("authorization", ".....") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) ``` ### Python ```python import requests url = "https://api.unified.to/hris/5de520f96e439b002043d8dc/paycode/5de520f96e439b002043d8d8?fields=&raw=" headers = { "accept": "application/json", "authorization": "....." } response = requests.get(url, headers=headers) ``` ### PHP ```php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://api.unified.to/hris/5de520f96e439b002043d8dc/paycode/5de520f96e439b002043d8d8?fields=&raw=", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: ....." ], ]); ``` ### Ruby ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.unified.to/hris/5de520f96e439b002043d8dc/paycode/5de520f96e439b002043d8d8?fields=&raw=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["authorization"] = '....' response = http.request(request) puts response.read_body ``` ### cURL ```bash curl --request GET \ --url 'https://api.unified.to/hris/5de520f96e439b002043d8dc/paycode/5de520f96e439b002043d8d8?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```