List All Statements
curl --request GET \
--url https://api.example.com/v1/links/{link_id}/statements/import requests
url = "https://api.example.com/v1/links/{link_id}/statements/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/links/{link_id}/statements/', 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.example.com/v1/links/{link_id}/statements/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/v1/links/{link_id}/statements/"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/v1/links/{link_id}/statements/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/links/{link_id}/statements/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyPay Statements
List All Statements
Retrieve a list of pay statements associated with a specific link
GET
/
v1
/
links
/
{link_id}
/
statements
/
List All Statements
curl --request GET \
--url https://api.example.com/v1/links/{link_id}/statements/import requests
url = "https://api.example.com/v1/links/{link_id}/statements/"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/links/{link_id}/statements/', 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.example.com/v1/links/{link_id}/statements/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/v1/links/{link_id}/statements/"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/v1/links/{link_id}/statements/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/links/{link_id}/statements/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyDescription
This endpoint retrieves a comprehensive list of pay statements associated with a specific link. The response includes statement dates, gross pay, net pay, and a detailed breakdown of earnings with corresponding deductions.Authentication
This endpoint requires API credentials:- ClientID (header)
- AccessKey (header)
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
link_id | string | Yes | The unique identifier for the account link |
Response Format
The endpoint returns a paginated list of pay statement objects containing:- Statement dates
- Gross pay amounts
- Net pay amounts
- Earnings breakdown
- Deductions breakdown
Error Responses
| Status Code | Description |
|---|---|
| 400 | Incorrect request parameters |
| 401 | Authentication failed (invalid or missing credentials) |
| 403 | Forbidden (insufficient permissions) |
Related Endpoints
- Retrieve a statement - GET endpoint for individual statement details
- Pay Statements Webhooks - Webhook notifications for statement events