Payouts

The payout object

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.

These are the attributes of the payout object, categorized for convenience:

• Summary information
• Period hours and pay
• YTD hours and pay
• Detailed itemization of gross pay, deductions, taxes, and destinations
• Additional information
• Objects within a payout

Summary information

Basic attributes that provide general details about a payout.

Period hours and pay

Attributes that contain information about the period hours and pay for a payout.

YTD hours and pay

Attributes that contain information about the year-to-date hours and pay for a payout.

📘

Argyle does not calculate these YTD values. These fields return YTD values found on the user’s paystub.

Detailed itemization

Attributes that provide a detailed list of gross pay, deduction, tax line, and destinations items for a payout.

Additional information

Supplementary attributes that contain additional metadata from a payout and link it to more Argyle data.

Objects within a payout

This section details the attributes of child objects that can appear within a payout:

• employer_address
• filing_status
• gross_pay_list
• gross_pay_list_totals
• deduction_list
• tax_list
• destinations

Attributes of employer_address

The collection of attributes that provide the address details of the user's employer.

Attributes of filing_status

The collection of attributes that provide the user’s tax filing status for this payout.

Attributes of gross_pay_list

gross_pay_list is an array of objects that represents an itemized list of gross pay entries for this payout. Each object corresponds to one line item and contains the following attributes.

Attributes of gross_pay_list_totals

gross_pay_list_totals add up the values of gross_pay_list objects based on their type.

Attributes of gross_pay_list_totals.base

Attributes of gross_pay_list_totals.overtime

Attributes of gross_pay_list_totals.bonus

Attributes of gross_pay_list_totals.commission

Attributes of gross_pay_list_totals.other

Attributes of deduction_list

deduction_list is an array of objects that represents an itemized list of deductions for this payout. Each object corresponds to one line item, and contains the following attributes.

Attributes of tax_list

tax_list is an array of objects that represents an itemized list of tax withholdings for this payout. Each object corresponds to one line item, and contains the following attributes.

Attributes of destinations

The destinations array of objects details how the user’s net pay is distributed.

Attributes of destinations.bank_account

These attributes contain information about the user’s banks registered on the payroll account.

Attributes of destinations.card

These attributes contain information about the user’s associated cards on the payroll account.

Endpoints

These are the endpoints available for payouts.

Sample object

This is a sample of a complete payout object.

{
    "id": "018286d8-e69a-7ec5-d291-561ccb5ece34",
    "account": "018286d6-7b6b-f79c-4c8c-d30d9177d175",
    "document_id": "018286d8-e648-926a-3e55-86be9a33a1a7",
    "deduction_list": [
        {
            "amount": "347.00",
            "name": "Med",
            "tax_classification": "pre_tax",
            "amount_ytd": "347.00"
        },
        {
            "amount": "27.39",
            "name": "Vision FT",
            "tax_classification": "pre_tax",
            "amount_ytd": "27.39"
        },
        {
            "amount": "39.20",
            "name": "Dental FT",
            "tax_classification": "pre_tax",
            "amount_ytd": "39.20"
        },
        {
            "amount": "57.09",
            "name": "Future Cntrb",
            "tax_classification": "pre_tax",
            "amount_ytd": "57.09"
        },
        {
            "amount": "1.00",
            "name": "Gnomer Fnd",
            "tax_classification": "post_tax",
            "amount_ytd": "1.00"
        },
        {
            "amount": "6.88",
            "name": "AD&D",
            "tax_classification": "post_tax",
            "amount_ytd": "6.88"
        }
    ],
    "filing_status": [
        {
            "type": "federal",
            "location": null,
            "status": "married"
        },
        {
            "type": "state",
            "location": null,
            "status": "married"
        }
    ],
    "tax_list": [
        {
            "amount": "45.15",
            "name": "OASDI",
            "type": "fica",
            "amount_ytd": "45.15"
        },
        {
            "amount": "10.56",
            "name": "Medicare",
            "type": "fica",
            "amount_ytd": "10.56"
        },
        {
            "amount": "0.58",
            "name": "Federal Withholding",
            "type": "federal",
            "amount_ytd": "0.58"
        },
        {
            "amount": "6.76",
            "name": "State Tax - CA",
            "type": "state",
            "amount_ytd": "6.76"
        },
        {
            "amount": "8.01",
            "name": "CA SDI - CASDI",
            "type": "state",
            "amount_ytd": "8.01"
        }
    ],
    "status": "completed",
    "type": "direct_deposit",
    "payout_date": "2022-01-14T00:00:00Z",
    "payout_period": {
        "start_date": "2021-12-27T00:00:00Z",
        "end_date": "2022-01-09T00:00:00Z"
    },
    "currency": "USD",
    "gross_pay": "1141.84",
    "deductions": "478.56",
    "taxes": "71.06",
    "net_pay": "593.22",
    "bonuses": null,
    "commission": null,
    "overtime": null,
    "reimbursements": null,
    "hours": "56.00",
    "fees": null,
    "net_pay_ytd": "593.22",
    "gross_pay_ytd": "1141.84",
    "metadata": {},
    "employer": "GNOME DEPOT U.S.A., INC.",
    "employer_address": {
        "city": "Atlanta",
        "state": "GA",
        "country": "US",
        "postal_code": "30339",
        "line1": "53 First Street",
        "line2": null
    },
    "created_at": "2022-08-10T08:22:18.645Z",
    "updated_at": "2022-08-10T08:22:18.645Z",
    "destinations": [
        {
            "reference": null,
            "amount": "593.22",
            "bank_account": {
                "routing_number": null,
                "account_number": "******0019",
                "bank_name": "FREEDOM BANK"
            },
            "card": null,
            "method": null,
            "metadata": null
        }
    ],
    "hours_ytd": null,
    "deductions_ytd": "478.56",
    "taxes_ytd": "71.06",
    "gross_pay_list": [
        {
            "name": "Regular",
            "type": "regular",
            "start_date": "2021-12-27",
            "end_date": "2022-01-02",
            "rate": "20.3900",
            "hours": "16.0000",
            "amount": "326.24",
            "hours_ytd": "20.22",
            "amount_ytd": null
        },
        {
            "name": "Regular",
            "type": "regular",
            "start_date": "2022-01-03",
            "end_date": "2022-01-09",
            "rate": "20.3900",
            "hours": "32.0000",
            "amount": "652.48",
            "hours_ytd": null,
            "amount_ytd": "978.72"
        },
        {
            "name": "Holiday Pay",
            "type": "holiday",
            "start_date": "2021-12-27",
            "end_date": "2022-01-09",
            "rate": "20.3900",
            "hours": "8.0000",
            "amount": "163.12",
            "hours_ytd": null,
            "amount_ytd": "163.12"
        },
        {
            "name": "COVID Expense",
            "type": "other",
            "start_date": "2021-12-27",
            "end_date": "2022-01-09",
            "rate": "0.0000",
            "hours": "0.0000",
            "amount": "1.00",
            "hours_ytd": null,
            "amount_ytd": "1.00"
        }
    ],
    "gross_pay_list_totals": {
        "base": {
            "amount": "1141.84",
            "amount_ytd": "1141.84",
            "hours": "56.0000",
            "hours_ytd": null,
            "rate_implied": "20.3900",
            "rate_implied_ytd": null
        },
        "overtime": null,
        "commission": null,
        "bonus": null,
        "other": {
            "amount": "1.00",
            "amount_ytd": "1.00",
            "hours": "0.0000",
            "hours_ytd": null,
            "rate_implied": null,
            "rate_implied_ytd": null
        }
    }
}