Pay Data Structure
Learn about the structure of pay data available in the
Argyle allows you to retrieve detailed income data for all connected payroll accounts.
/payoutsendpoint provides information from individual paystubs.
/income-totalsendpoint provides total pay amounts from all paystubs for each calendar year.
/payouts endpoint provides machine-readable, normalized versions of traditional paystubs. These digital paystubs are returned as payout objects.
payoutobject contains summary information, paystub totals, year-to-date amounts, information from each paystub entry, and gross pay totals by
Year-to-date amounts in the
payoutobject are provided as they appear on paystubs. They are not calculated values.
- A complete list of available information provided by the /payouts endpoint can be found in Payouts, including a full sample JSON object.
Structure of payout objects#
Structure of gross_pay_list, deduction_list, and tax_list#
tax_listcontain information from individual entries on a paystub.
Structure of gross_pay_list_totals#
Paystub entries contained in
gross_pay_list are added together based on their
type attribute and presented in the
/income-totals endpoint provides total pay amounts gathered from all paystubs for each available calendar year.
Information regarding users' total yearly compensation is fundamental in many use cases, but paystubs often omit this information or provide it only for some but not all entries. Through the
/income-totals endpoint, Argyle aggregates this yearly income information in a standardized way.
Structure of the /income-totals endpoint#
Yearly pay information is returned as a series of objects representing each calendar year.
A full sample JSON object can be found in Income Totals in our API Reference.
Connecting /payouts and /income-totals#
income_totals.deductionsis based on
income_totals.net_payfollowing the same approach.