GET api/chargeCodes/getChargeCodesForEntity?entityId={entityId}

Get all Charge Codes assigned to an Entity Ordered by Display Code alphabetically

Request Information

URI Parameters

NameDescriptionTypeAdditional information
entityId

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

ChargeCodeViewModel

Collection of ChargeCodeViewModel
NameDescriptionTypeAdditional information
Id

integer

None.

DisplayCode

string

None.

ChargeCodeDescription

string

None.

VacancyLoss

integer

None.

FirstMonth

integer

None.

PrepaymentApplicable

integer

None.

ApplyinMonthlyCharges

integer

None.

FeeScheduleId

integer

None.

IsAutoAssigned

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "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

Sample:
<ArrayOfChargeCodeViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <ChargeCodeViewModel>
    <ApplyinMonthlyCharges>6</ApplyinMonthlyCharges>
    <ChargeCodeDescription>sample string 3</ChargeCodeDescription>
    <DisplayCode>sample string 2</DisplayCode>
    <FeeScheduleId>1</FeeScheduleId>
    <FirstMonth>1</FirstMonth>
    <Id>1</Id>
    <IsAutoAssigned>true</IsAutoAssigned>
    <PrepaymentApplicable>5</PrepaymentApplicable>
    <VacancyLoss>4</VacancyLoss>
  </ChargeCodeViewModel>
  <ChargeCodeViewModel>
    <ApplyinMonthlyCharges>6</ApplyinMonthlyCharges>
    <ChargeCodeDescription>sample string 3</ChargeCodeDescription>
    <DisplayCode>sample string 2</DisplayCode>
    <FeeScheduleId>1</FeeScheduleId>
    <FirstMonth>1</FirstMonth>
    <Id>1</Id>
    <IsAutoAssigned>true</IsAutoAssigned>
    <PrepaymentApplicable>5</PrepaymentApplicable>
    <VacancyLoss>4</VacancyLoss>
  </ChargeCodeViewModel>
</ArrayOfChargeCodeViewModel>