List all payroll documents
curl --request GET \
--url https://api-sandbox.argyle.com/v2/payroll-documents \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-sandbox.argyle.com/v2/payroll-documents"
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/payroll-documents', 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/payroll-documents",
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/payroll-documents"
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/payroll-documents")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/payroll-documents")
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{
"next": "https://api-sandbox.argyle.com/v2/payroll-documents?cursor=ZXhhbXBsZV9jdXJzb3I",
"previous": null,
"results": [
{
"id": "0186dc02-05b6-b83f-c366-b39a267e1570",
"account": "0185a8b8-60eb-80ca-7482-5f24504573f7",
"document_number": null,
"available_date": "2020-05-13T17:25:59Z",
"expiration_date": null,
"employer": "Whole Goods",
"employment": "0186a27d-e5c6-735a-a359-6315b34d544c",
"document_type": "payout-statement",
"document_type_description": null,
"file_url": "api.argyle.com/v2/payroll-documents/{id}/file",
"created_at": "2023-03-13T17:27:01.501Z",
"updated_at": "2023-03-13T17:27:01.501Z",
"ocr_data": {},
"metadata": {}
},
{
"id": "0176dc14-bb37-402a-7be1-f5261759fae7",
"account": "0187c66e-e7e5-811c-b006-2232f00f426a",
"document_number": "ced46eb3-7586-3cd7-2418-8eb9482bc3ec",
"available_date": "2019-03-14T17:46:25Z",
"expiration_date": "2027-03-12T17:46:25Z",
"employer": "GigAndGo",
"employment": "42d6531c-520a-26b9-35c3-b7137a6d205a",
"document_type": "drivers-licence",
"document_type_description": "Driver's license",
"file_url": "api.argyle.com/v2/payroll-documents/{id}/file",
"created_at": "2023-03-13T17:46:28.240Z",
"updated_at": "2023-03-13T17:46:28.240Z",
"ocr_data": {},
"metadata": {}
}
]
}Payroll Documents
List All Payroll Documents
Returns a paginated list of all payroll document objects.
GET
/
v2
/
payroll-documents
List all payroll documents
curl --request GET \
--url https://api-sandbox.argyle.com/v2/payroll-documents \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-sandbox.argyle.com/v2/payroll-documents"
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/payroll-documents', 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/payroll-documents",
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/payroll-documents"
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/payroll-documents")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/payroll-documents")
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{
"next": "https://api-sandbox.argyle.com/v2/payroll-documents?cursor=ZXhhbXBsZV9jdXJzb3I",
"previous": null,
"results": [
{
"id": "0186dc02-05b6-b83f-c366-b39a267e1570",
"account": "0185a8b8-60eb-80ca-7482-5f24504573f7",
"document_number": null,
"available_date": "2020-05-13T17:25:59Z",
"expiration_date": null,
"employer": "Whole Goods",
"employment": "0186a27d-e5c6-735a-a359-6315b34d544c",
"document_type": "payout-statement",
"document_type_description": null,
"file_url": "api.argyle.com/v2/payroll-documents/{id}/file",
"created_at": "2023-03-13T17:27:01.501Z",
"updated_at": "2023-03-13T17:27:01.501Z",
"ocr_data": {},
"metadata": {}
},
{
"id": "0176dc14-bb37-402a-7be1-f5261759fae7",
"account": "0187c66e-e7e5-811c-b006-2232f00f426a",
"document_number": "ced46eb3-7586-3cd7-2418-8eb9482bc3ec",
"available_date": "2019-03-14T17:46:25Z",
"expiration_date": "2027-03-12T17:46:25Z",
"employer": "GigAndGo",
"employment": "42d6531c-520a-26b9-35c3-b7137a6d205a",
"document_type": "drivers-licence",
"document_type_description": "Driver's license",
"file_url": "api.argyle.com/v2/payroll-documents/{id}/file",
"created_at": "2023-03-13T17:46:28.240Z",
"updated_at": "2023-03-13T17:46:28.240Z",
"ocr_data": {},
"metadata": {}
}
]
}Authorizations
Username = api_key_id, Password = api_key_secret
Query Parameters
Filter by account ID.
Filter by user ID.
Filter by employment ID.
⌘I