POST api/chargeCodes/inquiry

Get all charge codes

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ChargeCodeIds	Collection of integer	None.
EntityId	integer	None.
VacancyLoss	integer	None.
PrepaymentApplicable	integer	None.
ApplyInMonthlyCharges	integer	None.
ChargeCodeTypeIds	Collection of integer	None.
CorporateBillingIds	Collection of integer	None.
FirstMonthIds	Collection of integer	None.
FeeScheduleIds	Collection of integer	None.
SortInformation	SortInformationViewModel	None.

Request Formats

application/json, text/json

Sample:

{
  "chargeCodeIds": [
    1,
    2
  ],
  "entityId": 1,
  "vacancyLoss": 1,
  "prepaymentApplicable": 1,
  "applyInMonthlyCharges": 1,
  "chargeCodeTypeIds": [
    1,
    2
  ],
  "corporateBillingIds": [
    1,
    2
  ],
  "firstMonthIds": [
    1,
    2
  ],
  "feeScheduleIds": [
    1,
    2
  ],
  "sortInformation": {
    "sortBy": "sample string 1",
    "isSortAscending": true
  }
}

application/xml, text/xml

Sample:

<ChargeCodesRequestViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.ChargeCode">
  <ApplyInMonthlyCharges>1</ApplyInMonthlyCharges>
  <ChargeCodeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ChargeCodeIds>
  <ChargeCodeTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ChargeCodeTypeIds>
  <CorporateBillingIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CorporateBillingIds>
  <EntityId>1</EntityId>
  <FeeScheduleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FeeScheduleIds>
  <FirstMonthIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FirstMonthIds>
  <PrepaymentApplicable>1</PrepaymentApplicable>
  <SortInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.SortInformation">
    <d2p1:IsSortAscending>true</d2p1:IsSortAscending>
    <d2p1:SortBy>sample string 1</d2p1:SortBy>
  </SortInformation>
  <VacancyLoss>1</VacancyLoss>
</ChargeCodesRequestViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ChargeCodesRequestViewModel'.

Response Information

Resource Description

BaseSearchResultViewModelOfGetChargeCodeViewModel

Name	Description	Type	Additional information
Items		Collection of GetChargeCodeViewModel	None.
TotalCount		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "items": [
    {
      "corporateBilling": "sample string 1",
      "chargeCodeType": "sample string 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
        }
      ],
      "linkedEntitiesCount": 3,
      "id": 4,
      "displayCode": "sample string 5",
      "chargeCodeDescription": "sample string 6",
      "vacancyLoss": 7,
      "firstMonth": 1,
      "prepaymentApplicable": 8,
      "applyinMonthlyCharges": 9,
      "feeScheduleId": 1,
      "isAutoAssigned": true
    },
    {
      "corporateBilling": "sample string 1",
      "chargeCodeType": "sample string 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
        }
      ],
      "linkedEntitiesCount": 3,
      "id": 4,
      "displayCode": "sample string 5",
      "chargeCodeDescription": "sample string 6",
      "vacancyLoss": 7,
      "firstMonth": 1,
      "prepaymentApplicable": 8,
      "applyinMonthlyCharges": 9,
      "feeScheduleId": 1,
      "isAutoAssigned": true
    }
  ],
  "totalCount": 1
}

application/xml, text/xml

Sample:

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