Retrieve Payroll Income

POST https://{{env_url}}/credit/payroll_income/get

Request Body

{"client_id"=>"{{client_id}}", "secret"=>"{{secret_key}}", "user_token"=>"{{user_token}}"}

RESPONSES

status: OK

{&quot;items&quot;:[{&quot;item_id&quot;:&quot;WdJvAEWZd5tqR5wVKpjrtDZ41Nxdr1flwl4rK&quot;,&quot;payroll_income&quot;:[{&quot;account_id&quot;:&quot;DMoAG3kWM5T3Z5QzrGy8CBMDrrbWPNfnkWD6l&quot;,&quot;pay_stubs&quot;:[{&quot;deductions&quot;:{&quot;breakdown&quot;:[{&quot;current_amount&quot;:1000,&quot;description&quot;:&quot;taxes&quot;,&quot;iso_currency_code&quot;:&quot;USD&quot;,&quot;unofficial_currency_code&quot;:null,&quot;ytd_amount&quot;:1234}],&quot;total&quot;:{&quot;current_amount&quot;:1000,&quot;iso_currency_code&quot;:&quot;USD&quot;,&quot;unofficial_currency_code&quot;:null,&quot;ytd_amount&quot;:1234}},&quot;document_id&quot;:&quot;QVYKRjz2Nj&quot;,&quot;document_metadata&quot;:{&quot;document_type&quot;:&quot;PAYSTUB&quot;,&quot;download_url&quot;:&quot;https://sandbox.plaid.com/income/verification/document/download/b1477df2-1372-492f-ac19-a5a8d0d5c547&quot;,&quot;name&quot;:&quot;603b6fc3-27b0-48c0-add0-57a5886036c5.pdf&quot;,&quot;status&quot;:&quot;DOCUMENT_STATUS_PROCESSING_COMPLETE&quot;},&quot;earnings&quot;:{&quot;breakdown&quot;:[{&quot;canonical_description&quot;:&quot;REGULAR_PAY&quot;,&quot;current_amount&quot;:1006,&quot;description&quot;:&quot;salary earned&quot;,&quot;hours&quot;:40,&quot;iso_currency_code&quot;:&quot;USD&quot;,&quot;rate&quot;:25.15,&quot;unofficial_currency_code&quot;:null,&quot;ytd_amount&quot;:1006},{&quot;canonical_description&quot;:&quot;BONUS&quot;,&quot;current_amount&quot;:1000,&quot;description&quot;:&quot;bonus earned&quot;,&quot;hours&quot;:0,&quot;iso_currency_code&quot;:&quot;USD&quot;,&quot;rate&quot;:0,&quot;unofficial_currency_code&quot;:null,&quot;ytd_amount&quot;:1000},{&quot;canonical_description&quot;:&quot;OVERTIME&quot;,&quot;current_amount&quot;:320,&quot;description&quot;:&quot;overtime pay earned&quot;,&quot;hours&quot;:10,&quot;iso_currency_code&quot;:&quot;USD&quot;,&quot;rate&quot;:32,&quot;unofficial_currency_code&quot;:null,&quot;ytd_amount&quot;:320}],&quot;total&quot;:{&quot;current_amount&quot;:2306,&quot;hours&quot;:50,&quot;iso_currency_code&quot;:&quot;USD&quot;,&quot;unofficial_currency_code&quot;:null,&quot;ytd_amount&quot;:2306}},&quot;employee&quot;:{&quot;address&quot;:{&quot;city&quot;:&quot;Oakland&quot;,&quot;country&quot;:&quot;US&quot;,&quot;postal_code&quot;:&quot;94103&quot;,&quot;region&quot;:&quot;CA&quot;,&quot;street&quot;:&quot;1234 Grand Ave&quot;},&quot;marital_status&quot;:&quot;SINGLE&quot;,&quot;name&quot;:&quot;Josie Georgia Harrison&quot;,&quot;taxpayer_id&quot;:{&quot;id_mask&quot;:&quot;9020&quot;,&quot;id_type&quot;:&quot;SSN&quot;}},&quot;employer&quot;:{&quot;address&quot;:{&quot;city&quot;:&quot;San Francisco&quot;,&quot;country&quot;:&quot;US&quot;,&quot;postal_code&quot;:&quot;94103&quot;,&quot;region&quot;:&quot;CA&quot;,&quot;street&quot;:&quot;1098 Main Street&quot;},&quot;name&quot;:&quot;Platypus LLC&quot;},&quot;net_pay&quot;:{&quot;current_amount&quot;:1000,&quot;description&quot;:&quot;net pay&quot;,&quot;iso_currency_code&quot;:&quot;USD&quot;,&quot;unofficial_currency_code&quot;:null,&quot;ytd_amount&quot;:1234},&quot;pay_period_details&quot;:{&quot;distribution_breakdown&quot;:null,&quot;end_date&quot;:&quot;2022-04-06&quot;,&quot;gross_earnings&quot;:2306,&quot;iso_currency_code&quot;:&quot;USD&quot;,&quot;pay_amount&quot;:1000,&quot;pay_date&quot;:&quot;2022-04-07&quot;,&quot;pay_frequency&quot;:&quot;BIWEEKLY&quot;,&quot;start_date&quot;:&quot;2022-03-23&quot;,&quot;unofficial_currency_code&quot;:null},&quot;verification&quot;:{&quot;verification_attributes&quot;:null,&quot;verification_status&quot;:&quot;UNKNOWN&quot;}},{&quot;deductions&quot;:{&quot;breakdown&quot;:[{&quot;current_amount&quot;:1000,&quot;description&quot;:&quot;taxes&quot;,&quot;iso_currency_code&quot;:&quot;USD&quot;,&quot;unofficial_currency_code&quot;:null,&quot;ytd_amount&quot;:1234}],&quot;total&quot;:{&quot;current_amount&quot;:1000,&quot;iso_currency_code&quot;:&quot;USD&quot;,&quot;unofficial_currency_code&quot;:null,&quot;ytd_amount&quot;:1234}},&quot;document_id&quot;:&quot;jnYrqlM2w3&quot;,&quot;document_metadata&quot;:{&quot;document_type&quot;:&quot;PAYSTUB&quot;,&quot;download_url&quot;:&quot;https://sandbox.plaid.com/income/verification/document/download/c88d8753-7d1f-437d-83fd-f446d53a7957&quot;,&quot;name&quot;:&quot;3653b6d4-7b49-465a-b6df-40bade95b9fb.pdf&quot;,&quot;status&quot;:&quot;DOCUMENT_STATUS_PROCESSING_COMPLETE&quot;},&quot;earnings&quot;:{&quot;breakdown&quot;:[{&quot;canonical_description&quot;:&quot;REGULAR_PAY&quot;,&quot;current_amount&quot;:1006,&quot;description&quot;:&quot;salary earned&quot;,&quot;hours&quot;:40,&quot;iso_currency_code&quot;:&quot;USD&quot;,&quot;rate&quot;:25.15,&quot;unofficial_currency_code&quot;:null,&quot;ytd_amount&quot;:1006},{&quot;canonical_description&quot;:&quot;BONUS&quot;,&quot;current_amount&quot;:1000,&quot;description&quot;:&quot;bonus earned&quot;,&quot;hours&quot;:0,&quot;iso_currency_code&quot;:&quot;USD&quot;,&quot;rate&quot;:0,&quot;unofficial_currency_code&quot;:null,&quot;ytd_amount&quot;:1000},{&quot;canonical_description&quot;:&quot;OVERTIME&quot;,&quot;current_amount&quot;:320,&quot;description&quot;:&quot;overtime pay earned&quot;,&quot;hours&quot;:10,&quot;iso_currency_code&quot;:&quot;USD&quot;,&quot;rate&quot;:32,&quot;unofficial_currency_code&quot;:null,&quot;ytd_amount&quot;:320}],&quot;total&quot;:{&quot;current_amount&quot;:2306,&quot;hours&quot;:50,&quot;iso_currency_code&quot;:&quot;USD&quot;,&quot;unofficial_currency_code&quot;:null,&quot;ytd_amount&quot;:2306}},&quot;employee&quot;:{&quot;address&quot;:{&quot;city&quot;:&quot;Oakland&quot;,&quot;country&quot;:&quot;US&quot;,&quot;postal_code&quot;:&quot;94103&quot;,&quot;region&quot;:&quot;CA&quot;,&quot;street&quot;:&quot;1234 Grand Ave&quot;},&quot;marital_status&quot;:&quot;SINGLE&quot;,&quot;name&quot;:&quot;Josie Georgia Harrison&quot;,&quot;taxpayer_id&quot;:{&quot;id_mask&quot;:&quot;9020&quot;,&quot;id_type&quot;:&quot;SSN&quot;}},&quot;employer&quot;:{&quot;address&quot;:{&quot;city&quot;:&quot;San Francisco&quot;,&quot;country&quot;:&quot;US&quot;,&quot;postal_code&quot;:&quot;94103&quot;,&quot;region&quot;:&quot;CA&quot;,&quot;street&quot;:&quot;1098 Main Street&quot;},&quot;name&quot;:&quot;Platypus LLC&quot;},&quot;net_pay&quot;:{&quot;current_amount&quot;:1000,&quot;description&quot;:&quot;net pay&quot;,&quot;iso_currency_code&quot;:&quot;USD&quot;,&quot;unofficial_currency_code&quot;:null,&quot;ytd_amount&quot;:1234},&quot;pay_period_details&quot;:{&quot;distribution_breakdown&quot;:null,&quot;end_date&quot;:&quot;2022-03-07&quot;,&quot;gross_earnings&quot;:2306,&quot;iso_currency_code&quot;:&quot;USD&quot;,&quot;pay_amount&quot;:1000,&quot;pay_date&quot;:&quot;2022-03-08&quot;,&quot;pay_frequency&quot;:&quot;BIWEEKLY&quot;,&quot;start_date&quot;:&quot;2022-02-21&quot;,&quot;unofficial_currency_code&quot;:null},&quot;verification&quot;:{&quot;verification_attributes&quot;:null,&quot;verification_status&quot;:&quot;UNKNOWN&quot;}}],&quot;w2s&quot;:[{&quot;allocated_tips&quot;:&quot;1000&quot;,&quot;box_12&quot;:[{&quot;amount&quot;:&quot;200&quot;,&quot;code&quot;:&quot;A&quot;}],&quot;box_9&quot;:&quot;box9&quot;,&quot;dependent_care_benefits&quot;:&quot;1000&quot;,&quot;document_id&quot;:&quot;1XOzJdPONE&quot;,&quot;document_metadata&quot;:{&quot;document_type&quot;:&quot;US_TAX_W2&quot;,&quot;download_url&quot;:&quot;https://sandbox.plaid.com/income/verification/document/download/52afb553-86f3-4306-9314-d073a7d4fec9&quot;,&quot;name&quot;:&quot;a781d158-589e-4b8b-a617-63fc9aa11dd6.pdf&quot;,&quot;status&quot;:&quot;DOCUMENT_STATUS_PROCESSING_COMPLETE&quot;},&quot;employee&quot;:{&quot;address&quot;:{&quot;city&quot;:&quot;Oakland&quot;,&quot;country&quot;:&quot;US&quot;,&quot;postal_code&quot;:&quot;94103&quot;,&quot;region&quot;:&quot;CA&quot;,&quot;street&quot;:&quot;1234 Grand Ave&quot;},&quot;marital_status&quot;:null,&quot;name&quot;:&quot;Josie Georgia Harrison&quot;,&quot;taxpayer_id&quot;:{&quot;id_mask&quot;:null,&quot;id_type&quot;:null}},&quot;employer&quot;:{&quot;address&quot;:{&quot;city&quot;:&quot;San Francisco&quot;,&quot;country&quot;:&quot;US&quot;,&quot;postal_code&quot;:&quot;94103&quot;,&quot;region&quot;:&quot;CA&quot;,&quot;street&quot;:&quot;1098 Main Street&quot;},&quot;name&quot;:&quot;Platypus LLC&quot;},&quot;employer_id_number&quot;:&quot;12-1234567&quot;,&quot;federal_income_tax_withheld&quot;:&quot;1000&quot;,&quot;medicare_tax_withheld&quot;:&quot;1000&quot;,&quot;medicare_wages_and_tips&quot;:&quot;1000&quot;,&quot;nonqualified_plans&quot;:&quot;1000&quot;,&quot;other&quot;:&quot;other&quot;,&quot;retirement_plan&quot;:&quot;CHECKED&quot;,&quot;social_security_tax_withheld&quot;:&quot;1000&quot;,&quot;social_security_tips&quot;:&quot;1000&quot;,&quot;social_security_wages&quot;:&quot;1000&quot;,&quot;state_and_local_wages&quot;:[{&quot;employer_state_id_number&quot;:&quot;11111111111AAA&quot;,&quot;local_income_tax&quot;:&quot;200&quot;,&quot;local_wages_tips&quot;:&quot;200&quot;,&quot;locality_name&quot;:&quot;local&quot;,&quot;state&quot;:&quot;CA&quot;,&quot;state_income_tax&quot;:&quot;200&quot;,&quot;state_wages_tips&quot;:&quot;200&quot;}],&quot;statutory_employee&quot;:&quot;CHECKED&quot;,&quot;tax_year&quot;:&quot;2021&quot;,&quot;third_party_sick_pay&quot;:&quot;CHECKED&quot;,&quot;wages_tips_other_comp&quot;:&quot;1000&quot;}]}]}],&quot;request_id&quot;:&quot;FpUjNNsGIcILsbT&quot;}