GET api/chargeCodes/{chargeCodeId}/getChargeCodeDetailsById

Get charge codes by charge code Id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
chargeCodeId

integer

Required

Body Parameters

None.

Response Information

Resource Description

ChargeCodeDetailsViewModel
NameDescriptionTypeAdditional information
CorporateBillingId

integer

None.

ChargeCodeTypeId

integer

None.

ChargeCodeAdjustedCodes

Collection of GetChargeCodeAdjustedCodeViewModel

None.

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:
{
  "corporateBillingId": 1,
  "chargeCodeTypeId": 2,
  "chargeCodeAdjustedCodes": [
    {
      "adjustedCode": "sample string 1",
      "description": "sample string 2",
      "adjustedCodeType": "sample string 3",
      "adjustedCodeTypeId": 4,
      "chargeCodeAdjustedCodeId": 5,
      "glAccount": "sample string 6",
      "glSubAccount": "sample string 7",
      "glAccountId": 1,
      "glSubAccountId": 1
    },
    {
      "adjustedCode": "sample string 1",
      "description": "sample string 2",
      "adjustedCodeType": "sample string 3",
      "adjustedCodeTypeId": 4,
      "chargeCodeAdjustedCodeId": 5,
      "glAccount": "sample string 6",
      "glSubAccount": "sample string 7",
      "glAccountId": 1,
      "glSubAccountId": 1
    }
  ],
  "id": 3,
  "displayCode": "sample string 4",
  "chargeCodeDescription": "sample string 5",
  "vacancyLoss": 6,
  "firstMonth": 1,
  "prepaymentApplicable": 7,
  "applyinMonthlyCharges": 8,
  "feeScheduleId": 1,
  "isAutoAssigned": true
}

application/xml, text/xml

Sample:
<ChargeCodeDetailsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.ChargeCode">
  <ApplyinMonthlyCharges xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">8</ApplyinMonthlyCharges>
  <ChargeCodeDescription xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">sample string 5</ChargeCodeDescription>
  <DisplayCode xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">sample string 4</DisplayCode>
  <FeeScheduleId xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">1</FeeScheduleId>
  <FirstMonth xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">1</FirstMonth>
  <Id xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">3</Id>
  <IsAutoAssigned xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">true</IsAutoAssigned>
  <PrepaymentApplicable xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">7</PrepaymentApplicable>
  <VacancyLoss xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">6</VacancyLoss>
  <ChargeCodeAdjustedCodes>
    <GetChargeCodeAdjustedCodeViewModel>
      <AdjustedCode>sample string 1</AdjustedCode>
      <AdjustedCodeType>sample string 3</AdjustedCodeType>
      <AdjustedCodeTypeId>4</AdjustedCodeTypeId>
      <ChargeCodeAdjustedCodeId>5</ChargeCodeAdjustedCodeId>
      <Description>sample string 2</Description>
      <GlAccount>sample string 6</GlAccount>
      <GlAccountId>1</GlAccountId>
      <GlSubAccount>sample string 7</GlSubAccount>
      <GlSubAccountId>1</GlSubAccountId>
    </GetChargeCodeAdjustedCodeViewModel>
    <GetChargeCodeAdjustedCodeViewModel>
      <AdjustedCode>sample string 1</AdjustedCode>
      <AdjustedCodeType>sample string 3</AdjustedCodeType>
      <AdjustedCodeTypeId>4</AdjustedCodeTypeId>
      <ChargeCodeAdjustedCodeId>5</ChargeCodeAdjustedCodeId>
      <Description>sample string 2</Description>
      <GlAccount>sample string 6</GlAccount>
      <GlAccountId>1</GlAccountId>
      <GlSubAccount>sample string 7</GlSubAccount>
      <GlSubAccountId>1</GlSubAccountId>
    </GetChargeCodeAdjustedCodeViewModel>
  </ChargeCodeAdjustedCodes>
  <ChargeCodeTypeId>2</ChargeCodeTypeId>
  <CorporateBillingId>1</CorporateBillingId>
</ChargeCodeDetailsViewModel>