Paystubs
The digital equivalent of a traditional paystub.
#The paystub object
- #idstring (uuid)
Unique ID of the paystub object.
- #accountstring (uuid)
ID of the account associated with the paystub.
- #payroll_documentstring (uuid)
ID of the payroll document object associated with this paystub.
- #deduction_listarray of objects
An itemized list of deductions listed on the paystub. Each object corresponds to one line item.
- #filing_statusarray of objects
Information on the user's filing status.
- #tax_listarray of objects
An itemized list of tax withholdings listed on the paystub. Each object corresponds to one line item.
- #statusstring (enum)
Payment status of the paystub.
- #paystub_datestring (datetime)
Timestamp (ISO 8601) of the payment date, sourced from the paystub.
- #paystub_periodobject
Start date and end date of the work period.
- #currencystring
Currency code (ISO 4217).
- #gross_paystring
Total gross pay from the paystub period before taxes or deductions.
- #deductionsstring
Total amount of deductions from the paystub period.
- #taxesstring
Total tax amount from the paystub period.
- #net_paystring
Net pay (gross pay minus taxes and deductions) from the paystub period.
- #reimbursementsstring
Total reimbursement amount from the paystub period.
- #hoursstring
Total hours worked during the paystub period.
- #feesstring
Total fees incurred during the paystub period.
- #net_pay_ytdstring
Net pay year-to-date, including this paystub.
- #gross_pay_ytdstring
Gross pay year-to-date, including this paystub.
- #employerstring
Employer name.
- #employer_addressobject
Object containing employer address information, sourced from the paystub.
- #citystring
Name of the city, town, district, or similar regional entity.
- #line1string
Address-Line 1, usually street address or P.O. Box information.
- #line2string
Address-Line 2, usually the apartment or unit number.
- #statestring
State, county, province, region, or equivalent.
- #countrystring
Two-letter country code (ISO 3166-1 alpha-2 format).
- #postal_codestring
Zip code, or equivalent.
- #created_atstring (datetime)
Timestamp (ISO 8601) when the paystub object was created.
- #updated_atstring (datetime)
Timestamp (ISO 8601) when a property value of the paystub object most recently changed.
- #destinationsarray of objects
Contains information on where and how pay was delivered to the user.
- #hours_ytdstring
Total hours worked year-to-date, including this paystub's work period.
- #deductions_ytdstring
Total deductions year-to-date, including amounts from this paystub.
- #taxes_ytdstring
Total taxes year-to-date, including amounts from this paystub.
- #gross_pay_listarray of objects
An itemized list of gross pay listed on the paystub. Each object corresponds to one line item.
- #namestring
Name or description of the gross pay line item.
- #typestring (enum)
Categorized type of gross pay, based on
name. Used ingross_pay_list_totals. - #start_datestring (datetime)
Timestamp (ISO 8601) of the start of the work period.
- #end_datestring (datetime)
Timestamp (ISO 8601) of the end of the work period.
- #ratestring
Hourly rate of gross pay earnings for this line item.
- #hoursstring
Hours worked for this line item.
- #amountstring
Gross pay earned from this line item.
- #hours_ytdstring
Total hours worked year-to-date related to this gross pay line item, including this paystub's work period.
- #amount_ytdstring
Total gross pay earned year-to-date related to this gross pay line item, including this paystub.
- #gross_pay_list_totalsobject
Sums the values of
gross_pay_listobjects based on theirtype:- base = base + pto
- overtime = overtime
- commission = commission
- bonus = bonus
- other = disability + benefits + tips + stock + other
- base = base + pto
- #baseobject
- #amountstring
Gross pay earned from line items of this type.
- #amount_ytdstring
Total gross pay earned year-to-date from line items of this type, including this paystub.
- #hoursstring
Hours worked from line items of this type.
- #hours_ytdstring
Hours worked year-to-date from line items of this type, including this paystub.
- #rate_impliedstring
Calculated ratio of
amounttohoursof gross pay list totals. - #rate_implied_ytdstring
Calculated ratio of
amount_ytdtohours_ytdof gross pay list totals. - #overtimeobject
- #amountstring
Gross pay earned from line items of this type.
- #amount_ytdstring
Total gross pay earned year-to-date from line items of this type, including this paystub.
- #hoursstring
Hours worked from line items of this type.
- #hours_ytdstring
Hours worked year-to-date from line items of this type, including this paystub.
- #rate_impliedstring
Calculated ratio of
amounttohoursof gross pay list totals. - #rate_implied_ytdstring
Calculated ratio of
amount_ytdtohours_ytdof gross pay list totals. - #commissionobject
- #amountstring
Gross pay earned from line items of this type.
- #amount_ytdstring
Total gross pay earned year-to-date from line items of this type, including this paystub.
- #hoursstring
Hours worked from line items of this type.
- #hours_ytdstring
Hours worked year-to-date from line items of this type, including this paystub.
- #rate_impliedstring
Calculated ratio of
amounttohoursof gross pay list totals. - #rate_implied_ytdstring
Calculated ratio of
amount_ytdtohours_ytdof gross pay list totals. - #bonusobject
- #amountstring
Gross pay earned from line items of this type.
- #amount_ytdstring
Total gross pay earned year-to-date from line items of this type, including this paystub.
- #hoursstring
Hours worked from line items of this type.
- #hours_ytdstring
Hours worked year-to-date from line items of this type, including this paystub.
- #rate_impliedstring
Calculated ratio of
amounttohoursof gross pay list totals. - #rate_implied_ytdstring
Calculated ratio of
amount_ytdtohours_ytdof gross pay list totals. - #otherobject
- #amountstring
Gross pay earned from line items of this type.
- #amount_ytdstring
Total gross pay earned year-to-date from line items of this type, including this paystub.
- #hoursstring
Hours worked from line items of this type.
- #hours_ytdstring
Hours worked year-to-date from line items of this type, including this paystub.
- #rate_impliedstring
Calculated ratio of
amounttohoursof gross pay list totals. - #rate_implied_ytdstring
Calculated ratio of
amount_ytdtohours_ytdof gross pay list totals. - #metadataobject
Additional, non-categorized information.
1{
2 "id": "0187dc99-63be-bc96-51bf-af6b51d43687",
3 "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
4 "payroll_document": "0186eb89-2e52-b3c5-ac6d-05e7debb2aff",
5 "deduction_list": [
6 {
7 "amount": "38.10",
8 "name": "401K",
9 "tax_classification": "pre_tax",
10 "amount_ytd": "139.70"
11 },
12 {
13 "amount": "25.40",
14 "name": "Garnishment",
15 "tax_classification": "post_tax",
16 "amount_ytd": "76.20"
17 },
18 {
19 "amount": "25.40",
20 "name": "Garnishment",
21 "tax_classification": "post_tax",
22 "amount_ytd": "101.60"
23 }
24 ],
25 "filing_status": [
26 {
27 "type": "federal",
28 "location": null,
29 "status": "married filing separately"
30 },
31 {
32 "type": "state",
33 "location": "NY",
34 "status": "married filing separately"
35 }
36 ],
37 "tax_list": [
38 {
39 "amount": "88.91",
40 "name": "Federal Withholding",
41 "type": "federal",
42 "amount_ytd": "850.99"
43 },
44 {
45 "amount": "139.72",
46 "name": "Social Security Tax",
47 "type": "fica",
48 "amount_ytd": "381.04"
49 }
50 ],
51 "status": "completed",
52 "paystub_date": "2023-03-12T00:00:00Z",
53 "paystub_period": {
54 "start_date": "2023-02-28T00:00:00Z",
55 "end_date": "2023-03-07T00:00:00Z"
56 },
57 "currency": "USD",
58 "gross_pay": "1607.63",
59 "deductions": "88.90",
60 "taxes": "228.63",
61 "net_pay": "1290.10",
62 "reimbursements": "0.00",
63 "hours": "49.60",
64 "fees": null,
65 "net_pay_ytd": "12714.18",
66 "gross_pay_ytd": "15730.10",
67 "employer": "Whole Goods",
68 "employer_address": {
69 "city": "New York",
70 "line1": "852 North W St",
71 "line2": "Apt 221",
72 "state": "NY",
73 "country": "US",
74 "postal_code": "10014"
75 },
76 "created_at": "2023-03-13T19:53:57.122Z",
77 "updated_at": "2023-03-13T19:53:57.122Z",
78 "destinations": [
79 {
80 "reference": "CHECKING *********2201",
81 "amount": "1290.10",
82 "method": "direct deposit",
83 "ach_deposit_account": {
84 "bank_name": "NW Regional",
85 "routing_number": null,
86 "account_number": "*********2201"
87 },
88 "card": null
89 }
90 ],
91 "hours_ytd": "422.00",
92 "deductions_ytd": "533.40",
93 "taxes_ytd": "2502.17",
94 "gross_pay_list": [
95 {
96 "name": "Regular",
97 "type": "base",
98 "start_date": "2023-02-28",
99 "end_date": "2023-03-07",
100 "rate": "25.6088",
101 "hours": "49.5977",
102 "amount": "1270.14",
103 "hours_ytd": "422.0000",
104 "amount_ytd": "13971.54"
105 },
106 {
107 "name": "Commission",
108 "type": "commission",
109 "start_date": "2023-03-04",
110 "end_date": "2023-03-04",
111 "rate": null,
112 "hours": null,
113 "amount": "337.49",
114 "hours_ytd": null,
115 "amount_ytd": "1758.56"
116 }
117 ],
118 "gross_pay_list_totals": {
119 "base": {
120 "amount": "1270.14",
121 "amount_ytd": "13971.54",
122 "hours": "49.5977",
123 "hours_ytd": "422.0000",
124 "rate_implied": "25.6100",
125 "rate_implied_ytd": "33.1100"
126 },
127 "overtime": null,
128 "commission": {
129 "amount": "337.49",
130 "amount_ytd": "1758.56",
131 "hours": null,
132 "hours_ytd": null,
133 "rate_implied": null,
134 "rate_implied_ytd": null
135 },
136 "bonus": null,
137 "other": null
138 },
139 "metadata": {}
140}#Retrieve a paystub
Retrieves a paystub object.
- #idstring (uuid)required
ID of the paystub object to be retrieved.
1curl --request GET \
2 --url https://api.argyle.com/v2/paystubs/{id} \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'1{
2 "id": "0187dc99-63be-bc96-51bf-af6b51d43687",
3 "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
4 "payroll_document": "0186eb89-2e52-b3c5-ac6d-05e7debb2aff",
5 "deduction_list": [
6 {
7 "amount": "38.10",
8 "name": "401K",
9 "tax_classification": "pre_tax",
10 "amount_ytd": "139.70"
11 },
12 {
13 "amount": "25.40",
14 "name": "Garnishment",
15 "tax_classification": "post_tax",
16 "amount_ytd": "76.20"
17 },
18 {
19 "amount": "25.40",
20 "name": "Garnishment",
21 "tax_classification": "post_tax",
22 "amount_ytd": "101.60"
23 }
24 ],
25 "filing_status": [
26 {
27 "type": "federal",
28 "location": null,
29 "status": "married filing separately"
30 },
31 {
32 "type": "state",
33 "location": "NY",
34 "status": "married filing separately"
35 }
36 ],
37 "tax_list": [
38 {
39 "amount": "88.91",
40 "name": "Federal Withholding",
41 "type": "federal",
42 "amount_ytd": "850.99"
43 },
44 {
45 "amount": "139.72",
46 "name": "Social Security Tax",
47 "type": "fica",
48 "amount_ytd": "381.04"
49 }
50 ],
51 "status": "completed",
52 "paystub_date": "2023-03-12T00:00:00Z",
53 "paystub_period": {
54 "start_date": "2023-02-28T00:00:00Z",
55 "end_date": "2023-03-07T00:00:00Z"
56 },
57 "currency": "USD",
58 "gross_pay": "1607.63",
59 "deductions": "88.90",
60 "taxes": "228.63",
61 "net_pay": "1290.10",
62 "reimbursements": "0.00",
63 "hours": "49.60",
64 "fees": null,
65 "net_pay_ytd": "12714.18",
66 "gross_pay_ytd": "15730.10",
67 "employer": "Whole Goods",
68 "employer_address": {
69 "city": "New York",
70 "line1": "852 North W St",
71 "line2": "Apt 221",
72 "state": "NY",
73 "country": "US",
74 "postal_code": "10014"
75 },
76 "created_at": "2023-03-13T19:53:57.122Z",
77 "updated_at": "2023-03-13T19:53:57.122Z",
78 "destinations": [
79 {
80 "reference": "CHECKING *********2201",
81 "amount": "1290.10",
82 "method": "direct deposit",
83 "ach_deposit_account": {
84 "bank_name": "NW Regional",
85 "routing_number": null,
86 "account_number": "*********2201"
87 },
88 "card": null
89 }
90 ],
91 "hours_ytd": "422.00",
92 "deductions_ytd": "533.40",
93 "taxes_ytd": "2502.17",
94 "gross_pay_list": [
95 {
96 "name": "Regular",
97 "type": "base",
98 "start_date": "2023-02-28",
99 "end_date": "2023-03-07",
100 "rate": "25.6088",
101 "hours": "49.5977",
102 "amount": "1270.14",
103 "hours_ytd": "422.0000",
104 "amount_ytd": "13971.54"
105 },
106 {
107 "name": "Commission",
108 "type": "commission",
109 "start_date": "2023-03-04",
110 "end_date": "2023-03-04",
111 "rate": null,
112 "hours": null,
113 "amount": "337.49",
114 "hours_ytd": null,
115 "amount_ytd": "1758.56"
116 }
117 ],
118 "gross_pay_list_totals": {
119 "base": {
120 "amount": "1270.14",
121 "amount_ytd": "13971.54",
122 "hours": "49.5977",
123 "hours_ytd": "422.0000",
124 "rate_implied": "25.6100",
125 "rate_implied_ytd": "33.1100"
126 },
127 "overtime": null,
128 "commission": {
129 "amount": "337.49",
130 "amount_ytd": "1758.56",
131 "hours": null,
132 "hours_ytd": null,
133 "rate_implied": null,
134 "rate_implied_ytd": null
135 },
136 "bonus": null,
137 "other": null
138 },
139 "metadata": {}
140}#List all paystubs
Returns an array of all paystub objects.
- #accountstring (uuid)optional
Filter by account ID.
- #userstring (uuid)optional
Filter by user ID.
- #from_start_datestring (datetime)optional
Filter for paystubs with a
paystub_dateon or after this timestamp (ISO 8601). - #to_start_datestring (datetime)optional
Filter for paystubs with a
paystub_dateon or before this timestamp (ISO 8601). - #limitintegeroptional
Number of paystubs objects returned per page. Default: 10. Maximum: 200.
1curl --request GET \
2 --url https://api.argyle.com/v2/paystubs?limit=2 \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'1[
2 {
3 "id": "0199db32-22cd-cc87-12fa-ae2b21e43334",
4 "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
5 "payroll_document": "0193eb39-2e52-b345-ac3d-04e7debc2aab",
6 "deduction_list": [
7 {
8 "amount": "53.46",
9 "name": "Roth",
10 "tax_classification": "post_tax",
11 "amount_ytd": "106.92"
12 }
13 ],
14 "filing_status": [
15 {
16 "type": "federal",
17 "location": null,
18 "status": "married filing jointly"
19 }
20 ],
21 "tax_list": [
22 {
23 "amount": "641.46",
24 "name": "CA State Income Tax",
25 "type": "state",
26 "amount_ytd": "641.46"
27 },
28 {
29 "amount": "481.10",
30 "name": "OASDI",
31 "type": "fica",
32 "amount_ytd": "481.10"
33 }
34 ],
35 "status": "completed",
36 "paystub_date": "2023-03-12T00:00:00Z",
37 "paystub_period": {
38 "start_date": "2023-02-28T00:00:00Z",
39 "end_date": "2023-03-07T00:00:00Z"
40 },
41 "currency": "USD",
42 "gross_pay": "6336.56",
43 "deductions": "53.46",
44 "taxes": "1122.56",
45 "net_pay": "5160.54",
46 "reimbursements": "0.00",
47 "hours": "168.26",
48 "fees": null,
49 "net_pay_ytd": "14146.00",
50 "gross_pay_ytd": "17027.62",
51 "employer": "Amazing",
52 "employer_address": {
53 "city": "Seattle",
54 "line1": "220 West Blvd",
55 "line2": null,
56 "state": "WA",
57 "country": "US",
58 "postal_code": "98109"
59 },
60 "created_at": "2023-03-13T19:53:57.122Z",
61 "updated_at": "2023-03-13T19:53:57.122Z",
62 "destinations": [],
63 "hours_ytd": "411.80",
64 "deductions_ytd": "160.38",
65 "taxes_ytd": "2726.22",
66 "gross_pay_list": [
67 {
68 "name": "Regular",
69 "type": "base",
70 "start_date": "2023-01-28",
71 "end_date": "2023-02-27",
72 "rate": "35.6966",
73 "hours": "149.7489",
74 "amount": "5345.53",
75 "hours_ytd": "393.3000",
76 "amount_ytd": "16036.59"
77 },
78 {
79 "name": "Overtime",
80 "type": "overtime",
81 "start_date": "2023-02-21",
82 "end_date": "2023-02-24",
83 "rate": "53.5449",
84 "hours": "18.5083",
85 "amount": "991.03",
86 "hours_ytd": "18.5100",
87 "amount_ytd": "991.03"
88 }
89 ],
90 "gross_pay_list_totals": {
91 "base": {
92 "amount": "5345.53",
93 "amount_ytd": "16036.59",
94 "hours": "149.7489",
95 "hours_ytd": "393.3000",
96 "rate_implied": "35.7000",
97 "rate_implied_ytd": "40.7700"
98 },
99 "overtime": {
100 "amount": "991.03",
101 "amount_ytd": "991.03",
102 "hours": "18.5083",
103 "hours_ytd": "18.5100",
104 "rate_implied": "53.5500",
105 "rate_implied_ytd": "53.5400"
106 },
107 "commission": null,
108 "bonus": null,
109 "other": null
110 },
111 "metadata": {}
112 },
113 {
114 "id": "0187dc99-63be-bc96-51bf-af6b51d43687",
115 "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
116 "payroll_document": "0186eb89-2e52-b3c5-ac6d-05e7debb2aff",
117 "deduction_list": [
118 {
119 "amount": "38.10",
120 "name": "401K",
121 "tax_classification": "pre_tax",
122 "amount_ytd": "139.70"
123 },
124 {
125 "amount": "25.40",
126 "name": "Garnishment",
127 "tax_classification": "post_tax",
128 "amount_ytd": "76.20"
129 },
130 {
131 "amount": "25.40",
132 "name": "Garnishment",
133 "tax_classification": "post_tax",
134 "amount_ytd": "101.60"
135 }
136 ],
137 "filing_status": [
138 {
139 "type": "federal",
140 "location": null,
141 "status": "married filing separately"
142 },
143 {
144 "type": "state",
145 "location": "NY",
146 "status": "married filing separately"
147 }
148 ],
149 "tax_list": [
150 {
151 "amount": "88.91",
152 "name": "Federal Withholding",
153 "type": "federal",
154 "amount_ytd": "850.99"
155 },
156 {
157 "amount": "139.72",
158 "name": "Social Security Tax",
159 "type": "fica",
160 "amount_ytd": "381.04"
161 }
162 ],
163 "status": "completed",
164 "paystub_date": "2023-03-12T00:00:00Z",
165 "paystub_period": {
166 "start_date": "2023-02-28T00:00:00Z",
167 "end_date": "2023-03-07T00:00:00Z"
168 },
169 "currency": "USD",
170 "gross_pay": "1607.63",
171 "deductions": "88.90",
172 "taxes": "228.63",
173 "net_pay": "1290.10",
174 "reimbursements": "0.00",
175 "hours": "49.60",
176 "fees": null,
177 "net_pay_ytd": "12714.18",
178 "gross_pay_ytd": "15730.10",
179 "employer": "Whole Goods",
180 "employer_address": {
181 "city": "New York",
182 "line1": "852 North W St",
183 "line2": "Apt 221",
184 "state": "NY",
185 "country": "US",
186 "postal_code": "10014"
187 },
188 "created_at": "2023-03-13T19:53:57.122Z",
189 "updated_at": "2023-03-13T19:53:57.122Z",
190 "destinations": [
191 {
192 "reference": "CHECKING *********2201",
193 "amount": "1290.10",
194 "method": "direct deposit",
195 "ach_deposit_account": {
196 "bank_name": "NW Regional",
197 "routing_number": null,
198 "account_number": "*********2201"
199 },
200 "card": null
201 }
202 ],
203 "hours_ytd": "422.00",
204 "deductions_ytd": "533.40",
205 "taxes_ytd": "2502.17",
206 "gross_pay_list": [
207 {
208 "name": "Regular",
209 "type": "base",
210 "start_date": "2023-02-28",
211 "end_date": "2023-03-07",
212 "rate": "25.6088",
213 "hours": "49.5977",
214 "amount": "1270.14",
215 "hours_ytd": "422.0000",
216 "amount_ytd": "13971.54"
217 },
218 {
219 "name": "Commission",
220 "type": "commission",
221 "start_date": "2023-03-04",
222 "end_date": "2023-03-04",
223 "rate": null,
224 "hours": null,
225 "amount": "337.49",
226 "hours_ytd": null,
227 "amount_ytd": "1758.56"
228 }
229 ],
230 "gross_pay_list_totals": {
231 "base": {
232 "amount": "1270.14",
233 "amount_ytd": "13971.54",
234 "hours": "49.5977",
235 "hours_ytd": "422.0000",
236 "rate_implied": "25.6100",
237 "rate_implied_ytd": "33.1100"
238 },
239 "overtime": null,
240 "commission": {
241 "amount": "337.49",
242 "amount_ytd": "1758.56",
243 "hours": null,
244 "hours_ytd": null,
245 "rate_implied": null,
246 "rate_implied_ytd": null
247 },
248 "bonus": null,
249 "other": null
250 },
251 "metadata": {}
252 }
253]