# Create an income

**POST /api/v1/client/{client_uuid}/income**




## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters
#### Headers
- **X-PLANNR-ACCOUNT-UUID** (string)
  

#### Path parameters
- **client_uuid** (string)
  


## Body parameters
Content-type: application/json

- **name** (string)
  The name of the income.
- **type** (string)
  The type of income. Possible values: salary, dividend, bonus, benefit, other, investment, rental, pension, capital_gains, business_loan, investor_funding, grant, charity, crowdfunding, gross_profit, operating_profit, operating_revenue, non_operating_revenue and net_profit.
- **type_other** (string)
  The other type of income. This is required if the type is "other".
- **amount** (integer)
  The amount of the income in pennies. For example, £50,000 would be 5000000.
- **amount_type** (string)
  The type of the amount. Possible values: net and gross.
- **start_date** (string)
  The start date of the income.
- **end_date** (string)
  The end date of the income.
- **frequency** (string)
  The frequency of the income. Possible values: daily, weekly, fortnightly, four_weekly, monthly, bimonthly, quarterly, biannually, annually, adhoc, and one_off.
- **is_taxable** (boolean)
  Denotes if the income is taxable or not.
- **shared_owner_uuid** (string)
  Optional UUID of an owner account. The client must be a shared type.
- **employment_uuid** (string)
  Employment to link to this salary, dividend, bonus, benefit, other type incomes.

## Responses
### 201: 

#### Body Parameters: application/json (object)
- **uuid** (string)
  The UUID of the resource.
- **created_at** (string)
  The timestamp of when the resource was created.
- **updated_at** (string)
  The timestamp of when the resource was updated.
- **name** (string)
  The name of the income.
- **type** (string)
  The type of income.
- **type_other** (string)
  The other type of income, if the type is "other".
- **amount** (object)
  The amount of the income.
- **amount_type** (string)
  The type of the amount.
- **start_date** (string)
  The start date of the income.
- **end_date** (string)
  The end date of the income.
- **frequency** (string)
  The frequency of the income.
- **is_taxable** (boolean)
  Denotes if the income is taxable or not.
- **shared_owner_type** (string)
  Denotes if the employment is shared across the client or belongs to one of the owners of the client. (Only applicable for joint/business/trust clients).
- **shared_owner** (object)
  The owner of the employment. Only provided if the shared_owner_type is "individual".
- **employment** (object)
  Employment of this income.
- **account** (object)
  Account that owns this income.


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