Paystubs
The digital equivalent of a traditional paystub.
#The paystub object
Attributes
- #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 objectsAn itemized list of deductions listed on the paystub. Each object corresponds to one line item.
- #filing_statusarray of objectsInformation on the user's filing status.
- #tax_listarray of objectsAn 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_periodobjectStart date and end date of the work period.
- #currencystring
Currency code (ISO 4217).
- #gross_paystringTotal gross pay from the paystub period before taxes or deductions.
- #deductionsstringTotal amount of deductions from the paystub period.
- #taxesstringTotal tax amount from the paystub period.
- #net_paystringNet pay (gross pay minus taxes and deductions) from the paystub period.
- #reimbursementsstringTotal reimbursement amount from the paystub period.
- #hoursstringTotal hours worked during the paystub period.
- #feesstringTotal fees incurred during the paystub period.
- #net_pay_ytdstringNet pay year-to-date, including this paystub.
- #gross_pay_ytdstringGross pay year-to-date, including this paystub.
- #employerstringEmployer name.
- #employmentstring
Employment ID. Can be used as a filter when listing paystubs.
- #employer_addressobjectObject containing employer address information, sourced from the paystub.
- #citystringName of the city, town, district, or similar regional entity.
- #line1stringAddress-Line 1, usually street address or P.O. Box information.
- #line2stringAddress-Line 2, usually the apartment or unit number.
- #statestringState, county, province, region, or equivalent.
- #countrystring
Two-letter country code (ISO 3166-1 alpha-2 format).
- #postal_codestringZip 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 objectsContains information on where and how pay was delivered to the user.
- #hours_ytdstringTotal hours worked year-to-date, including this paystub's work period.
- #deductions_ytdstringTotal deductions year-to-date, including amounts from this paystub.
- #taxes_ytdstringTotal taxes year-to-date, including amounts from this paystub.
- #gross_pay_listarray of objectsAn itemized list of gross pay listed on the paystub. Each object corresponds to one line item.
- #namestringName 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.
- #ratestringHourly rate of gross pay earnings for this line item.
- #hoursstringHours worked for this line item.
- #amountstringGross pay earned from this line item.
- #hours_ytdstringTotal hours worked year-to-date related to this gross pay line item, including this paystub's work period.
- #amount_ytdstringTotal 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
- #amountstringGross pay earned from line items of this type.
- #amount_ytdstringTotal gross pay earned year-to-date from line items of this type, including this paystub.
- #hoursstringHours worked from line items of this type.
- #hours_ytdstringHours 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
- #amountstringGross pay earned from line items of this type.
- #amount_ytdstringTotal gross pay earned year-to-date from line items of this type, including this paystub.
- #hoursstringHours worked from line items of this type.
- #hours_ytdstringHours 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
- #amountstringGross pay earned from line items of this type.
- #amount_ytdstringTotal gross pay earned year-to-date from line items of this type, including this paystub.
- #hoursstringHours worked from line items of this type.
- #hours_ytdstringHours 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
- #amountstringGross pay earned from line items of this type.
- #amount_ytdstringTotal gross pay earned year-to-date from line items of this type, including this paystub.
- #hoursstringHours worked from line items of this type.
- #hours_ytdstringHours 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
- #amountstringGross pay earned from line items of this type.
- #amount_ytdstringTotal gross pay earned year-to-date from line items of this type, including this paystub.
- #hoursstringHours worked from line items of this type.
- #hours_ytdstringHours 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. - #metadataobjectAdditional, non-categorized information.
Example
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 "employment": "0186a27d-e5c6-735a-a359-6315b34d544c",
69 "employer_address": {
70 "city": "New York",
71 "line1": "852 North W St",
72 "line2": "Apt 221",
73 "state": "NY",
74 "country": "US",
75 "postal_code": "10014"
76 },
77 "created_at": "2023-03-13T19:53:57.122Z",
78 "updated_at": "2023-03-13T19:53:57.122Z",
79 "destinations": [
80 {
81 "reference": "CHECKING *********2201",
82 "amount": "1290.10",
83 "method": "direct deposit",
84 "ach_deposit_account": {
85 "bank_name": "NW Regional",
86 "routing_number": null,
87 "account_number": "*********2201"
88 },
89 "card": null
90 }
91 ],
92 "hours_ytd": "422.00",
93 "deductions_ytd": "533.40",
94 "taxes_ytd": "2502.17",
95 "gross_pay_list": [
96 {
97 "name": "Regular",
98 "type": "base",
99 "start_date": "2023-02-28",
100 "end_date": "2023-03-07",
101 "rate": "25.6088",
102 "hours": "49.5977",
103 "amount": "1270.14",
104 "hours_ytd": "422.0000",
105 "amount_ytd": "13971.54"
106 },
107 {
108 "name": "Commission",
109 "type": "commission",
110 "start_date": "2023-03-04",
111 "end_date": "2023-03-04",
112 "rate": null,
113 "hours": null,
114 "amount": "337.49",
115 "hours_ytd": null,
116 "amount_ytd": "1758.56"
117 }
118 ],
119 "gross_pay_list_totals": {
120 "base": {
121 "amount": "1270.14",
122 "amount_ytd": "13971.54",
123 "hours": "49.5977",
124 "hours_ytd": "422.0000",
125 "rate_implied": "25.6100",
126 "rate_implied_ytd": "33.1100"
127 },
128 "overtime": null,
129 "commission": {
130 "amount": "337.49",
131 "amount_ytd": "1758.56",
132 "hours": null,
133 "hours_ytd": null,
134 "rate_implied": null,
135 "rate_implied_ytd": null
136 },
137 "bonus": null,
138 "other": null
139 },
140 "metadata": {}
141}#Retrieve a paystub
get/v2/paystubs/{id}
Retrieves a paystub object.
Path parameters
- #idstring (uuid)ID of the paystub object to be retrieved.required
Example Request
1curl --request GET \
2 --url https://api.argyle.com/v2/paystubs/{id} \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'Example Response
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 "employment": "0186a27d-e5c6-735a-a359-6315b34d544c",
69 "employer_address": {
70 "city": "New York",
71 "line1": "852 North W St",
72 "line2": "Apt 221",
73 "state": "NY",
74 "country": "US",
75 "postal_code": "10014"
76 },
77 "created_at": "2023-03-13T19:53:57.122Z",
78 "updated_at": "2023-03-13T19:53:57.122Z",
79 "destinations": [
80 {
81 "reference": "CHECKING *********2201",
82 "amount": "1290.10",
83 "method": "direct deposit",
84 "ach_deposit_account": {
85 "bank_name": "NW Regional",
86 "routing_number": null,
87 "account_number": "*********2201"
88 },
89 "card": null
90 }
91 ],
92 "hours_ytd": "422.00",
93 "deductions_ytd": "533.40",
94 "taxes_ytd": "2502.17",
95 "gross_pay_list": [
96 {
97 "name": "Regular",
98 "type": "base",
99 "start_date": "2023-02-28",
100 "end_date": "2023-03-07",
101 "rate": "25.6088",
102 "hours": "49.5977",
103 "amount": "1270.14",
104 "hours_ytd": "422.0000",
105 "amount_ytd": "13971.54"
106 },
107 {
108 "name": "Commission",
109 "type": "commission",
110 "start_date": "2023-03-04",
111 "end_date": "2023-03-04",
112 "rate": null,
113 "hours": null,
114 "amount": "337.49",
115 "hours_ytd": null,
116 "amount_ytd": "1758.56"
117 }
118 ],
119 "gross_pay_list_totals": {
120 "base": {
121 "amount": "1270.14",
122 "amount_ytd": "13971.54",
123 "hours": "49.5977",
124 "hours_ytd": "422.0000",
125 "rate_implied": "25.6100",
126 "rate_implied_ytd": "33.1100"
127 },
128 "overtime": null,
129 "commission": {
130 "amount": "337.49",
131 "amount_ytd": "1758.56",
132 "hours": null,
133 "hours_ytd": null,
134 "rate_implied": null,
135 "rate_implied_ytd": null
136 },
137 "bonus": null,
138 "other": null
139 },
140 "metadata": {}
141}#List all paystubs
get/v2/paystubs
Returns an array of all paystub objects.
Query parameters
- #accountstring (uuid)optional
Filter by account ID.
- #userstring (uuid)optional
Filter by user ID.
- #employmentstring (uuid)optional
Filter by employment 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.
Example Request
1curl --request GET \
2 --url https://api.argyle.com/v2/paystubs?limit=2 \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'Example Response
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": "Double Double",
52 "employment": "0183d52a-d3b2-331d-c753-3662a20e352b",
53 "employer_address": {
54 "city": "Seattle",
55 "line1": "220 West Blvd",
56 "line2": null,
57 "state": "WA",
58 "country": "US",
59 "postal_code": "98109"
60 },
61 "created_at": "2023-03-13T19:53:57.122Z",
62 "updated_at": "2023-03-13T19:53:57.122Z",
63 "destinations": [],
64 "hours_ytd": "411.80",
65 "deductions_ytd": "160.38",
66 "taxes_ytd": "2726.22",
67 "gross_pay_list": [
68 {
69 "name": "Regular",
70 "type": "base",
71 "start_date": "2023-01-28",
72 "end_date": "2023-02-27",
73 "rate": "35.6966",
74 "hours": "149.7489",
75 "amount": "5345.53",
76 "hours_ytd": "393.3000",
77 "amount_ytd": "16036.59"
78 },
79 {
80 "name": "Overtime",
81 "type": "overtime",
82 "start_date": "2023-02-21",
83 "end_date": "2023-02-24",
84 "rate": "53.5449",
85 "hours": "18.5083",
86 "amount": "991.03",
87 "hours_ytd": "18.5100",
88 "amount_ytd": "991.03"
89 }
90 ],
91 "gross_pay_list_totals": {
92 "base": {
93 "amount": "5345.53",
94 "amount_ytd": "16036.59",
95 "hours": "149.7489",
96 "hours_ytd": "393.3000",
97 "rate_implied": "35.7000",
98 "rate_implied_ytd": "40.7700"
99 },
100 "overtime": {
101 "amount": "991.03",
102 "amount_ytd": "991.03",
103 "hours": "18.5083",
104 "hours_ytd": "18.5100",
105 "rate_implied": "53.5500",
106 "rate_implied_ytd": "53.5400"
107 },
108 "commission": null,
109 "bonus": null,
110 "other": null
111 },
112 "metadata": {}
113 },
114 {
115 "id": "0187dc99-63be-bc96-51bf-af6b51d43687",
116 "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
117 "payroll_document": "0186eb89-2e52-b3c5-ac6d-05e7debb2aff",
118 "deduction_list": [
119 {
120 "amount": "38.10",
121 "name": "401K",
122 "tax_classification": "pre_tax",
123 "amount_ytd": "139.70"
124 },
125 {
126 "amount": "25.40",
127 "name": "Garnishment",
128 "tax_classification": "post_tax",
129 "amount_ytd": "76.20"
130 },
131 {
132 "amount": "25.40",
133 "name": "Garnishment",
134 "tax_classification": "post_tax",
135 "amount_ytd": "101.60"
136 }
137 ],
138 "filing_status": [
139 {
140 "type": "federal",
141 "location": null,
142 "status": "married filing separately"
143 },
144 {
145 "type": "state",
146 "location": "NY",
147 "status": "married filing separately"
148 }
149 ],
150 "tax_list": [
151 {
152 "amount": "88.91",
153 "name": "Federal Withholding",
154 "type": "federal",
155 "amount_ytd": "850.99"
156 },
157 {
158 "amount": "139.72",
159 "name": "Social Security Tax",
160 "type": "fica",
161 "amount_ytd": "381.04"
162 }
163 ],
164 "status": "completed",
165 "paystub_date": "2023-03-12T00:00:00Z",
166 "paystub_period": {
167 "start_date": "2023-02-28T00:00:00Z",
168 "end_date": "2023-03-07T00:00:00Z"
169 },
170 "currency": "USD",
171 "gross_pay": "1607.63",
172 "deductions": "88.90",
173 "taxes": "228.63",
174 "net_pay": "1290.10",
175 "reimbursements": "0.00",
176 "hours": "49.60",
177 "fees": null,
178 "net_pay_ytd": "12714.18",
179 "gross_pay_ytd": "15730.10",
180 "employer": "Whole Goods",
181 "employment": "0186a27d-e5c6-735a-a359-6315b34d544c",
182 "employer_address": {
183 "city": "New York",
184 "line1": "852 North W St",
185 "line2": "Apt 221",
186 "state": "NY",
187 "country": "US",
188 "postal_code": "10014"
189 },
190 "created_at": "2023-03-13T19:53:57.122Z",
191 "updated_at": "2023-03-13T19:53:57.122Z",
192 "destinations": [
193 {
194 "reference": "CHECKING *********2201",
195 "amount": "1290.10",
196 "method": "direct deposit",
197 "ach_deposit_account": {
198 "bank_name": "NW Regional",
199 "routing_number": null,
200 "account_number": "*********2201"
201 },
202 "card": null
203 }
204 ],
205 "hours_ytd": "422.00",
206 "deductions_ytd": "533.40",
207 "taxes_ytd": "2502.17",
208 "gross_pay_list": [
209 {
210 "name": "Regular",
211 "type": "base",
212 "start_date": "2023-02-28",
213 "end_date": "2023-03-07",
214 "rate": "25.6088",
215 "hours": "49.5977",
216 "amount": "1270.14",
217 "hours_ytd": "422.0000",
218 "amount_ytd": "13971.54"
219 },
220 {
221 "name": "Commission",
222 "type": "commission",
223 "start_date": "2023-03-04",
224 "end_date": "2023-03-04",
225 "rate": null,
226 "hours": null,
227 "amount": "337.49",
228 "hours_ytd": null,
229 "amount_ytd": "1758.56"
230 }
231 ],
232 "gross_pay_list_totals": {
233 "base": {
234 "amount": "1270.14",
235 "amount_ytd": "13971.54",
236 "hours": "49.5977",
237 "hours_ytd": "422.0000",
238 "rate_implied": "25.6100",
239 "rate_implied_ytd": "33.1100"
240 },
241 "overtime": null,
242 "commission": {
243 "amount": "337.49",
244 "amount_ytd": "1758.56",
245 "hours": null,
246 "hours_ytd": null,
247 "rate_implied": null,
248 "rate_implied_ytd": null
249 },
250 "bonus": null,
251 "other": null
252 },
253 "metadata": {}
254 }
255]