GET api/chargecodetypes?includeChargeCodes={includeChargeCodes}&isCreditsFromConnectEnabled={isCreditsFromConnectEnabled}
GET: api/chargecodetypes
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
includeChargeCodes |
|
boolean |
Default value is False |
isCreditsFromConnectEnabled |
|
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of ChargeCodeTypeViewModelName | Description | Type | Additional information |
---|---|---|---|
ChargeCodeTypeId |
ChargeCodeTypeId |
integer |
None. |
TypeDescription |
TypeDescription |
string |
Required Max length: 50 |
PrepayApplicable |
PrepayApplicable |
integer |
Required Range: inclusive between 1 and 1.79769313486232E+308 |
Display |
Display |
integer |
Required Range: inclusive between 1 and 1.79769313486232E+308 |
ChargeCodes |
ChargeCodes |
Collection of ChargeCodeViewModel |
None. |
Response Formats
application/json, text/json
[ { "chargeCodeTypeId": 1, "typeDescription": "sample string 2", "prepayApplicable": 3, "display": 4, "chargeCodes": [ { "id": 1, "displayCode": "sample string 2", "chargeCodeDescription": "sample string 3", "vacancyLoss": 4, "firstMonth": 1, "prepaymentApplicable": 5, "applyinMonthlyCharges": 6, "feeScheduleId": 1, "isAutoAssigned": true }, { "id": 1, "displayCode": "sample string 2", "chargeCodeDescription": "sample string 3", "vacancyLoss": 4, "firstMonth": 1, "prepaymentApplicable": 5, "applyinMonthlyCharges": 6, "feeScheduleId": 1, "isAutoAssigned": true } ] }, { "chargeCodeTypeId": 1, "typeDescription": "sample string 2", "prepayApplicable": 3, "display": 4, "chargeCodes": [ { "id": 1, "displayCode": "sample string 2", "chargeCodeDescription": "sample string 3", "vacancyLoss": 4, "firstMonth": 1, "prepaymentApplicable": 5, "applyinMonthlyCharges": 6, "feeScheduleId": 1, "isAutoAssigned": true }, { "id": 1, "displayCode": "sample string 2", "chargeCodeDescription": "sample string 3", "vacancyLoss": 4, "firstMonth": 1, "prepaymentApplicable": 5, "applyinMonthlyCharges": 6, "feeScheduleId": 1, "isAutoAssigned": true } ] } ]
application/xml, text/xml
<ArrayOfChargeCodeTypeViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.ChargeCodeType"> <ChargeCodeTypeViewModel> <ChargeCodeTypeId>1</ChargeCodeTypeId> <ChargeCodes xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels"> <d3p1:ChargeCodeViewModel> <d3p1:ApplyinMonthlyCharges>6</d3p1:ApplyinMonthlyCharges> <d3p1:ChargeCodeDescription>sample string 3</d3p1:ChargeCodeDescription> <d3p1:DisplayCode>sample string 2</d3p1:DisplayCode> <d3p1:FeeScheduleId>1</d3p1:FeeScheduleId> <d3p1:FirstMonth>1</d3p1:FirstMonth> <d3p1:Id>1</d3p1:Id> <d3p1:IsAutoAssigned>true</d3p1:IsAutoAssigned> <d3p1:PrepaymentApplicable>5</d3p1:PrepaymentApplicable> <d3p1:VacancyLoss>4</d3p1:VacancyLoss> </d3p1:ChargeCodeViewModel> <d3p1:ChargeCodeViewModel> <d3p1:ApplyinMonthlyCharges>6</d3p1:ApplyinMonthlyCharges> <d3p1:ChargeCodeDescription>sample string 3</d3p1:ChargeCodeDescription> <d3p1:DisplayCode>sample string 2</d3p1:DisplayCode> <d3p1:FeeScheduleId>1</d3p1:FeeScheduleId> <d3p1:FirstMonth>1</d3p1:FirstMonth> <d3p1:Id>1</d3p1:Id> <d3p1:IsAutoAssigned>true</d3p1:IsAutoAssigned> <d3p1:PrepaymentApplicable>5</d3p1:PrepaymentApplicable> <d3p1:VacancyLoss>4</d3p1:VacancyLoss> </d3p1:ChargeCodeViewModel> </ChargeCodes> <Display>4</Display> <PrepayApplicable>3</PrepayApplicable> <TypeDescription>sample string 2</TypeDescription> </ChargeCodeTypeViewModel> <ChargeCodeTypeViewModel> <ChargeCodeTypeId>1</ChargeCodeTypeId> <ChargeCodes xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels"> <d3p1:ChargeCodeViewModel> <d3p1:ApplyinMonthlyCharges>6</d3p1:ApplyinMonthlyCharges> <d3p1:ChargeCodeDescription>sample string 3</d3p1:ChargeCodeDescription> <d3p1:DisplayCode>sample string 2</d3p1:DisplayCode> <d3p1:FeeScheduleId>1</d3p1:FeeScheduleId> <d3p1:FirstMonth>1</d3p1:FirstMonth> <d3p1:Id>1</d3p1:Id> <d3p1:IsAutoAssigned>true</d3p1:IsAutoAssigned> <d3p1:PrepaymentApplicable>5</d3p1:PrepaymentApplicable> <d3p1:VacancyLoss>4</d3p1:VacancyLoss> </d3p1:ChargeCodeViewModel> <d3p1:ChargeCodeViewModel> <d3p1:ApplyinMonthlyCharges>6</d3p1:ApplyinMonthlyCharges> <d3p1:ChargeCodeDescription>sample string 3</d3p1:ChargeCodeDescription> <d3p1:DisplayCode>sample string 2</d3p1:DisplayCode> <d3p1:FeeScheduleId>1</d3p1:FeeScheduleId> <d3p1:FirstMonth>1</d3p1:FirstMonth> <d3p1:Id>1</d3p1:Id> <d3p1:IsAutoAssigned>true</d3p1:IsAutoAssigned> <d3p1:PrepaymentApplicable>5</d3p1:PrepaymentApplicable> <d3p1:VacancyLoss>4</d3p1:VacancyLoss> </d3p1:ChargeCodeViewModel> </ChargeCodes> <Display>4</Display> <PrepayApplicable>3</PrepayApplicable> <TypeDescription>sample string 2</TypeDescription> </ChargeCodeTypeViewModel> </ArrayOfChargeCodeTypeViewModel>