Create an employee's home address
POST {{baseUrl}}/v1/employees/:employee_id/home_addresses
The home address of an employee is used to determine certain tax information about them. Addresses are geocoded on create and update to ensure validity.
Supports home address effective dating and courtesy withholding.
scope: employees:write
Request Body
{"street_1"=>"<string>", "street_2"=>"<string>", "city"=>"<string>", "state"=>"<string>", "zip"=>"<string>", "effective_date"=>"<date>", "courtesy_withholding"=>"<boolean>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"uuid":"56260b3d-c375-415c-b77a-75d99f717193","employee_id":12345,"street_1":"644 Fay Vista","street_2":"Suite 842","city":"Richmond","state":"VA","zip":"23218","country":"USA","active":false,"effective_date":"2021-01-01","courtesy_withholding":true}