GuidesAPI ReferenceChangelogAPI PolicyAPI StatusGusto Security
Changelog
These docs are for v2023-09-01. Click to read the latest docs for v2024-04-01.
improved

Updated external_payroll flow type

Gusto Embedded has updated the external_payroll flow so you can now:

  1. Connect the external_payroll flow to the company_onboarding flow
curl --request 'https://api.gusto-demo.com/v1/companies/{{company_uuid}}/flows' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{access_toke}}n' \
--data '{
 "flow_type": "company_onboarding",
 "options": { "external_payroll" : true }
}'
  1. Adds "Add Previous Payroll Records" as a step for Get the company's onboarding status by including the query param ?additional_steps=external_payroll

📘

Note:

external_payroll is not an onboarding requirement but should be completed before an employer runs their first payroll. This is so Gusto can accurately calculate and report taxes through the rest of the year.

curl --location 'https://api.gusto-demo.com/v1/companies/{{company_uuid}}/onboarding_status?additional_steps=external_payroll' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{access_token}}' \
        {
            "title": "Add Previous Payroll Records",
            "id": "external_payroll",
            "required": true,
            "completed": false,
            "skippable": false,
            "requirements": [
                "add_employees"
            ]
        }
  1. Add dismissed employees prior to entering previous payrolls