POST api/charges/month

Monthly charges that are returned for a given community / firm based on posting month.

Request Information

Parameters

Name	Description	Additional information
request		Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "PropertyId": "sample string 1",
  "ManagementFirmName": "sample string 2",
  "PostingMonth": "2024-09-19T11:41:21.1443632-06:00"
}

application/xml, text/xml

Sample:

<MonthlyChargesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <ManagementFirmName>sample string 2</ManagementFirmName>
  <PostingMonth>2024-09-19T11:41:21.1443632-06:00</PostingMonth>
  <PropertyId>sample string 1</PropertyId>
</MonthlyChargesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

application/json, text/json

Sample:

{
  "response": {
    "Code": "sample string 1",
    "Message": "sample string 2",
    "Description": "sample string 3",
    "Link": "sample string 4"
  },
  "charges": {
    "PrimaryID": "sample string 1",
    "MarketingName": "sample string 2",
    "TotalChargeAmountByProperty": 24.0,
    "TotalChargeCountByProperty": 4,
    "TotalResidentCountByProperty": 2,
    "Charges": [
      {
        "CustomerID": "sample string 1",
        "PrimaryID": "sample string 2",
        "MarketingName": "sample string 3",
        "UnitID": "sample string 4",
        "BuildingID": "sample string 5",
        "TotalChargeAmountByResident": 12.0,
        "TotalNumberOfChargesByResident": 2,
        "Charges": [
          {
            "PostReferenceID": "sample string 1",
            "Description": "sample string 2",
            "ServiceToDate": "sample string 3",
            "ServiceFromDate": "sample string 4",
            "ChargeCode": "sample string 5",
            "Amount": 6.0
          },
          {
            "PostReferenceID": "sample string 1",
            "Description": "sample string 2",
            "ServiceToDate": "sample string 3",
            "ServiceFromDate": "sample string 4",
            "ChargeCode": "sample string 5",
            "Amount": 6.0
          }
        ]
      },
      {
        "CustomerID": "sample string 1",
        "PrimaryID": "sample string 2",
        "MarketingName": "sample string 3",
        "UnitID": "sample string 4",
        "BuildingID": "sample string 5",
        "TotalChargeAmountByResident": 12.0,
        "TotalNumberOfChargesByResident": 2,
        "Charges": [
          {
            "PostReferenceID": "sample string 1",
            "Description": "sample string 2",
            "ServiceToDate": "sample string 3",
            "ServiceFromDate": "sample string 4",
            "ChargeCode": "sample string 5",
            "Amount": 6.0
          },
          {
            "PostReferenceID": "sample string 1",
            "Description": "sample string 2",
            "ServiceToDate": "sample string 3",
            "ServiceFromDate": "sample string 4",
            "ChargeCode": "sample string 5",
            "Amount": 6.0
          }
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ChargeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <charges xmlns:d2p1="http://schemas.datacontract.org/2004/07/EDEBase.BOL">
    <d2p1:Charges>
      <d2p1:EquityTenantChargesJson>
        <d2p1:BuildingID>sample string 5</d2p1:BuildingID>
        <d2p1:Charges>
          <d2p1:EquityIndividualChargeJson>
            <d2p1:Amount>6</d2p1:Amount>
            <d2p1:ChargeCode>sample string 5</d2p1:ChargeCode>
            <d2p1:Description>sample string 2</d2p1:Description>
            <d2p1:PostReferenceID>sample string 1</d2p1:PostReferenceID>
            <d2p1:ServiceFromDate>sample string 4</d2p1:ServiceFromDate>
            <d2p1:ServiceToDate>sample string 3</d2p1:ServiceToDate>
          </d2p1:EquityIndividualChargeJson>
          <d2p1:EquityIndividualChargeJson>
            <d2p1:Amount>6</d2p1:Amount>
            <d2p1:ChargeCode>sample string 5</d2p1:ChargeCode>
            <d2p1:Description>sample string 2</d2p1:Description>
            <d2p1:PostReferenceID>sample string 1</d2p1:PostReferenceID>
            <d2p1:ServiceFromDate>sample string 4</d2p1:ServiceFromDate>
            <d2p1:ServiceToDate>sample string 3</d2p1:ServiceToDate>
          </d2p1:EquityIndividualChargeJson>
        </d2p1:Charges>
        <d2p1:CustomerID>sample string 1</d2p1:CustomerID>
        <d2p1:MarketingName>sample string 3</d2p1:MarketingName>
        <d2p1:PrimaryID>sample string 2</d2p1:PrimaryID>
        <d2p1:UnitID>sample string 4</d2p1:UnitID>
      </d2p1:EquityTenantChargesJson>
      <d2p1:EquityTenantChargesJson>
        <d2p1:BuildingID>sample string 5</d2p1:BuildingID>
        <d2p1:Charges>
          <d2p1:EquityIndividualChargeJson>
            <d2p1:Amount>6</d2p1:Amount>
            <d2p1:ChargeCode>sample string 5</d2p1:ChargeCode>
            <d2p1:Description>sample string 2</d2p1:Description>
            <d2p1:PostReferenceID>sample string 1</d2p1:PostReferenceID>
            <d2p1:ServiceFromDate>sample string 4</d2p1:ServiceFromDate>
            <d2p1:ServiceToDate>sample string 3</d2p1:ServiceToDate>
          </d2p1:EquityIndividualChargeJson>
          <d2p1:EquityIndividualChargeJson>
            <d2p1:Amount>6</d2p1:Amount>
            <d2p1:ChargeCode>sample string 5</d2p1:ChargeCode>
            <d2p1:Description>sample string 2</d2p1:Description>
            <d2p1:PostReferenceID>sample string 1</d2p1:PostReferenceID>
            <d2p1:ServiceFromDate>sample string 4</d2p1:ServiceFromDate>
            <d2p1:ServiceToDate>sample string 3</d2p1:ServiceToDate>
          </d2p1:EquityIndividualChargeJson>
        </d2p1:Charges>
        <d2p1:CustomerID>sample string 1</d2p1:CustomerID>
        <d2p1:MarketingName>sample string 3</d2p1:MarketingName>
        <d2p1:PrimaryID>sample string 2</d2p1:PrimaryID>
        <d2p1:UnitID>sample string 4</d2p1:UnitID>
      </d2p1:EquityTenantChargesJson>
    </d2p1:Charges>
    <d2p1:MarketingName>sample string 2</d2p1:MarketingName>
    <d2p1:PrimaryID>sample string 1</d2p1:PrimaryID>
  </charges>
  <response>
    <Code>sample string 1</Code>
    <Description>sample string 3</Description>
    <Link>sample string 4</Link>
    <Message>sample string 2</Message>
  </response>
</ChargeResponse>