Skip to main content
GET
/
v1
/
links
/
{link_id}
/
statements
List All Statements
curl --request GET \
  --url https://api.example.com/v1/links/{link_id}/statements/

​
Description

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

ParameterTypeRequiredDescription
link_idstringYesThe 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 CodeDescription
400Incorrect request parameters
401Authentication failed (invalid or missing credentials)
403Forbidden (insufficient permissions)