Get a list of charge categories

GET /api/v1/static/charge-categories

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data attributes object
      • name string
      • value string
      • fee boolean
      • commission boolean
      • one_off boolean
      • recurring boolean
      • service_types array[object]
        Hide service_types attributes Show service_types attributes object
        • name string
        • value string
        • initial boolean
        • ongoing boolean
      • rmar_type object
        Hide rmar_type attributes Show rmar_type attributes object
        • name string
        • value string
      • can_change_rmar_type boolean
GET /api/v1/static/charge-categories
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/static/charge-categories' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "data": [
    {
      "fee": true,
      "name": "Adhoc",
      "value": "adhoc",
      "one_off": true,
      "recurring": false,
      "rmar_type": {
        "name": "Adviser Charge",
        "value": "adviser_charge"
      },
      "commission": false,
      "service_types": [
        {
          "name": "Initial",
          "value": "initial",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "One Off",
          "value": "one_off",
          "initial": true,
          "ongoing": false
        }
      ],
      "can_change_rmar_type": false
    },
    {
      "fee": true,
      "name": "Administration",
      "value": "administration",
      "one_off": true,
      "recurring": false,
      "rmar_type": {
        "name": "Other Fee",
        "value": "other_fee"
      },
      "commission": false,
      "service_types": [
        {
          "name": "Initial",
          "value": "initial",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "One Off",
          "value": "one_off",
          "initial": true,
          "ongoing": false
        }
      ],
      "can_change_rmar_type": false
    },
    {
      "fee": true,
      "name": "Adjustment",
      "value": "adjustment",
      "one_off": true,
      "recurring": false,
      "rmar_type": {
        "name": "Other Fee",
        "value": "other_fee"
      },
      "commission": true,
      "service_types": [
        {
          "name": "Initial",
          "value": "initial",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "One Off",
          "value": "one_off",
          "initial": true,
          "ongoing": false
        }
      ],
      "can_change_rmar_type": true
    },
    {
      "fee": false,
      "name": "Bond Renewal",
      "value": "bond_renewal",
      "one_off": false,
      "recurring": false,
      "rmar_type": {
        "name": "Commission",
        "value": "commission"
      },
      "commission": true,
      "service_types": [
        {
          "name": "Initial",
          "value": "initial",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "One Off",
          "value": "one_off",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "Ongoing",
          "value": "ongoing",
          "initial": false,
          "ongoing": true
        }
      ],
      "can_change_rmar_type": false
    },
    {
      "fee": false,
      "name": "Clawback",
      "value": "clawback",
      "one_off": true,
      "recurring": false,
      "rmar_type": {
        "name": "Clawback",
        "value": "clawback"
      },
      "commission": true,
      "service_types": [
        {
          "name": "Initial",
          "value": "initial",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "One Off",
          "value": "one_off",
          "initial": true,
          "ongoing": false
        }
      ],
      "can_change_rmar_type": false
    },
    {
      "fee": false,
      "name": "Dss Rebate",
      "value": "dss_rebate",
      "one_off": false,
      "recurring": false,
      "rmar_type": {
        "name": "Commission",
        "value": "commission"
      },
      "commission": true,
      "service_types": [
        {
          "name": "Initial",
          "value": "initial",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "One Off",
          "value": "one_off",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "Ongoing",
          "value": "ongoing",
          "initial": false,
          "ongoing": true
        }
      ],
      "can_change_rmar_type": false
    },
    {
      "fee": false,
      "name": "Fund",
      "value": "fund",
      "one_off": false,
      "recurring": true,
      "rmar_type": {
        "name": "Commission",
        "value": "commission"
      },
      "commission": true,
      "service_types": [
        {
          "name": "Ongoing",
          "value": "ongoing",
          "initial": false,
          "ongoing": true
        }
      ],
      "can_change_rmar_type": false
    },
    {
      "fee": false,
      "name": "Indemnity",
      "value": "indemnity",
      "one_off": true,
      "recurring": false,
      "rmar_type": {
        "name": "Commission",
        "value": "commission"
      },
      "commission": true,
      "service_types": [
        {
          "name": "Initial",
          "value": "initial",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "One Off",
          "value": "one_off",
          "initial": true,
          "ongoing": false
        }
      ],
      "can_change_rmar_type": false
    },
    {
      "fee": true,
      "name": "Initial Fee",
      "value": "initial_fee",
      "one_off": true,
      "recurring": false,
      "rmar_type": {
        "name": "Adviser Charge",
        "value": "adviser_charge"
      },
      "commission": false,
      "service_types": [
        {
          "name": "Initial",
          "value": "initial",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "One Off",
          "value": "one_off",
          "initial": true,
          "ongoing": false
        }
      ],
      "can_change_rmar_type": false
    },
    {
      "fee": false,
      "name": "Level",
      "value": "level",
      "one_off": true,
      "recurring": false,
      "rmar_type": {
        "name": "Commission",
        "value": "commission"
      },
      "commission": true,
      "service_types": [
        {
          "name": "Initial",
          "value": "initial",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "One Off",
          "value": "one_off",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "Ongoing",
          "value": "ongoing",
          "initial": false,
          "ongoing": true
        }
      ],
      "can_change_rmar_type": false
    },
    {
      "fee": false,
      "name": "Non Indemnity",
      "value": "non_indemnity",
      "one_off": true,
      "recurring": false,
      "rmar_type": {
        "name": "Commission",
        "value": "commission"
      },
      "commission": true,
      "service_types": [
        {
          "name": "Initial",
          "value": "initial",
          "initial": true,
          "ongoing": false
        }
      ],
      "can_change_rmar_type": false
    },
    {
      "fee": true,
      "name": "One Off",
      "value": "one_off",
      "one_off": true,
      "recurring": false,
      "rmar_type": {
        "name": "Adviser Charge",
        "value": "adviser_charge"
      },
      "commission": false,
      "service_types": [
        {
          "name": "Initial",
          "value": "initial",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "One Off",
          "value": "one_off",
          "initial": true,
          "ongoing": false
        }
      ],
      "can_change_rmar_type": false
    },
    {
      "fee": true,
      "name": "Ongoing Fee",
      "value": "ongoing_fee",
      "one_off": false,
      "recurring": true,
      "rmar_type": {
        "name": "Adviser Charge",
        "value": "adviser_charge"
      },
      "commission": false,
      "service_types": [
        {
          "name": "Ongoing",
          "value": "ongoing",
          "initial": false,
          "ongoing": true
        }
      ],
      "can_change_rmar_type": false
    },
    {
      "fee": true,
      "name": "Other Fee",
      "value": "other_fee",
      "one_off": true,
      "recurring": false,
      "rmar_type": {
        "name": "Other Fee",
        "value": "other_fee"
      },
      "commission": false,
      "service_types": [
        {
          "name": "Initial",
          "value": "initial",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "One Off",
          "value": "one_off",
          "initial": true,
          "ongoing": false
        }
      ],
      "can_change_rmar_type": false
    },
    {
      "fee": false,
      "name": "Procuration Fee",
      "value": "procuration_fee",
      "one_off": true,
      "recurring": false,
      "rmar_type": {
        "name": "Commission",
        "value": "commission"
      },
      "commission": true,
      "service_types": [
        {
          "name": "Initial",
          "value": "initial",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "One Off",
          "value": "one_off",
          "initial": true,
          "ongoing": false
        }
      ],
      "can_change_rmar_type": false
    },
    {
      "fee": false,
      "name": "Protected Rights",
      "value": "protected_rights",
      "one_off": false,
      "recurring": false,
      "rmar_type": {
        "name": "Commission",
        "value": "commission"
      },
      "commission": true,
      "service_types": [
        {
          "name": "Initial",
          "value": "initial",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "One Off",
          "value": "one_off",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "Ongoing",
          "value": "ongoing",
          "initial": false,
          "ongoing": true
        }
      ],
      "can_change_rmar_type": false
    },
    {
      "fee": false,
      "name": "Renewal",
      "value": "renewal",
      "one_off": true,
      "recurring": false,
      "rmar_type": {
        "name": "Commission",
        "value": "commission"
      },
      "commission": true,
      "service_types": [
        {
          "name": "Initial",
          "value": "initial",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "One Off",
          "value": "one_off",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "Ongoing",
          "value": "ongoing",
          "initial": false,
          "ongoing": true
        }
      ],
      "can_change_rmar_type": false
    },
    {
      "fee": false,
      "name": "Switch",
      "value": "switch",
      "one_off": false,
      "recurring": false,
      "rmar_type": {
        "name": "Commission",
        "value": "commission"
      },
      "commission": true,
      "service_types": [
        {
          "name": "Initial",
          "value": "initial",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "One Off",
          "value": "one_off",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "Ongoing",
          "value": "ongoing",
          "initial": false,
          "ongoing": true
        }
      ],
      "can_change_rmar_type": false
    },
    {
      "fee": true,
      "name": "Unknown",
      "value": "unknown",
      "one_off": false,
      "recurring": false,
      "rmar_type": {
        "name": "Other Fee",
        "value": "other_fee"
      },
      "commission": true,
      "service_types": [
        {
          "name": "Initial",
          "value": "initial",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "One Off",
          "value": "one_off",
          "initial": true,
          "ongoing": false
        },
        {
          "name": "Ongoing",
          "value": "ongoing",
          "initial": false,
          "ongoing": true
        }
      ],
      "can_change_rmar_type": true
    }
  ]
}