# Update withdrawal

**PUT /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/withdrawals/{WithdrawalGUID}**

This endpoint allows users to update a withdrawal for a household saving.


## 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.
- **SavingsGUID** (string(uuid))
  The SavingsGUID for the withdrawal you want to update.
- **WithdrawalGUID** (string(uuid))
  The WithdrawalGUID you want to update.


### Body: application/json (object)

- **TransactionType** (integer)
  If SavingsType is any of the following: 7, 8, 9, 10, 11, 12, 14, 17, 18, 19, or 21 then the allowed types are 6, and 7.
  Finally, if none of the above conditions are met then the only allowed type is 7.
- **TransactionAmount** (number(float) | null)
  This field is required if the value of TransactionPercentage is not = 0.
  TransactionAmount must be greater than 0.
- **TransactionPercentage** (number(float) | null)
  This field is required if the value of TransactionAmount is not = 0.
  TransactionPercentage must be greater than 0.
- **Frequency** (integer | 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/{HouseholdGUID}/savings/withdrawals/options
- **StartBasis** (integer)
  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}/savings/withdrawals/options
- **StartEventGUID** (string(uuid) | null)
  This field is required if the value of StartBasis = 4.

  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}/savings/withdrawals/options
- **StartAge** (integer | null)
  This field is required if the value of StartBasis = 2 or 7.
- **StartDate** (string | null)
  This field is required if the value of StartBasis = 3.

  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.
- **EndBasis** (integer | null)
  This field is required if the value of Frequency is not = 120 and the value of TransactionType is not = 8.

  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}/savings/withdrawals/options
- **EndEventGUID** (string(uuid) | null)
  This field is required if the value of EndBasis = 4 and the value of Frequency is not = 120 and the value of TransactionType is not = 8.
  Event end must be after starting.

  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}/savings/withdrawals/options
- **EndAge** (integer | null)
  This field is required if the value of EndBasis = 2 or 7 and the value of Frequency is not = 120 and the value of TransactionType is not = 8.
  EndAge must be after starting.
- **EndDate** (string | null)
  This field is required if the value of EndBasis = 3 and the value of Frequency is not = 120 and the value of TransactionType is not = 8.
  EndDate must be after starting.

  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.
- **BackOfficeID** (string | null)

- **BackOfficeSync** (integer | null)
  An integer representing the status of the back office sync:
    - 1: Yes
    - 2: No
    - 3: Only update from back office
- **ReduceFund** (integer)
  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}/savings/withdrawals/options
- **ExcludeFormattedValues** (string | null)
  If set to any value, formatted values will be excluded from the response.
- **TakeNaturalIncome** (integer | 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/{HouseholdGUID}/savings/withdrawals/options.


## Responses
### 200
Success

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

- **data** (object)


### 403
Permission error.

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

- **message** (string)


### 404
Household not found

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

- **message** (string)


### 422
Validation error.

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

- **message** (string)

- **data** (object)
  Example validation error message.

### 500
Internal server error.

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

- **message** (string)



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