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.
#The Income totals object
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:
- #accountstring (uuid)
The ID of the associated payroll account.
Use this ID to retrieve account details by making the following API call:
GET /accounts/{id}. - #last_payout_datestring (timestamp)
The date of the account's most recent paystub (timestamp follows the ISO 8601 format).
- #period_start_datestring (timestamp)
The
start_dateof the earliest payout used for the income totals (timestamp follows the ISO 8601 format). - #period_end_datestring (timestamp)
The
end_dateof the most recent payout used for the income totals (timestamp follows the ISO 8601 format). - #income_totalsarray of objects
Yearly pay information by calendar year.
- #periodstring
Calendar year.
- #currencystring
The currency for the period—for example,
USDorEUR. Currencies follow the ISO 4217 format. - #gross_payobject
Contains the amount of gross pay earned in the calendar year, in total and by category.
- #totalstring
Total gross pay for the calendar year. Values available in
payouts.gross_pay_ytdfor the calendar year's final paystub and inpayouts.gross_pay_list_totalsfor all paystubs in the calendar year are used. - #basestring
Total base pay for the calendar year. Values of
type=baseavailable inpayouts.gross_pay_list_totalsare used for all paystubs in the calendar year. - #overtimestring
Total overtime pay for the calendar year. Values of
type=overtimeavailable inpayouts.gross_pay_list_totalsare used for all paystubs in the calendar year. - #bonusstring
Total bonus pay for the calendar year. Values of
type=bonusavailable inpayouts.gross_pay_list_totalsare used for all paystubs in the calendar year. - #commissionstring
Total
commissionpay for the calendar year. Values oftype=commissionavailable in payouts.gross_pay_list_totalsare used for all paystubs in the calendar year. - #otherstring
All other pay for the calendar year. Values of
type=otheravailable inpayouts.gross_pay_list_totalsare used for all paystubs in the calendar year. - #reimbursementsstring
The sum of all
payouts.reimbursementsduring the calendar year. - #deductionsstring
The value of
payouts.deductions_ytdfor the final paystub in a calendar year, when available, otherwise the sum of allpayouts.deductionssubtracted during the calendar year. - #taxesstring
The value of
payouts.taxes_ytdfor the final paystub in a calendar year, when available, otherwise the sum of allpayouts.taxesthat have been withheld during the calendar year. - #feesstring
The sum of all
payouts.feesduring the calendar year. - #net_paystring
The value of
payouts.net_pay_ytdfor the final paystub in a calendar year, when available, otherwise the sum of allpayouts.net_payreceived in the calendar year.
1{
2 "account": "05e9e043-87a2-4e7f-83b1-9181dcc1e784",
3 "last_payout_date": "2022-08-29",
4 "period_start_date": "2021-01-15",
5 "period_end_date": "2022-08-29",
6 "income_totals": [
7 {
8 "period": "2022",
9 "currency": "USD",
10 "gross_pay": {
11 "total": "35020.39",
12 "base": "21231.02",
13 "overtime": "1231.12",
14 "bonus": "12312.01",
15 "commission": "123.12",
16 "other": "123.12"
17 },
18 "reimbursements": "123.12",
19 "deductions": "123.12",
20 "taxes": "12345.12",
21 "fees": "12.01",
22 "net_pay": "22417.02"
23 },
24 {
25 "period": "2021",
26 "currency": "USD",
27 "gross_pay": {
28 "total": "35020.39",
29 "base": "21231.02",
30 "overtime": "1231.12",
31 "bonus": "12312.01",
32 "commission": "123.12",
33 "other": "123.12"
34 },
35 "reimbursements": "123.12",
36 "deductions": "123.12",
37 "taxes": "12345.12",
38 "fees": "12.01",
39 "net_pay": "22417.02"
40 },
41 {
42 "period": "2021",
43 "currency": "GBP",
44 "gross_pay": {
45 "total": "35020.39",
46 "base": "21231.02",
47 "overtime": "1231.12",
48 "bonus": "12312.01",
49 "commission": "123.12",
50 "other": "123.12"
51 },
52 "reimbursements": "123.12",
53 "deductions": "123.12",
54 "taxes": "12345.12",
55 "fees": "12.01",
56 "net_pay": "22417.02"
57 }
58 ]
59}#List income-totals
A query parameter (account or user) MUST be used when listing income-totals.
- List all income-totals by calendar year, from newest to oldest.
- This request returns an object with a
resultsproperty that contains an array of objects for each account that include the account ID,last_payout_date,period_start_date,period_end_date, andincome_totalsobject.
1curl --request GET \
2 --url https://api.argyle.com/v1/income-totals?{account}={id} \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'1[
2 {
3 "account": "05e9e043-87a2-4e7f-83b1-9181dcc1e784",
4 "last_payout_date": "2022-08-29",
5 "period_start_date": "2021-01-15",
6 "period_end_date": "2022-08-29",
7 "income_totals": [
8 {
9 "period": "2022",
10 "currency": "USD",
11 "gross_pay": {
12 "total": "35020.39",
13 "base": "21231.02",
14 "overtime": "1231.12",
15 "bonus": "12312.01",
16 "commission": "123.12",
17 "other": "123.12"
18 },
19 "reimbursements": "123.12",
20 "deductions": "123.12",
21 "taxes": "12345.12",
22 "fees": "12.01",
23 "net_pay": "22417.02"
24 },
25 {
26 "period": "2021",
27 "currency": "USD",
28 "gross_pay": {
29 "total": "35020.39",
30 "base": "21231.02",
31 "overtime": "1231.12",
32 "bonus": "12312.01",
33 "commission": "123.12",
34 "other": "123.12"
35 },
36 "reimbursements": "123.12",
37 "deductions": "123.12",
38 "taxes": "12345.12",
39 "fees": "12.01",
40 "net_pay": "22417.02"
41 },
42 {
43 "period": "2021",
44 "currency": "GBP",
45 "gross_pay": {
46 "total": "35020.39",
47 "base": "21231.02",
48 "overtime": "1231.12",
49 "bonus": "12312.01",
50 "commission": "123.12",
51 "other": "123.12"
52 },
53 "reimbursements": "123.12",
54 "deductions": "123.12",
55 "taxes": "12345.12",
56 "fees": "12.01",
57 "net_pay": "22417.02"
58 }
59 ]
60 }
61]