SolutionsGuidesReferences

Income totals

Learn about the /income-totals endpoint.

The /income-totals endpoint provides total pay amounts gathered from all paystubs for each available calendar year.

structure of the income totals object

Attributes of income_totals

Yearly pay information is returned as a series of objects, each representing a calendar year. These objects are returned in the income_totals array. Each object contains the following attributes:

AttributeTypeDescription
periodstringCalendar year.
currencystringThe currency for the period—for example, USD or EUR. Currencies follow the ISO 4217 format.
gross_payobject
See underlying attributes		Contains the amount of gross pay earned in the calendar year, in total and by category.
reimbursementsstringThe sum of all payouts.reimbursements during the calendar year.
deductionsstringThe value of payouts.deductions_ytd for the final paystub in a calendar year, when available, otherwise the sum of all payouts.deductions subtracted during the calendar year.
taxesstringThe value of payouts.taxes_ytd for the final paystub in a calendar year, when available, otherwise the sum of all payouts.taxes that have been withheld during the calendar year.
feesstringThe sum of all payouts.fees during the calendar year.
net_paystringThe value of payouts.net_pay_ytd for the final paystub in a calendar year, when available, otherwise the sum of all payouts.net_pay received in the calendar year.

Attributes of gross_pay

Payout values for all paystubs in a calendar year are used to determine income_totals.gross_pay.

AttributeTypeDescription
gross_pay.totalstringTotal gross pay for the calendar year. Values available in payouts.gross_pay_ytd for the calendar year’s final paystub and in payouts.gross_pay_list_totals for all paystubs in the calendar year are used.
gross_pay.basestringTotal base pay for the calendar year. Values of type = base available in payouts.gross_pay_list_totals are used for all paystubs in the calendar year.
gross_pay.overtimestringTotal overtime pay for the calendar year. Values of type = overtime available in payouts.gross_pay_list_totals are used for all paystubs in the calendar year.
gross_pay.bonusstringTotal bonus pay for the calendar year. Values of type = bonus available in payouts.gross_pay_list_totals are used for all paystubs in the calendar year.
gross_pay.commissionstringTotal commission pay for the calendar year. Values of type = commission available in payouts.gross_pay_list_totals are used for all paystubs in the calendar year.
gross_pay.otherstringAll other pay for the calendar year. Values of type = other available in payouts.gross_pay_list_totals are used for all paystubs in the calendar year.

Additional Information

Supplementary attributes that contain additional information linking to Argyle data.

AttributeTypeDescription
accountstringThe ID of the associated payroll account.

Use this ID to retrieve account details by making the following API call: GET /accounts/:id.
last_payout_datestringThe date of the account’s most recent paystub (timestamp follows the ISO 8601 format).

Endpoints

These are the endpoints available for /income-totals.

Endpoints
List income-totals - GET /income-totals

Sample response

Below is a sample payload returned by the /income-totals endpoint.

{
    "account": "05e9e043-87a2-4e7f-83b1-9181dcc1e784",
    "last_payout_date": "2022-08-29",
    "income_totals": [
        {
            "period": "2022",
            "currency": "USD",
            "gross_pay": {
                "total": "35020.39",
                "base": "21231.02",
                "overtime": "1231.12",
                "bonus": "12312.01",
                "commission": "123.12",
                "other": "123.12",
            },
            "reimbursements": "123.12",
            "deductions": "123.12",
            "taxes": "12345.12",
            "fees": "12.01",
            "net_pay": "22417.02",
        },
        {
            "period": "2021",
            "currency": "USD",
            "gross_pay": {
                "total": "35020.39",
                "base": "21231.02",
                "overtime": "1231.12",
                "bonus": "12312.01",
                "commission": "123.12",
                "other": "123.12",
            },
            "reimbursements": "123.12",
            "deductions": "123.12",
            "taxes": "12345.12",
            "fees": "12.01",
            "net_pay": "22417.02",
        },
        {
            "period": "2021",
            "currency": "GBP",
            "gross_pay": {
                "total": "35020.39",
                "base": "21231.02",
                "overtime": "1231.12",
                "bonus": "12312.01",
                "commission": "123.12",
                "other": "123.12",
            },
            "reimbursements": "123.12",
            "deductions": "123.12",
            "taxes": "12345.12",
            "fees": "12.01",
            "net_pay": "22417.02",
        }
    ]
}