# Create household

**POST /api/v2/household**

This endpoint allows users to create a new household.


## Servers
- https://api.fincalc.co.uk: https://api.fincalc.co.uk ()


## Authentication methods
- Bearer auth


## Parameters



## Body parameters
Content-type: application/json

- **ClientGUID** (string(uuid))
  
- **RelatedClientGUID** (string(uuid) | null)
  RelatedClientGUID must be different from ClientGUID
- **HouseholdLabel** (string | null)
  
- **BaselineAssumptionSetGUID** (string(uuid) | null)
  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/options

- **ExcludeFormattedValues** (string | null)
  If set to any value, formatted values will be excluded from the response.


## Responses
### 200: Success

#### Body Parameters: application/json (object)
- **success** (boolean)
  
- **data** (object)
  
- **message** (string)
  

### 403: Permission error.

#### Body Parameters: application/json (object)
- **success** (boolean)
  
- **message** (string)
  

### 404: Client not found.

#### Body Parameters: application/json (object)
- **success** (boolean)
  
- **message** (string)
  

### 409: Unable to edit client due to status of clients.

#### Body Parameters: application/json (object)
- **success** (boolean)
  
- **message** (string)
  

### 422: Validation error.

#### Body Parameters: application/json (object)
- **success** (boolean)
  
- **message** (string)
  
- **data** (object)
  Example validation error message.


[Powered by Bump.sh](https://bump.sh)