# Create a charge split

**POST /api/v1/charge-split**




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


## Authentication methods
- Personal access token & O auth2


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




### Body: application/json (object)

- **splitable_type** (string)
  The model type the charge split is being added to. Valid options are: client, plan, charge
- **splitable_uuid** (string)
  The model UUID belonging to the splitable_type the charge split is being added to
- **account_uuid** (string)
  The account UUID of who will be receiving this charge split
- **charge_split_schema_uuid** (string)
  The charge split schema that defines the parameters of this charge split
- **percentage** (number)
  Percentage of charge that the introducer will receive. Must be within the provided charge split schema min and max percentage bounds
- **transfer_fci** (boolean)
  Whether the account will receive FCI recognition for this charge split. Provided charge split schema must allow option to be changed
- **initial** (boolean)
  Whether this charge split will be applied to initial charges. Provided charge split schema must allow option to be changed
- **ongoing** (boolean)
  Whether this charge split will be applied to ongoing charges. Provided charge split schema must allow option to be changed
- **apply_to_plans** (boolean)
  When adding a charge split against a client, you can choose whether to automatically apply to the client's plans too. Must be null or false for a plan splitable_type


## Responses
### 201


#### Body: 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.
- **splitable_type** (string)
  The model type this charge split belongs to.
- **splitable** (object)
  Model this charge split belongs to e.g. plan
- **account** (object)
  Account who will be receiving this charge split
- **charge_split_schema** (object)
  The charge split schema model that defined the parameters of this charge split
- **percentage** (number)
  How much of the expectation the given account is expected to receive
- **percentage_paid_by_firm** (integer)
  How much of the charge split amount will be paid by the firm
- **percentage_paid_by_adviser** (integer)
  How much of the charge split amount will be paid by the adviser
- **transfer_fci** (string)
  Whether the account will receive FCI recognition for this expectation amount
- **initial** (string)
  Whether the charge split will apply to initial charges
- **ongoing** (string)
  Whether the charge split will apply to ongoing charges
- **apply_to_plans** (boolean)
  When adding this charge split to a client, setting this to true will automatically apply the charge split to all of the client's plans


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