Payroll Documents

Retrieve metadata and PDF's of paystubs, tax forms, and other payroll documents.

#The payroll document object

Additional scanned information from 1099 and W-2 documents retrieved from connected payroll accounts is returned in the payroll document object.

  • For scanned paystub information, use the Paystubs API endpoint.
  • For uploaded document information, use the User Forms API endpoint.
Attributes
  • idstring (uuid)

    Unique ID of the payroll document object.

    Also the payroll_document ID value of the paystub object.

  • accountstring (uuid)

    ID of the account where the payroll document was sourced.

  • document_numberstring (uuid)

    Identification number that appears on the payroll document.

  • available_datestring (datetime)

    Timestamp (ISO 8601) when the payroll document was made available to the user on the underlying payroll system.

  • expiration_datestring (datetime)

    Timestamp (ISO 8601) when payroll document (such as a driver's license) expires.

  • employerstring

    Employer name.

  • document_typestring (enum)

    The type of payroll document.

  • document_type_descriptionstring

    Description of the payroll document type.

  • file_urlstring

    15 minute download link to the original payroll document file. If the link expires, call this endpoint again to refresh the link.

  • created_atstring (datetime)

    Timestamp (ISO 8601) when the payroll document object was created.

  • updated_atstring (datetime)

    Timestamp (ISO 8601) when a property value of the payroll document object most recently changed.

  • ocr_dataobject

    Argyle scans and provides additional information for 1099 and W-2 documents retrieved from connected payroll accounts.

  • Properties specific to a particular form_type.

  • form_typestring (enum)

    The specific type of 1099 or W-2 document.

  • omb_nostring

    OMB reference number.

  • yearstring

    Calendar year.

  • formobject

    Information scanned from the payroll document.

  • recipientobject

  • namestring

    Recipient name, as it appears on the form.

  • addressobject

    Recipient address, as it appears on the form.

  • recipient_tinstring

    Recipient's tax identification number.

    Not present in 1099-SSA forms.

  • payerobject

  • namestring

    Payer name, as it appears on the form.

  • addressobject

    Payer address, as it appears on the form.

  • payer_tinstring

    Payer's tax identification number.

    Not present in 1099-SSA forms.

  • warningsarray of object

    Information on scan quality and missing fields.

  • field_namestring

    Which field encountered the error.

  • messagestring (enum)

    The field_name and warning message.

  • severityfloat (enum)

    The severity of the encountered issue.

  • confidencestring (enum)

    Indicator of how successful the scanning process went.

  • ocr_page_countinteger

    Number of pages scanned.

  • errorstring (enum)
    optional

    An error was encountered during document retrieval.

  • metadataobject

    Additional, non-categorized information.

Example
1{
2  "id": "0176dc14-bb37-402a-7be1-f5261759fae7",
3  "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
4  "document_number": "AAE3_202203040009",
5  "available_date": "2021-03-14T17:46:25Z",
6  "expiration_date": null,
7  "employer": "GigAndGo",
8  "document_type": "1099",
9  "document_type_description": "1099 Form 2020",
10  "file_url": "www.argyle.com/storagename",
11  "created_at": "2023-03-13T17:46:28.240Z",
12  "updated_at": "2023-03-13T17:46:28.240Z",
13  "ocr_data": {
14    "form_type": "1099-MISC",
15    "omb_no": "1545-0115",
16    "year": "2020",
17    "form": {
18      "recipient": {
19        "name": "BOB JONES",
20        "address": {
21          "city": null,
22          "country": null,
23          "line1": "759 VICTORIA PLAZA",
24          "line2": null,
25          "postal_code": "10014",
26          "state": "NY"
27        }
28      },
29      "recipient_tin": "111-11-1112",
30      "payer": {
31        "name": "WAREHOUSE SERVICES INC",
32        "address": {
33          "city": "SEATTLE",
34          "country": null,
35          "line1": "202 WESTLAKE AVE N (55",
36          "line2": null,
37          "postal_code": "98109",
38          "state": "WA"
39        }
40      },
41      "payer_tin": "11-1111112",
42      "account_no": "000110CHIC/NHO",
43      "rent_1": null,
44      "royalties_2": null,
45      "other_inc_3": null,
46      "fed_inc_4": null,
47      "fishing_5": null,
48      "med_care_6": null,
49      "comp_7": null,
50      "crop_insurance_10": null,
51      "golden_parachute_13": null,
52      "gross_attorney_14": null,
53      "sec_409a_defer_15a": null,
54      "sec_409a_inc_15b": null,
55      "state_tax_16": null,
56      "state_no_17": null,
57      "state_inc": null
58    },
59    "warnings": [
60      {
61        "field_name": "rent_1",
62        "message": "rent_1 value empty/bad format",
63        "severity": 0
64      },
65      {
66        "field_name": "royalties_2",
67        "message": "royalties_2 value empty/bad format",
68        "severity": 0
69      },
70      {
71        "field_name": "other_inc_3",
72        "message": "other_inc_3 value empty/bad format",
73        "severity": 0
74      },
75      {
76        "field_name": "fed_inc_4",
77        "message": "fed_inc_4 value empty/bad format",
78        "severity": 0
79      },
80      {
81        "field_name": "fishing_5",
82        "message": "fishing_5 value empty/bad format",
83        "severity": 0
84      },
85      {
86        "field_name": "med_care_6",
87        "message": "med_care_6 value empty/bad format",
88        "severity": 0
89      },
90      {
91        "field_name": "comp_7",
92        "message": "comp_7 not found",
93        "severity": 0
94      },
95      {
96        "field_name": "crop_insurance_10",
97        "message": "crop_insurance_10 value empty/bad format",
98        "severity": 0
99      },
100      {
101        "field_name": "golden_parachute_13",
102        "message": "golden_parachute_13 value empty/bad format",
103        "severity": 0
104      },
105      {
106        "field_name": "gross_attorney_14",
107        "message": "gross_attorney_14 value empty/bad format",
108        "severity": 0
109      },
110      {
111        "field_name": "sec_409a_defer_15a",
112        "message": "sec_409a_defer_15a value empty/bad format",
113        "severity": 0
114      },
115      {
116        "field_name": "sec_409a_inc_15b",
117        "message": "sec_409a_inc_15b not found",
118        "severity": 0
119      },
120      {
121        "field_name": "state_tax_16",
122        "message": "state_tax_16 value empty/bad format",
123        "severity": 0
124      },
125      {
126        "field_name": "state_no_17",
127        "message": "state_no_17 value empty/bad format",
128        "severity": 0
129      },
130      {
131        "field_name": "state_inc",
132        "message": "state_inc value empty/bad format",
133        "severity": 0
134      }
135    ],
136    "confidence": "EXACT_MATCH",
137    "ocr_page_count": 1
138  },
139  "metadata": {}
140}

#Retrieve a payroll document

get/v2/payroll-documents/{id}

Retrieves a payroll document object.

Path parameters
  • idstring (uuid)
    required

    ID of the payroll document object to be retrieved.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/payroll-documents/{id} \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1{
2  "id": "0183b2c1-02e5-a5e5-38f2-ecd51a5cf3d6",
3  "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
4  "document_number": "AAE3_202203040009",
5  "available_date": "2019-03-14T17:46:25Z",
6  "expiration_date": "2027-03-12T17:46:25Z",
7  "employer": "GigAndGo",
8  "document_type": "drivers-licence",
9  "document_type_description": "Driver's license",
10  "file_url": "www.argyle.com/storagename",
11  "created_at": "2023-03-13T17:46:28.240Z",
12  "updated_at": "2023-03-13T17:46:28.240Z",
13  "ocr_data": {},
14  "metadata": {}
15}

#List all payroll documents

get/v2/payroll-documents

Returns an array of all payroll document objects.

Query parameters
  • accountstring (uuid)
    optional

    Filter by account ID.

  • userstring (uuid)
    optional

    Filter by user ID.

  • from_available_datestring (datetime)
    optional

    Filter by paystubs with an available_date on or after this timestamp (ISO 8601).

  • to_available_datestring (datetime)
    optional

    Filter by paystubs with an available_date on or before this timestamp (ISO 8601).

  • limitinteger
    optional

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

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/payroll-documents?limit=2 \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1[
2  {
3    "id": "0186dc02-05b6-b83f-c366-b39a267e1570",
4    "account": "0185a8b8-60eb-80ca-7482-5f24504573f7",
5    "document_number": null,
6    "available_date": "2020-05-13T17:25:59Z",
7    "expiration_date": null,
8    "employer": "Whole Goods",
9    "document_type": "payout-statement",
10    "document_type_description": null,
11    "file_url": "www.argyle.com/storagename",
12    "created_at": "2023-03-13T17:27:01.501Z",
13    "updated_at": "2023-03-13T17:27:01.501Z",
14    "ocr_data": {},
15    "metadata": {}
16  },
17  {
18    "id": "0176dc14-bb37-402a-7be1-f5261759fae7",
19    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
20    "document_number": "AAE3_202203040009",
21    "available_date": "2019-03-14T17:46:25Z",
22    "expiration_date": "2027-03-12T17:46:25Z",
23    "employer": "GigAndGo",
24    "document_type": "drivers-licence",
25    "document_type_description": "Driver's license",
26    "file_url": "www.argyle.com/storagename",
27    "created_at": "2023-03-13T17:46:28.240Z",
28    "updated_at": "2023-03-13T17:46:28.240Z",
29    "ocr_data": {},
30    "metadata": {}
31  }
32]