Retrieve a paystub
curl --request GET \
--url https://api-sandbox.argyle.com/v2/paystubs/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-sandbox.argyle.com/v2/paystubs/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api-sandbox.argyle.com/v2/paystubs/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.argyle.com/v2/paystubs/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.argyle.com/v2/paystubs/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.argyle.com/v2/paystubs/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/paystubs/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"id": "0187dc99-63be-bc96-51bf-af6b51d43687",
"account": "0187c66e-e7e5-811c-b006-2232f00f426a",
"payroll_document": "0186eb89-2e52-b3c5-ac6d-05e7debb2aff",
"deduction_list": [
{
"amount": "38.10",
"name": "401K",
"tax_classification": "pre_tax",
"amount_ytd": "139.70"
},
{
"amount": "25.40",
"name": "Garnishment",
"tax_classification": "post_tax",
"amount_ytd": "76.20"
},
{
"amount": "25.40",
"name": "Garnishment",
"tax_classification": "post_tax",
"amount_ytd": "101.60"
}
],
"filing_status": [
{
"type": "federal",
"location": null,
"status": "married filing separately"
},
{
"type": "state",
"location": "NY",
"status": "married filing separately"
}
],
"tax_list": [
{
"amount": "88.91",
"name": "Federal Withholding",
"type": "federal",
"amount_ytd": "850.99"
},
{
"amount": "139.72",
"name": "Social Security Tax",
"type": "fica",
"amount_ytd": "381.04"
}
],
"status": "completed",
"paystub_date": "2023-03-12T00:00:00Z",
"paystub_period": {
"start_date": "2023-02-28T00:00:00Z",
"end_date": "2023-03-07T00:00:00Z"
},
"currency": "USD",
"gross_pay": "1607.63",
"deductions": "88.90",
"taxes": "228.63",
"net_pay": "1290.10",
"reimbursements": "0.00",
"hours": "49.60",
"fees": null,
"net_pay_ytd": "12714.18",
"gross_pay_ytd": "15730.10",
"employer": "Whole Goods",
"employment": "0186a27d-e5c6-735a-a359-6315b34d544c",
"employer_address": {
"city": "New York",
"line1": "852 North W St",
"line2": "Apt 221",
"state": "NY",
"country": "US",
"postal_code": "10014"
},
"created_at": "2023-03-13T19:53:57.122Z",
"updated_at": "2023-03-13T19:53:57.122Z",
"destinations": [
{
"reference": "CHECKING *********2201",
"amount": "1290.10",
"method": "direct deposit",
"ach_deposit_account": {
"bank_name": "NW Regional",
"routing_number": null,
"account_number": "*********2201"
},
"card": null
}
],
"hours_ytd": "422.00",
"deductions_ytd": "533.40",
"taxes_ytd": "2502.17",
"gross_pay_list": [
{
"name": "Regular",
"type": "base",
"start_date": "2023-02-28",
"end_date": "2023-03-07",
"rate": "25.6088",
"hours": "49.5977",
"amount": "1270.14",
"hours_ytd": "422.0000",
"amount_ytd": "13971.54"
},
{
"name": "Commission",
"type": "commission",
"start_date": "2023-03-04",
"end_date": "2023-03-04",
"rate": null,
"hours": null,
"amount": "337.49",
"hours_ytd": null,
"amount_ytd": "1758.56"
}
],
"gross_pay_list_totals": {
"base": {
"amount": "1270.14",
"amount_ytd": "13971.54",
"hours": "49.5977",
"hours_ytd": "422.0000",
"rate_implied": "25.6100",
"rate_implied_ytd": "33.1100"
},
"overtime": null,
"commission": {
"amount": "337.49",
"amount_ytd": "1758.56",
"hours": null,
"hours_ytd": null,
"rate_implied": null,
"rate_implied_ytd": null
},
"bonus": null,
"other": null
},
"metadata": null
}Paystubs
Retrieve A Paystub
Retrieves a paystub object.
GET
/
v2
/
paystubs
/
{id}
Retrieve a paystub
curl --request GET \
--url https://api-sandbox.argyle.com/v2/paystubs/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-sandbox.argyle.com/v2/paystubs/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api-sandbox.argyle.com/v2/paystubs/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.argyle.com/v2/paystubs/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.argyle.com/v2/paystubs/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.argyle.com/v2/paystubs/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/paystubs/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"id": "0187dc99-63be-bc96-51bf-af6b51d43687",
"account": "0187c66e-e7e5-811c-b006-2232f00f426a",
"payroll_document": "0186eb89-2e52-b3c5-ac6d-05e7debb2aff",
"deduction_list": [
{
"amount": "38.10",
"name": "401K",
"tax_classification": "pre_tax",
"amount_ytd": "139.70"
},
{
"amount": "25.40",
"name": "Garnishment",
"tax_classification": "post_tax",
"amount_ytd": "76.20"
},
{
"amount": "25.40",
"name": "Garnishment",
"tax_classification": "post_tax",
"amount_ytd": "101.60"
}
],
"filing_status": [
{
"type": "federal",
"location": null,
"status": "married filing separately"
},
{
"type": "state",
"location": "NY",
"status": "married filing separately"
}
],
"tax_list": [
{
"amount": "88.91",
"name": "Federal Withholding",
"type": "federal",
"amount_ytd": "850.99"
},
{
"amount": "139.72",
"name": "Social Security Tax",
"type": "fica",
"amount_ytd": "381.04"
}
],
"status": "completed",
"paystub_date": "2023-03-12T00:00:00Z",
"paystub_period": {
"start_date": "2023-02-28T00:00:00Z",
"end_date": "2023-03-07T00:00:00Z"
},
"currency": "USD",
"gross_pay": "1607.63",
"deductions": "88.90",
"taxes": "228.63",
"net_pay": "1290.10",
"reimbursements": "0.00",
"hours": "49.60",
"fees": null,
"net_pay_ytd": "12714.18",
"gross_pay_ytd": "15730.10",
"employer": "Whole Goods",
"employment": "0186a27d-e5c6-735a-a359-6315b34d544c",
"employer_address": {
"city": "New York",
"line1": "852 North W St",
"line2": "Apt 221",
"state": "NY",
"country": "US",
"postal_code": "10014"
},
"created_at": "2023-03-13T19:53:57.122Z",
"updated_at": "2023-03-13T19:53:57.122Z",
"destinations": [
{
"reference": "CHECKING *********2201",
"amount": "1290.10",
"method": "direct deposit",
"ach_deposit_account": {
"bank_name": "NW Regional",
"routing_number": null,
"account_number": "*********2201"
},
"card": null
}
],
"hours_ytd": "422.00",
"deductions_ytd": "533.40",
"taxes_ytd": "2502.17",
"gross_pay_list": [
{
"name": "Regular",
"type": "base",
"start_date": "2023-02-28",
"end_date": "2023-03-07",
"rate": "25.6088",
"hours": "49.5977",
"amount": "1270.14",
"hours_ytd": "422.0000",
"amount_ytd": "13971.54"
},
{
"name": "Commission",
"type": "commission",
"start_date": "2023-03-04",
"end_date": "2023-03-04",
"rate": null,
"hours": null,
"amount": "337.49",
"hours_ytd": null,
"amount_ytd": "1758.56"
}
],
"gross_pay_list_totals": {
"base": {
"amount": "1270.14",
"amount_ytd": "13971.54",
"hours": "49.5977",
"hours_ytd": "422.0000",
"rate_implied": "25.6100",
"rate_implied_ytd": "33.1100"
},
"overtime": null,
"commission": {
"amount": "337.49",
"amount_ytd": "1758.56",
"hours": null,
"hours_ytd": null,
"rate_implied": null,
"rate_implied_ytd": null
},
"bonus": null,
"other": null
},
"metadata": null
}Response
200 - application/json
ID of the payroll document object associated with this paystub.
Payment status of the paystub.
completed— Payment has been made to the user.scheduled— Payment is scheduled to be made to the user.cancelled— Payment was cancelled, and was not nor will be paid to the user.excluded— Tag used for dummy/sample/watermarked/test paystubs present in the account. May also include non-employee payment records. These paystubs are excluded when generating reports and other calculations.
Available options:
completed, scheduled, cancelled, excluded Timestamp (ISO 8601) of the payment date, sourced from the paystub.
Currency code (ISO 4217).
Employment ID. Can be used as a filter when listing paystubs.
Timestamp (ISO 8601) when the paystub object was created.
Timestamp (ISO 8601) when a property value of the paystub object most recently changed.