Reports

Generate PDF summaries based on Argyle's data sets.

Before generating a report:

  • To ensure full data availability, we recommend subscribing to the users.fully_synced webhook, which is sent when all data has been retrieved from the user's connected accounts.
  • Depending on the data retrieval speed limits of the underlying payroll platform, it can take from a few seconds up to several minutes after a new account connection before enough data has been synced to generate a complete report.
    • Visit the data availability section of our API Guide for more information on the timing of data retrieval.

After generating a report:

  • A new report object is created. Its file_url property contains a link to the PDF report, and the accounts array lists which accounts were used to generate the report.
  • The PDF report will also appear and can be downloaded within Console.
  • (Beta) You can retrieve the content of a PDF report in JSON format.

Example reports:

#The report object

Attributes
  • #
    idstring (uuid)

    Unique ID of the report object.

    Also the "Report ID" on the report PDF.

  • #
    userstring (uuid)

    ID of the user associated with the report.

  • #
    (Deprecated) reference_idstring (uuid)

    Report PDF identifier.

  • #
    generated_atstring (datetime)

    Timestamp (ISO 8601) when the report was generated.

  • #
    typestring (enum)

    The type of report.

  • #
    statusstring (enum)

    Progress of report generation.

  • #
    file_urlstring

    Download link to the report PDF.


    This static URL redirects to a download page that requires Argyle authentication headers. See the dropdown below for more information.

  • #
    last_synced_atstring (datetime)

    Timestamp (ISO 8601) when the account used to generate the report was last scanned for new data before the report was generated. If multiple accounts were used, the more recent timestamp.

    Used to populate the "Data as of" date on the report PDF.

  • #
    accountsarray of objects

    The accounts used to generate the report.

  • #
    idstring (uuid)

    ID of the account.

  • #
    itemstring

    ID of the Item in Link through which the account was connected.

  • #
    last_synced_atstring (datetime)

    Timestamp (ISO 8601) when the account was last scanned for new data before the report was generated.

  • #
    metadataobject

    Any metadata for internal use added when generating the report.

  • #
    external_idstring

    The external_id of the user, otherwise null.

Example
1{
2  "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
3  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
4  "reference_id": "VOIE815035bf",
5  "generated_at": "2023-03-09T16:22:06.081Z",
6  "type": "voie",
7  "status": "generated",
8  "file_url": "www.argyle.com/storagename",
9  "last_synced_at": "2023-03-09T14:08:25.069Z",
10  "accounts": [
11    {
12      "id": "0187c66e-e7e5-811c-b006-2232f00f426a",
13      "item": "item_123456789",
14      "last_synced_at": "2023-03-09T14:08:25.069105Z"
15    },
16    {
17      "id": "0185a8b8-60eb-80ca-7482-5f24504573f7",
18      "item": "item_000000001",
19      "last_synced_at": "2023-03-01T05:10:59.558295Z"
20    }
21  ],
22  "metadata": {},
23  "external_id": "July_Connection"
24}

#Generate a report

post/v2/reports

Generates a new report and returns a partial report object.

Request body
  • #
    userstring (uuid)
    required

    ID of the user.

  • #
    typestring (enum)
    required

    The type of report to generate.

  • #
    metadataobject
    optional

    Information for internal use, structured as a JSON object.

Example Request
1curl --request POST \
2     --url https://api.argyle.com/v2/reports \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json' \
5     --data '{
6        "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
7        "type": "voie"
8     }'
Example Response
1{
2  "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
3  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
4  "reference_id": "VOIE815035bf",
5  "generated_at": null,
6  "type": "voie",
7  "status": "generating",
8  "file_url": null,
9  "metadata": {}
10}

#Retrieve a report

get/v2/reports/{id}

Retrieves a report object.

Path parameters
  • #
    idstring (uuid)
    required

    ID of the report object to be retrieved.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/reports/{id} \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1{
2  "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
3  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
4  "reference_id": "VOIE815035bf",
5  "generated_at": "2023-03-09T16:22:06.081Z",
6  "type": "voie",
7  "status": "generated",
8  "file_url": "www.argyle.com/storagename",
9  "last_synced_at": "2023-03-09T14:08:25.069Z",
10  "accounts": [
11    {
12      "id": "0187c66e-e7e5-811c-b006-2232f00f426a",
13      "item": "item_123456789",
14      "last_synced_at": "2023-03-09T14:08:25.069105Z"
15    },
16    {
17      "id": "0185a8b8-60eb-80ca-7482-5f24504573f7",
18      "item": "item_000000001",
19      "last_synced_at": "2023-03-01T05:10:59.558295Z"
20    }
21  ],
22  "metadata": {},
23  "external_id": "July_Connection"
24}

