--- title: "Retrieve a payroll" url: "https://docs.unified.to/hris/payroll/Retrieve_a_payroll" description: "Retrieve a payroll with Unified's Payroll API (GET /hris/{connection_id}/payroll/{id}). Filter by fields and raw. Supported by 5 Payroll integrations." --- # Retrieve a payroll GET/hris/{connection\_id}/payroll/{id} ## Parameters **fields**string array id created\_at updated\_at company\_id group\_id status type start\_at end\_at paid\_at approved\_at currency gross\_amount net\_amount employee\_tax\_amount employer\_tax\_amount deduction\_amount employer\_contribution\_amount total\_cost\_amount user\_ids payslip\_ids 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 Payroll ## Returns [HrisPayroll](https://docs.unified.to/hris/payroll/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) | | group\_id | string | No | the pay group (hris\_group of type PAY\_GROUP) (reference to HrisGroup) | | status | enum | No | Values: DRAFT, PENDING, APPROVED, PROCESSING, PAID, FAILED, CANCELLED | | type | enum | No | Values: REGULAR, OFF\_CYCLE, BONUS, CORRECTION, TERMINATION, CONTRACTOR | | start\_at | string (date-time) | No | pay period start (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | end\_at | string (date-time) | No | pay period end (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | paid\_at | string (date-time) | No | pay/check date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | approved\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | currency | string | No | | | gross\_amount | number | No | | | net\_amount | number | No | | | employee\_tax\_amount | number | No | | | employer\_tax\_amount | number | No | | | deduction\_amount | number | No | total employee deductions | | employer\_contribution\_amount | number | No | total employer benefit contributions | | total\_cost\_amount | number | No | total company cost/debit for this payroll | | user\_ids | string\[\] | No | employees paid in this payroll | | payslip\_ids | string\[\] | 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.getHrisPayroll({ connectionId, id, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'GET', url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/payroll/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/payroll/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/payroll/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/payroll/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/payroll/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/payroll/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/payroll/5de520f96e439b002043d8d8?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```