# Update Commission

**PATCH /v1/commissions/{id}**




## Servers
- https://api.lwolf.com/backoffice: https://api.lwolf.com/backoffice ()



## Parameters

### Path parameters
- **id** (string(uuid))
  The id of the commission.


### Body: application/json (object)
The properties of the commission to update.
- **agentId** (string(uuid))
  The unique id of the agent that gets the commission.
- **amount** (number(currency))
  The total commission amount the agent is receiving. This includes any fees that were subtracted.
- **percentage** (number(double))
  The percentage of the total commission for the agent. This will be specified as a decimal. For example, 5% will be specified as 0.05.
- **endCode** (string | null)
  The code representing the end or side of the transaction.
- **endCount** (number(double))
  The total number of ends or sides this commission represents.
- **calculationMethodCode** (string | null)
  The code representing the calculation method used for the commission. This will be "A" for amount or "P" for percentage.


## Responses
### 200
Request succeeded.

#### Body: application/json (object)
- **id** (string(uuid))
  The unique id.
- **createdTimestamp** (string(date-time) | null)
  The date and time of creation in UTC time.
- **modifiedTimestamp** (string(date-time) | null)
  The date and time last modification in UTC time.
- **agentId** (string(uuid))
  The unique id of the agent that gets the commission.
- **officeId** (string(uuid))
  The unique id of the office with which the agent is associated.
- **amount** (number(currency))
  The total commission amount the agent is receiving. This includes any fees that were subtracted.
- **percentage** (number(double))
  The percentage of the total commission for the agent. This will be specified as a decimal. For example, 5% will be specified as 0.05.
- **endCode** (string)
  The code representing the end or side of the transaction.
- **endCount** (number(double))
  The total number of ends or sides this commission represents.
- **calculationMethodCode** (string | null)
  The code representing the calculation method used for the commission. This will be "A" for amount or "P" for percentage.
- **taxAmount** (number(currency))
  The total amount in tax applied to the commission.
- **totalFeeAmount** (number(currency))
  The total amount of fees applied to the commission.
- **totalFeeTaxAmount** (number(currency))
  The total amount in tax applied to just the fees for the commission.
- **fees** (array[object] | null)
  The list of fees associated with the commission.
- **agent** (object)
  A read only representation of an agent.
- **office** (object)
  A read only representation of an office.

### 400
Invalid request. See response body for details.

#### Body: application/json (object)
- **id** (string)
  The unique identifier for the error.
- **code** (integer(int32))
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- **message** (string)
  A summary or short message describing the error.
- **details** (array[string] | null)
  A list of more detailed errors messages.

### 401
Unauthorized. See response body for details.

#### Body: application/json (object)
- **id** (string)
  The unique identifier for the error.
- **code** (integer(int32))
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- **message** (string)
  A summary or short message describing the error.
- **details** (array[string] | null)
  A list of more detailed errors messages.

### 403
Permission denied. See response body for details.

#### Body: application/json (object)
- **id** (string)
  The unique identifier for the error.
- **code** (integer(int32))
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- **message** (string)
  A summary or short message describing the error.
- **details** (array[string] | null)
  A list of more detailed errors messages.

### 404
Not found. See response body for details.

#### Body: application/json (object)
- **id** (string)
  The unique identifier for the error.
- **code** (integer(int32))
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- **message** (string)
  A summary or short message describing the error.
- **details** (array[string] | null)
  A list of more detailed errors messages.

### 422
Validation failed. See response body for details.

#### Body: application/json (object)
- **id** (string)
  The unique identifier for the error.
- **code** (integer(int32))
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- **message** (string)
  A summary or short message describing the error.
- **details** (array[string] | null)
  A list of more detailed errors messages.


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