#Retrieve a report in JSON

get/v2/reports/{id}.json

(Beta) Retrieves the content of a PDF report in JSON format.

Path parameters
  • #
    id.jsonstring (uuid).json
    optional

    Append .json after the ID of the report object.



    Verification of Employment (VOE) Report:

    Image of Argyle's Verification of Employment (VOE) report.
Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/reports/{id}.json \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example VOE Report JSON
1{
2  "type": "voe",
3  "report_id": "6c3fa756-2e76-43e1-55f6-e29fc6ae535d",
4  "user_id": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
5  "external_id": "March Connection",
6  "generated_at": "2023-03-26T09:19:08.916Z",
7  "last_synced_at": "2023-03-24T12:41:21.576Z",
8  "accounts": [
9    {
10      "account": "018728a3-afee-5288-8e8a-c68ceb591359",
11      "full_name": "Bob Jones",
12      "ssn": "522-09-1191",
13      "employer": "Whole Goods",
14      "employer_address": {
15        "city": "New York",
16        "country": "US",
17        "state": "NY",
18        "postal_code": "10014",
19        "line1": "852 North W St",
20        "line2": null
21      },
22      "status": "active",
23      "job_title": "Store Manager",
24      "start_date": "2020-08-28",
25      "end_date": null,
26      "last_pay_period_end_date": "2023-03-22",
27      "last_paystub_date": "2023-03-24"
28    },
29    {
30      "account": "018728a2-2fe0-cdb4-9486-70b2fe9834f9",
31      "full_name": "Bob Jones",
32      "ssn": "522-09-1191",
33      "employer": "Bullseye",
34      "employer_address": {
35        "city": "New York",
36        "country": "US",
37        "state": "NY",
38        "postal_code": "10014",
39        "line1": "119 Green Ridge",
40        "line2": null
41      },
42      "status": "active",
43      "job_title": "Clerk",
44      "start_date": "2020-06-29",
45      "end_date": null,
46      "last_pay_period_end_date": "2023-02-23",
47      "last_paystub_date": "2023-02-24"
48    }
49  ]
50}

    Verification of Income and Employment (VOIE) Report:

    Image of Argyle's Verification of Employment (VOE) report.

