Home address

Create the employee's home address.

Scope: employees:write

Attributes

Attribute	Required?	Default
`street_1`	Yes
`street_2`
`city`	Yes
`state`	Yes
`zip`	Yes
`country`		"USA"
`work_from_home`		`false`

Sample JSON

{
  "idempotency_key": "bcfc9744-0ab3-4ef3-ab0d-e728255d659c",
  "batch_action" : "create",
  "batch": [
    {
      "entity_type": "employee",

      "person": {
        "external_id": "employee-abc-123",
        "first_name": "Alice",
        "last_name": "Smith"
      },
      "home_address": {
        "street_1": "456 Oak Ave",
        "city": "Sunnyvale",
        "state": "CA",
        "zip": "94087"
      }
    }
  ]
}

Work from home

If you specify work_from_home as true for an employee, it is invalid to provide a work location.

Gusto Embedded will create a company location using that employee's home address and associate it as their work address.

Example

{
  "idempotency_key": "bcfc9744-0ab3-4ef3-ab0d-e728255d659c",
  "batch_action" : "create",
  "batch": [
    {
      "entity_type": "employee",

      "person": {
        "external_id": "employee-abc-123",
        "first_name": "Alice",
        "last_name": "Smith"
      },
      "home_address": {
        "street_1": "456 Oak Ave",
        "city": "Sunnyvale",
        "state": "CA",
        "zip": "94087",
        "work_from_home": true
      }
      # work_address not allowed
    }
  ]
}

Check here to see how this looks in the context of a full batch example.