# Create event

**POST /api/v2/household/{HouseholdGUID}/events**

This endpoint allows users to create a new event for a household.


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


## Authentication methods
- Bearer auth


## Parameters

#### Path parameters
- **HouseholdGUID** (string(uuid))
  The HouseholdGUID of the client.


## Body parameters
Content-type: application/json

- **ClientGUID** (string(uuid) | null)
  This field is required if the value of EventBasis = 2:
ClientGUID must be in the household.

- **EventLabel** (string)
  The following characters are not permitted: \\:*"<>|
- **EventBasis** (integer)
  An integer representing the status of the type of event:
  - 1: Date
  - 2: Age
  - 3: Linked to another event

- **LinkedEventGUID** (string(uuid) | null)
  This field is required if the value of EventBasis = 3:

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/{HouseholdGUID}/events/options

- **OffsetBasis** (integer | null)
  An integer representing before or after:
- 1: Before
- 2: After

This field is required if the value of EventBasis = 3.

- **OffsetYears** (integer | null)
  This field is required if the value of EventBasis = 3.
OffsetYears and OffsetMonths must resolve to a date in the future.

- **OffsetMonths** (integer | null)
  OffsetYears and OffsetMonths must resolve to a date in the future.

- **AgeYears** (integer | null)
  This field is required if the value of EventBasis = 2.
Age Years + Age Months should be in the future

- **AgeMonths** (integer | null)
  This field is required if the value of EventBasis = 2.
Age Years + Age Months should be in the future

- **EventDate** (string(date) | null)
  This field is required if the value of EventBasis = 1.
Date must be after today.

Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023.

- **GoalSet** (integer | null)
  
- **GoalPriority** (integer | null)
  If you do not enter a value then a default value will be applied.

- **GoalYears1** (integer | null)
  This field is required if the value of GoalSet = 1.
It should be an integer between 1 and 50 (inclusive) to specify the number of years, 99 for 'For life', or 120 for 'One off' (only available on GoalYear1).

- **GoalAmount1** (integer | null)
  This field is required if the value of GoalSet = 1.

- **GoalYears2** (integer | null)
  This field is required if the value of GoalSet = 1 AND the value of GoalAmount2 is set.
Should be set to an integer from 1 to 50 (inclusive) for the number of years, or set to 99 for Lifetime.

- **GoalAmount2** (integer | null)
  This field is required if the value of GoalSet = 1 AND the value of GoalYears2 is set.

- **GoalYears3** (integer | null)
  This field is required if the value of GoalSet = 1 AND the value of GoalAmount3 is set.
Should be set to an integer from 1 to 50 (inclusive) for the number of years, or set to 99 for Lifetime.

- **GoalAmount3** (integer | null)
  This field is required if the value of GoalSet = 1 AND the value of GoalYears3 is set.

- **GoalYears4** (integer | null)
  This field is required if the value of GoalSet = 1 AND the value of GoalAmount4 is set.
Should be set to an integer from 1 to 50 (inclusive) for the number of years, or set to 99 for Lifetime.

- **GoalAmount4** (integer | null)
  This field is required if the value of GoalSet = 1 AND the value of GoalYears4 is set.

- **GoalYears5** (integer | null)
  This field is required if the value of GoalSet = 1 AND the value of GoalAmount5 is set.
Should be set to an integer from 1 to 50 (inclusive) for the number of years, or set to 99 for Lifetime.

- **GoalAmount5** (integer | null)
  This field is required if the value of GoalSet = 1 AND the value of GoalYears5 is set.

- **EventIcon** (string | null)
  Chose one of the preselected font awesome icons.
If you do not enter an icon then a default icon will be applied.

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/{HouseholdGUID}/events/options

- **EventColour** (string | null)
  Enter a colour code that is 6 characters long, like "C3A1F6." You can include "#" at the beginning, like "#C3A1F6," or leave it out.
If you do not enter a value then a default value will be applied.

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


## Responses
### 201: Success

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

### 403: Permission error.

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

### 404: Household not found

#### 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.

### 500: Internal server error.

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


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