Example VOIE Report JSON
1{
2  "type": "voie",
3  "report_id": "6da4c9a3-2e63-95e5-8be3-f9a52ddc489a",
4  "user_id": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
5  "external_id": "March Connection",
6  "generated_at": "2023-03-26T09:20:06.081Z",
7  "last_synced_at": "2023-03-24T12:41:25.069Z",
8  "accounts": [
9    {
10      "account": "018728a3-afee-5288-8e8a-c68ceb591359",
11      "full_name": "Bob Jones",
12      "birth_date": "1980-10-10",
13      "ssn": "522-09-1191",
14      "phone_number": "+18009000010",
15      "email": "[email protected]",
16      "employer": "Whole Goods",
17      "employee_address": {
18        "city": "New York",
19        "country": "US",
20        "state": "NY",
21        "postal_code": "10014",
22        "line1": "342 Fence Rd",
23        "line2": null
24      },
25      "employer_address": {
26        "city": "New York",
27        "country": "US",
28        "state": "NY",
29        "postal_code": "10014",
30        "line1": "852 North W St",
31        "line2": null
32      },
33      "status": "active",
34      "job_title": "Store Manager",
35      "start_date": "2020-08-28",
36      "end_date": null,
37      "last_pay_period_end_date": "2023-03-22",
38      "last_paystub_date": "2023-03-24",
39      "base_pay": {
40        "amount": "75372.62",
41        "currency": "USD",
42        "period": "annual"
43      },
44      "pay_cycle": "monthly",
45      "income": [
46        {
47          "period": "2023",
48          "currency": "USD",
49          "employer": "Whole Goods",
50          "gross_pay": {
51            "total": 25124.2,
52            "base": 25124.2,
53            "overtime": 0,
54            "commission": 0,
55            "bonus": 0,
56            "other": 0
57          },
58          "reimbursements": 8.13,
59          "deductions": 816.53,
60          "taxes": 5715.75,
61          "fees": 0,
62          "net_pay": 18600.05
63        },
64        {
65          "period": "2022",
66          "currency": "USD",
67          "employer": "Whole Goods",
68          "gross_pay": {
69            "total": 82866.32,
70            "base": 81653.65,
71            "overtime": 0,
72            "commission": 881.09,
73            "bonus": 331.58,
74            "other": 0
75          },
76          "reimbursements": 4.35,
77          "deductions": 3266.12,
78          "taxes": 14948.85,
79          "fees": 0,
80          "net_pay": 64655.7
81        },
82        {
83          "period": "2021",
84          "currency": "USD",
85          "employer": "Whole Goods",
86          "gross_pay": {
87            "total": 87854.76,
88            "base": 81653.65,
89            "overtime": 5774.51,
90            "commission": 426.6,
91            "bonus": 0,
92            "other": 0
93          },
94          "reimbursements": 26.6,
95          "deductions": 3328.93,
96          "taxes": 16833.19,
97          "fees": 0,
98          "net_pay": 67719.24
99        }
100      ]
101    },
102    {
103      "account": "018728a2-2fe0-cdb4-9486-70b2fe9834f9",
104      "full_name": "Bob Jones",
105      "birth_date": "1980-10-10",
106      "ssn": "522-09-1191",
107      "phone_number": "+18009000010",
108      "email": "[email protected]",
109      "employer": "Bullseye",
110      "employee_address": {
111        "city": "New York",
112        "country": "US",
113        "state": "NY",
114        "postal_code": "10014",
115        "line1": "342 Fence Rd",
116        "line2": null
117      },
118      "employer_address": {
119        "city": "New York",
120        "country": "US",
121        "state": "NY",
122        "postal_code": "10014",
123        "line1": "119 Green Ridge",
124        "line2": null
125      },
126      "status": "active",
127      "job_title": "Clerk",
128      "start_date": "2020-06-29",
129      "end_date": null,
130      "last_pay_period_end_date": "2023-02-23",
131      "last_paystub_date": "2023-02-24",
132      "base_pay": {
133        "amount": "61030.57",
134        "currency": "USD",
135        "period": "annual"
136      },
137      "pay_cycle": "monthly",
138      "income": [
139        {
140          "period": "2023",
141          "currency": "USD",
142          "employer": "Bullseye",
143          "gross_pay": {
144            "total": 20848.92,
145            "base": 20343.52,
146            "overtime": 0,
147            "commission": 0,
148            "bonus": 505.4,
149            "other": 0
150          },
151          "reimbursements": 0,
152          "deductions": 915.48,
153          "taxes": 4475.58,
154          "fees": 0,
155          "net_pay": 15457.86
156        },
157        {
158          "period": "2022",
159          "currency": "USD",
160          "employer": "Bullseye",
161          "gross_pay": {
162            "total": 68070.08,
163            "base": 66116.44,
164            "overtime": 0,
165            "commission": 777.54,
166            "bonus": 1176.1,
167            "other": 0
168          },
169          "reimbursements": 18.4,
170          "deductions": 2034.4,
171          "taxes": 13274.18,
172          "fees": 0,
173          "net_pay": 52779.9
174        },
175        {
176          "period": "2021",
177          "currency": "USD",
178          "employer": "Bullseye",
179          "gross_pay": {
180            "total": 68378.52,
181            "base": 66116.44,
182            "overtime": 0,
183            "commission": 641.94,
184            "bonus": 1620.14,
185            "other": 0
186          },
187          "reimbursements": 20.27,
188          "deductions": 1881.82,
189          "taxes": 13731.92,
190          "fees": 0,
191          "net_pay": 52785.05
192        }
193      ]
194    }
195  ],
196  "income_totals": [
197    {
198      "period": "2023",
199      "period_total": {
200        "currency": "USD",
201        "gross_pay": {
202          "total": 45973.12,
203          "base": 45467.72,
204          "overtime": 0,
205          "commission": 0,
206          "bonus": 505.4,
207          "other": 0
208        },
209        "reimbursements": 8.13,
210        "deductions": 1732.01,
211        "taxes": 10191.33,
212        "fees": 0,
213        "net_pay": 34057.91
214      }
215    },
216    {
217      "period": "2022",
218      "period_total": {
219        "currency": "USD",
220        "gross_pay": {
221          "total": 150936.4,
222          "base": 147770.09,
223          "overtime": 0,
224          "commission": 1658.63,
225          "bonus": 1507.68,
226          "other": 0
227        },
228        "reimbursements": 22.75,
229        "deductions": 5300.52,
230        "taxes": 28223.03,
231        "fees": 0,
232        "net_pay": 117435.6
233      }
234    },
235    {
236      "period": "2021",
237      "period_total": {
238        "currency": "USD",
239        "gross_pay": {
240          "total": 156233.28,
241          "base": 147770.09,
242          "overtime": 5774.51,
243          "commission": 1068.54,
244          "bonus": 1620.14,
245          "other": 0
246        },
247        "reimbursements": 46.87,
248        "deductions": 5210.75,
249        "taxes": 30565.11,
250        "fees": 0,
251        "net_pay": 120504.29
252      }
253    }
254  ]
255}

