>  Switch To Link 5 and API v2 Documentation

Payouts

Learn about the /payouts endpoint.

payouts are machine-readable, normalized versions of traditional paystubs. Each payout object corresponds to a single paystub that is available in a user's payroll account.


#The payout object

Argyle does not calculate YTD values. All YTD values are as they appear on the user's paystubs.

Attributes
  • #
    idstring (uuid)

    Unique ID for this payout.

  • #
    accountstring (uuid)

    ID of the account with which this payout is associated.

    Use this ID to retrieve account details by making the following API call: GET /accounts/{id}.

  • #
    document_idstring (uuid)

    Unique ID of the Argyle document object that corresponds to this payout.

    Use this ID (if available) to retrieve a PDF of this payout as it appears in the user's payroll account, using the following API call: GET /documents/{id}.

  • #
    metadataobject

    Contains any additional information available about this payout.

  • #
    created_atstring (timestamp)

    Time at which the payout object was created. Timestamps follow the ISO 8601 standard.

  • #
    updated_atstring (timestamp)

    Time at which the payout object was last updated. Timestamps follow the ISO 8601 standard.

  • #
    employerstring

    The name of the company that employs the user.

  • #
    employer_addressobject

    The employer's address.

  • #
    line1string

    Address line 1. For example, street, PO Box, or company name.

  • #
    line2string

    Address line 2. For example, apartment, suite, unit, or building.

  • #
    citystring

    City, district, suburb, town, or village.

  • #
    statestring

    State, county, province, or region.

  • #
    postal_codestring

    ZIP or postal code.

  • #
    countrystring

    Two-letter country code returned in the ISO 3166-1 alpha-2 format.

  • #
    statusstring (enum)

    The status of the payout.

  • #
    payout_datestring (timestamp)

    The payout execution date. Timestamps follow the ISO 8601 standard.

  • #
    payout_periodobject

  • #
    start_datestring (timestamp)

    The start date of the work period for this payout. Timestamps follow the ISO 8601 standard.

  • #
    end_datestring (timestamp)

    The end date of the work period for this payout. Timestamps follow the ISO 8601 standard.

  • #
    typestring (enum)

    The method by which the payout was delivered. (See destinations for more details on how a user's net pay is distributed.)

  • #
    currencystring

    The currency of the payout—for example, USD or EUR. Currencies follow the ISO 4217 format.

  • #
    hoursstring

    Total number of hours filed for the payout period.

  • #
    gross_paystring

    The amount earned by the user before any taxes or deductions.

  • #
    net_paystring

    The amount sent to a user after all taxes and deductions.

  • #
    reimbursementsstring

    Compensation to the user for covering work-related expenses out-of-pocket.

  • #
    deductionsstring

    The monetary subtractions from the user's payout.

  • #
    taxesstring

    The amount of taxes withheld from the user's gross pay.

  • #
    feesstring

    The fee associated with receiving the payout.

  • #
    overtime *DEPRECATEDstring

    The amount received by the user from working overtime.


    Deprecated in favor of gross_pay_list_totals.overtime.

  • #
    bonuses *DEPRECATEDstring

    Additional amount added to the base pay.


    Deprecated in favor of gross_pay_list_totals.bonus.

  • #
    commission *DEPRECATEDstring

    A fee paid to a user for transacting a piece of business, like closing a sale or making a deal.


    Deprecated in favor of gross_pay_list_totals.commission.

  • #
    hours_ytdstring

    The total number of hours filed for this calendar year, including this payout's period.

  • #
    gross_pay_ytdstring

    The amount of gross pay earned in this calendar year, including this payout's period.

  • #
    net_pay_ytdstring

    The amount of net pay received in this calendar year, including this payout's period.

  • #
    deductions_ytdstring

    Total deductions subtracted from payouts during this calendar year, including this payout's period.

  • #
    taxes_ytdstring

    Total taxes that have been withheld during this calendar year, including this payout’s period.

  • #
    filing_statusarray of objects

    Contains objects that describe the user's tax filing status for this payout.

  • #
    statusstring

    Filing status.

  • #
    typestring (enum)

    The type of filing status.

  • #
    locationstring (enum)

    The location of the filing. Depends on filing_status.type.

  • #
    gross_pay_listarray of objects

    An itemized list of gross pay entries for this payout. Represented as an array of objects, with each object corresponding to one line item.

  • #
    namestring

    The name of this gross pay item as shown on the payout, such as, but not limited to: Referral bonus, Sales commission, Overtime FLSA.

  • #
    typestring

    The type of this gross pay item. This is derived from gross_pay_list.name. Used in gross_pay_list_totals.

  • #
    start_datestring (timestamp)

    The start date of the work period for this gross pay item. Timestamps follow the ISO 8601 standard.

  • #
    end_datestring (timestamp)

    The end date of the work period for this gross pay item. Timestamps follow the ISO 8601 standard.

  • #
    ratestring

    The hourly rate of the users' earnings for this gross pay item.

  • #
    hoursstring

    The number of hours filed for this gross pay item during the period.

  • #
    amountstring

    The amount that the user earned for this gross pay item during the period.

  • #
    hours_ytdstring

    The number of hours filed for this gross pay item in the calendar year including this payout's period.

  • #
    amount_ytdstring

    The total amount earned by the user for this gross pay item in the calendar year including this payout's period.

  • #
    gross_pay_list_totalsobject

    Sums of hour and pay values across gross_pay_list objects based on their type.

  • #
    base | overtime | commission | bonus | otherobjects

    Adds up hour and pay values across each of these gross_pay_list types.

  • #
    hoursstring

    Sum of gross_pay_list.hours values for this type.

  • #
    amountstring

    Sum of gross_pay_list.amount values for this type.

  • #
    rate_impliedstring

    The calculated ratio of gross_pay_list_totals.amount and gross_pay_list_totals.hours for this type.

  • #
    hours_ytdstring

    Sum of gross_pay_list.hours_ytd for this type.

  • #
    amount_ytdstring

    Sum of gross_pay_list.amount_ytd for this type.

  • #
    rate_implied_ytdstring

    The calculated rate of gross_pay_list_totals.amount_ytd and gross_pay_list_totals.hours_ytd for this type.

  • #
    deduction_listarray of objects

    An itemized list of deductions for this payout. Represented as an array of objects, with each object corresponding to one line item.

  • #
    namestring

    The name of the deduction as shown in the payout, such as, but not limited to: Dental, Vision, Roth.

  • #
    amountstring

    The amount of the deduction.

  • #
    amount_ytdstring

    The total amount deducted in the calendar year including this payout's period.

  • #
    tax_classificationstring

    The tax classification of the deduction.

  • #
    tax_listarray of objects

    An itemized list of tax withholdings for this payout. Represented as an array of objects, with each object corresponding to one line item.

  • #
    namestring

    The name of the tax, as shown on the payout. A few common examples are Federal Withholding, Social Security Tax, Medicare.

  • #
    typestring

    The type of the tax.

  • #
    amountstring

    The amount of the tax.

  • #
    amount_ytdstring

    The amount withheld for each individual tax filed in this payout in the calendar year including this payout's period.

  • #
    destinationsarray of objects

    A list of destinations to which the earnings for this payout were sent. Represented as an array of objects, with each object corresponding to one payout destination.

  • #
    referencestring

    Reference describing the destination. Might include elements of bank name, account number—for example: Checking - XXXXXXXXXX1234 or Reserve GoodBank.

  • #
    amountstring

    The amount of money from this paystub's net pay that has gone to this destination.

  • #
    bank_accountobject

    Shows details for a bank account used as a destination for this payout.

  • #
    bank_namestring

    Name of the bank for this bank account.

  • #
    routing_numberstring

    9-digit code that is based on the bank location where the user's account was opened.

  • #
    account_numberstring

    5 to 17-digit code that identifies the user as the account holder in the bank. In most cases, the account number will be 8-17 digits long.

  • #
    cardobject

    Shows details for a card used as a destination for this payout.

  • #
    namestring

    The name of the card that is registered on the payroll account.

    This attribute does not represent the cardholder's name.

  • #
    card_numberstring

    The card number that is registered on the payroll account.

  • #
    methodstring

    Name of the method used to deliver funds to the user's destination—for example: Direct Deposit, Pay Card.

  • #
    metadataobject

    Metadata holds additional available, often unstructured, information about this destination.



Example
1{
2  "id": "018286d8-e69a-7ec5-d291-561ccb5ece34",
3  "account": "018286d6-7b6b-f79c-4c8c-d30d9177d175",
4  "document_id": "018286d8-e648-926a-3e55-86be9a33a1a7",
5  "metadata": {},
6  "created_at": "2022-08-10T08:22:18.645Z",
7  "updated_at": "2022-08-10T08:22:18.645Z",
8  "employer": "GNOME DEPOT U.S.A., INC.",
9  "employer_address": {
10    "line1": "53 First Street",
11    "line2": null,
12    "city": "Atlanta",
13    "state": "GA",
14    "postal_code": "30339",
15    "country": "US"
16  },
17  "status": "completed",
18  "payout_date": "2022-01-14T00:00:00Z",
19  "payout_period": {
20    "start_date": "2021-12-27T00:00:00Z",
21    "end_date": "2022-01-09T00:00:00Z"
22  },
23  "type": "direct_deposit",
24  "currency": "USD",
25  "hours": "56.00",
26  "gross_pay": "1141.84",
27  "net_pay": "593.22",
28  "reimbursements": null,
29  "deductions": "478.56",
30  "taxes": "71.06",
31  "fees": null,
32  "overtime": null,
33  "bonuses": null,
34  "commission": null,
35  "hours_ytd": null,
36  "gross_pay_ytd": "1141.84",
37  "net_pay_ytd": "593.22",
38  "deductions_ytd": "478.56",
39  "taxes_ytd": "71.06",
40  "filing_status": [
41    {
42      "type": "federal",
43      "location": null,
44      "status": "married"
45    },
46    {
47      "type": "state",
48      "location": null,
49      "status": "married"
50    }
51  ],
52  "gross_pay_list": [
53    {
54      "name": "Regular",
55      "type": "regular",
56      "start_date": "2021-12-27",
57      "end_date": "2022-01-02",
58      "rate": "20.3900",
59      "hours": "16.0000",
60      "amount": "326.24",
61      "hours_ytd": "20.22",
62      "amount_ytd": null
63    },
64    {
65      "name": "Regular",
66      "type": "regular",
67      "start_date": "2022-01-03",
68      "end_date": "2022-01-09",
69      "rate": "20.3900",
70      "hours": "32.0000",
71      "amount": "652.48",
72      "hours_ytd": null,
73      "amount_ytd": "978.72"
74    },
75    {
76      "name": "Holiday Pay",
77      "type": "holiday",
78      "start_date": "2021-12-27",
79      "end_date": "2022-01-09",
80      "rate": "20.3900",
81      "hours": "8.0000",
82      "amount": "163.12",
83      "hours_ytd": null,
84      "amount_ytd": "163.12"
85    },
86    {
87      "name": "COVID Expense",
88      "type": "other",
89      "start_date": "2021-12-27",
90      "end_date": "2022-01-09",
91      "rate": "0.0000",
92      "hours": "0.0000",
93      "amount": "1.00",
94      "hours_ytd": null,
95      "amount_ytd": "1.00"
96    }
97  ],
98  "gross_pay_list_totals": {
99    "base": {
100      "hours": "56.0000",
101      "amount": "1141.84",
102      "rate_implied": "20.3900",
103      "hours_ytd": null,
104      "amount_ytd": "1141.84",
105      "rate_implied_ytd": null
106    },
107    "overtime": null,
108    "commission": null,
109    "bonus": null,
110    "other": {
111      "hours": "0.0000",
112      "amount": "1.00",
113      "rate_implied": null,
114      "hours_ytd": null,
115      "amount_ytd": "1.00",
116      "rate_implied_ytd": null
117    }
118  },
119  "deduction_list": [
120    {
121      "name": "Med",
122      "amount": "347.00",
123      "amount_ytd": "347.00",
124      "tax_classification": "pre_tax"
125    },
126    {
127      "name": "Vision FT",
128      "amount": "27.39",
129      "amount_ytd": "27.39",
130      "tax_classification": "pre_tax"
131    },
132    {
133      "name": "Dental FT",
134      "amount": "39.20",
135      "amount_ytd": "39.20",
136      "tax_classification": "pre_tax"
137    },
138    {
139      "name": "Future Cntrb",
140      "amount": "57.09",
141      "amount_ytd": "57.09",
142      "tax_classification": "pre_tax"
143    },
144    {
145      "name": "Gnomer Fnd",
146      "amount": "1.00",
147      "amount_ytd": "1.00",
148      "tax_classification": "post_tax"
149    },
150    {
151      "name": "AD&D",
152      "amount": "6.88",
153      "amount_ytd": "6.88",
154      "tax_classification": "post_tax"
155    }
156  ],
157  "tax_list": [
158    {
159      "name": "OASDI",
160      "type": "fica",
161      "amount": "45.15",
162      "amount_ytd": "45.15"
163    },
164    {
165      "name": "Medicare",
166      "type": "fica",
167      "amount": "10.56",
168      "amount_ytd": "10.56"
169    },
170    {
171      "name": "Federal Withholding",
172      "type": "federal",
173      "amount": "0.58",
174      "amount_ytd": "0.58"
175    },
176    {
177      "name": "State Tax - CA",
178      "type": "state",
179      "amount": "6.76",
180      "amount_ytd": "6.76"
181    },
182    {
183      "name": "CA SDI - CASDI",
184      "type": "state",
185      "amount": "8.01",
186      "amount_ytd": "8.01"
187    }
188  ],
189  "destinations": [
190    {
191      "reference": null,
192      "amount": "593.22",
193      "bank_account": {
194        "bank_name": "FREEDOM BANK",
195        "routing_number": null,
196        "account_number": "******0019"
197      },
198      "card": {},
199      "method": null,
200      "metadata": {}
201    }
202  ]
203}

#Retrieve a payout

get/v1/payouts/{id}
  • Retrieve a payout object with the supplied ID.
  • This request returns a payout object if a valid identifier was provided.
Path parameters
  • #
    idstring (uuid)
    required

    The identifier of the payout to be retrieved.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v1/payouts/{id} \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1{
2  "id": "01805174-1999-273f-312d-35433cdfd717",
3  "account": "01805161-796d-b3f1-a0c0-8250dc01efe4",
4  "document_id": "None",
5  "deduction_list": [],
6  "filing_status": [],
7  "tax_list": [],
8  "status": "completed",
9  "type": "direct_deposit",
10  "payout_date": "2022-04-22T11:57:30Z",
11  "payout_period": {
12    "start_date": null,
13    "end_date": null
14  },
15  "currency": "USD",
16  "gross_pay": "80.81",
17  "deductions": null,
18  "taxes": null,
19  "net_pay": "80.81",
20  "bonuses": "3.56",
21  "commission": null,
22  "overtime": null,
23  "reimbursements": null,
24  "hours": null,
25  "fees": null,
26  "net_pay_ytd": "888.63",
27  "gross_pay_ytd": "888.63",
28  "metadata": {},
29  "employer": "uber",
30  "employer_address": null,
31  "destinations": []
32}

#List payouts

get/v1/payouts
  • List all payouts ordered by payout_date, from newest to oldest.
  • This request returns an object with a results property that contains an array of up to limit payout objects.
Query parameters
  • #
    accountstring (uuid)
    optional

    Return only payouts for the account with the provided ID.

  • #
    userstring (uuid)
    optional

    Return only payouts for the user with the provided ID.

  • #
    from_start_datestring (datetime)
    optional

    Return only payouts with payout_date on or after the provided timestamp. Timestamps with dates conforming to the ISO 8601 standard are accepted.

  • #
    to_start_datestring (datetime)
    optional

    Return only payouts with payout_date on or before the provided timestamp. Timestamps with dates conforming to the ISO 8601 standard are accepted.

  • #
    limitinteger
    optional

    The number of payouts objects to be returned. The default is 10. Max value is 200.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v1/payouts?limit=2 \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1[
2  {
3    "id": "01805174-1999-273f-312d-35433cdfd717",
4    "account": "01805161-796d-b3f1-a0c0-8250dc01efe4",
5    "document_id": "None",
6    "deduction_list": [],
7    "filing_status": [],
8    "tax_list": [],
9    "status": "completed",
10    "type": "direct_deposit",
11    "payout_date": "2022-04-22T11:57:30Z",
12    "payout_period": {
13      "start_date": null,
14      "end_date": null
15    },
16    "currency": "USD",
17    "gross_pay": "80.81",
18    "deductions": null,
19    "taxes": null,
20    "net_pay": "80.81",
21    "bonuses": "3.56",
22    "commission": null,
23    "overtime": null,
24    "reimbursements": null,
25    "hours": null,
26    "fees": null,
27    "net_pay_ytd": "888.63",
28    "gross_pay_ytd": "888.63",
29    "metadata": {},
30    "employer": "uber",
31    "employer_address": null,
32    "destinations": []
33  },
34  {
35    "id": "0180519e-709b-4a4e-5f7d-9dd6f3399807",
36    "account": "0180519e-64f5-0107-603a-a460f85c2c50",
37    "document_id": "0180519e-6e7c-7c7d-6cc7-35ec1f6f1656",
38    "deduction_list": [
39      {
40        "amount": "5.51",
41        "name": "Dental",
42        "tax_classification": null
43      },
44      {
45        "amount": "16.53",
46        "name": "Roth",
47        "tax_classification": "post_tax"
48      }
49    ],
50    "filing_status": [
51      {
52        "type": "federal",
53        "location": null,
54        "status": "single"
55      }
56    ],
57    "tax_list": [
58      {
59        "amount": "60.61",
60        "name": "Social Security Tax",
61        "type": "fica"
62      },
63      {
64        "amount": "55.10",
65        "name": "OASDI",
66        "type": "fica"
67      }
68    ],
69    "status": "completed",
70    "type": "direct_deposit",
71    "payout_date": "2022-04-21T14:12:58Z",
72    "payout_period": {
73      "start_date": "2022-03-16T14:12:58Z",
74      "end_date": "2022-04-15T14:12:58Z"
75    },
76    "currency": "USD",
77    "gross_pay": "557.30",
78    "deductions": "22.04",
79    "taxes": "115.71",
80    "net_pay": "423.23",
81    "bonuses": null,
82    "commission": "2.89",
83    "overtime": "3.38",
84    "reimbursements": "3.68",
85    "hours": "12.38",
86    "fees": null,
87    "net_pay_ytd": "13604.72",
88    "gross_pay_ytd": "17196.38",
89    "metadata": {},
90    "employer": "amazin",
91    "employer_address": {
92      "city": "Seattle",
93      "state": "WA",
94      "country": "US",
95      "postal_code": "98109",
96      "line1": "202 Westlake Ave N",
97      "line2": null
98    },
99    "destinations": []
100  }
101]
Updating Argyle status...
© 2024 Argyle Systems Inc.argyle.com