> ## Documentation Index
> Fetch the complete documentation index at: https://docs.argyle.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Pay Data Structure

> Learn about the structure of pay data available in the /payouts and /income-totals endpoints.

Learn about the structure of pay data available in the `/payouts` and `/income-totals` endpoints.

Argyle allows you to retrieve detailed income data for all connected payroll accounts.

* The `/payouts` endpoint provides information from individual paystubs.
* The `/income-totals` endpoint provides total pay amounts from all paystubs for each calendar year.

## Payouts

The `/payouts` endpoint provides machine-readable, normalized versions of traditional paystubs. These digital paystubs are returned as payout objects.

* Each `payout` object contains summary information, paystub totals, year-to-date amounts, information from each paystub entry, and gross pay totals by `type`.

<Note>
  Year-to-date amounts in the `payout` object are provided as they appear on paystubs. They are not calculated values.
</Note>

* A complete list of available information provided by the /payouts endpoint can be found in [Payouts](/legacy/api-reference/payouts), including a full sample JSON object.

### Structure of payout objects

![Payouts include pay totals, year to date amounts, and gross pay totals by category from individual paystubs.](https://res.cloudinary.com/argyle-media/image/upload/f_auto/v1663780442/docs-2022/References/Data%20Management/Pay%20data%20structure/structure-of-the-payout-object_1)

### Structure of gross\_pay\_list, deduction\_list, and tax\_list

* `gross_pay_list`, `deduction_list`, and `tax_list` contain information from individual entries on a paystub.

![Structure of these arrays of objects.](https://res.cloudinary.com/argyle-media/image/upload/f_auto/v1663781068/docs-2022/References/Data%20Management/Pay%20data%20structure/gross_pay_list_and_deduction_list_1)

### 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 `gross_pay_list_totals` object.

![Gross pay list totals are organized by type.](https://res.cloudinary.com/argyle-media/image/upload/f_auto/v1663781117/docs-2022/References/Data%20Management/Pay%20data%20structure/gross_pay_list_totals_1)

## Income totals

The [`/income-totals`](/legacy/api-reference/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.

![Yearly totals are returned in objects that represent calendar years.](https://res.cloudinary.com/argyle-media/image/upload/f_auto/v1663781152/docs-2022/References/Data%20Management/Pay%20data%20structure/pay-data-structure-gross-pay-totals_1)

A full sample JSON object can be found in [Income Totals](/legacy/api-reference/income-totals) in our API Reference.

## Connecting /payouts and /income-totals

* `income_totals.gross_pay` corresponds to `payout.gross_pay_list_totals`.
* `income_totals.deductions` is based on `payout.deductions` and `payout.deductions_ytd`, with `income_totals.taxes` and `income_totals.net_pay` following the same approach.
* `income_totals.reimbursements` and `income_totals.fees` correspond to `payout.reimbursements` and `payout.fees`, respectively.