#Delete a report

delete/v2/reports/{id}

Deletes a report object.

Path parameters
  • #
    idstring (uuid)
    required

    ID of the report object to be deleted.

Example Request
1curl --request DELETE \
2     --url https://api.argyle.com/v2/reports/{id} \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1"204 status code: No content."

#List all reports

get/v2/reports

Returns an array of all report objects.

Query parameters
  • #
    userstring (uuid)
    optional

    Filter by user ID.

  • #
    limitinteger
    optional

    Number of report objects returned per page. Default: 10. Maximum: 200.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/reports?limit=2 \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1[
2  {
3    "id": "5b3fa756-1d76-43e1-55f6-e29fc6ae535d",
4    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
5    "reference_id": "VOE5a80a995",
6    "generated_at": "2023-03-01T22:45:08.916Z",
7    "type": "voe",
8    "status": "generated",
9    "file_url": "www.argyle.com/storagename",
10    "last_synced_at": "2023-03-01T19:20:21.576Z",
11    "accounts": [
12      {
13        "id": "018e6a25-130b-3b98-a3ca-1658cb3afc26",
14        "item": "item_987654321",
15        "last_synced_at": "2023-03-01T19:20:21.576363Z"
16      }
17    ],
18    "metadata": {},
19    "external_id": null
20  },
21  {
22    "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
23    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
24    "reference_id": "VOIE815035bf",
25    "generated_at": "2023-03-09T16:22:06.081Z",
26    "type": "voie",
27    "status": "generated",
28    "file_url": "www.argyle.com/storagename",
29    "last_synced_at": "2023-03-09T14:08:25.069Z",
30    "accounts": [
31      {
32        "id": "0187c66e-e7e5-811c-b006-2232f00f426a",
33        "item": "item_123456789",
34        "last_synced_at": "2023-03-09T14:08:25.069105Z"
35      },
36      {
37        "id": "0185a8b8-60eb-80ca-7482-5f24504573f7",
38        "item": "item_000000001",
39        "last_synced_at": "2023-03-01T05:10:59.558295Z"
40      }
41    ],
42    "metadata": {},
43    "external_id": "July_Connection"
44  }
45]

#List report availability

get/v2/reports/availability

Returns an array of all reports that can be generated for the specified user, which accounts will be used to generate each type of report, and the timestamp (ISO 8601) each account was last scanned for new data.

An empty accounts array means the report type cannot be generated.

Query parameters
  • #
    userstring (uuid)
    required

    ID of the user.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/reports/availability?user=0186c5b8-8fa1-67b3-39af-14b3e18da8a7 \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1[
2  {
3    "voie": {
4      "accounts": [
5        {
6          "id": "0185a8b8-60eb-80ca-7482-5f24504573f7",
7          "last_synced_at": "2023-03-31T14:31:10.133Z"
8        },
9        {
10          "id": "01856c65-43b6-8b5d-b32a-56b8fbda5c28",
11          "last_synced_at": "2023-02-31T14:31:10.133Z"
12        }
13      ]
14    },
15    "voe": {
16      "accounts": [
17        {
18          "id": "0185a8b8-60eb-80ca-7482-5f24504573f7",
19          "last_synced_at": "2023-03-31T14:31:10.133Z"
20        },
21        {
22          "id": "01856c65-43b6-8b5d-b32a-56b8fbda5c28",
23          "last_synced_at": "2023-02-31T14:31:10.133Z"
24        }
25      ]
26    }
27  }
28]
Updating Argyle status...
┬ę 2024 Argyle Systems Inc.argyle.com