POST api/reports/synergyaccrual

Get the latest Synergy Invoices and Accruals based on a given property list, report date and bill amount cutoff step

Request Information

Parameters

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

Request body formats

application/json

Sample:

{
  "PropertyHmy": "sample string 1",
  "ReportDate": "sample DateTime 2024-04-30T14:20:13.2607675-06:00",
  "IncludeBillAmountCutoff": "sample integer 1",
  "ManagementFirmName": "sample string 2"
}

text/json

Sample:

{
  "PropertyHmy": "sample string 1",
  "ReportDate": "2025-11-03T02:34:17.9967971-07:00",
  "IncludeBillAmountCutoff": 3,
  "ManagementFirmName": "sample string 4"
}

application/xml, text/xml

Sample:

<SynergyAccrualRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <IncludeBillAmountCutoff>3</IncludeBillAmountCutoff>
  <ManagementFirmName>sample string 4</ManagementFirmName>
  <PropertyHmy>sample string 1</PropertyHmy>
  <ReportDate>2025-11-03T02:34:17.9967971-07:00</ReportDate>
</SynergyAccrualRequest>

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 'SynergyAccrualRequest'.

Response Information

application/json

Sample:

{
  "PropertyHmy": "sample integer 1",
  "CommPropCode": "sample string 1",
  "Community": "sample string 2",
  "New": "sample decimal 20.0",
  "CommSCode": "sample string 3",
  "GLAcctNumber": "sample string 4",
  "AccountHmy": "sample integer 2",
  "AccountNumber": "sample string 5",
  "Provider": "sample string 6",
  "ServiceLocation": "sample string 7",
  "MeterNumber": "sample string 8",
  "BillStep": "sample integer 3",
  "BillFrequency": "sample string 9",
  "PaidDate": "sample DateTime 2024-04-30T14:20:13.2607675-06:00",
  "BillStepIndicator": "sample string 10",
  "BillStepIndicatorColumnName": "sample string 11",
  "BaseChargeHmy": "sample integer 4",
  "BaseUtility": "sample string 12",
  "ParentChargeHmy": "sample integer 5",
  "ParentUtility": "sample string 13",
  "LocationBillHmy": "sample integer 6",
  "ServiceStart": "sample DateTime 2024-04-30T14:20:13.2607675-06:00",
  "ServiceEnd": "sample DateTime 2024-04-30T14:20:13.2607675-06:00",
  "RecurringCharges": "sample decimal 30.0",
  "NonRecurringCharges": "sample decimal 40.0",
  "ServiceDays": "sample integer 7",
  "AccrualDays": "sample integer 8",
  "PerDiemRate": "sample decimal 50.0",
  "AccrualAmount": "sample decimal 60.0",
  "CustCommCode": "sample string 14"
}

text/json

Sample:

{
  "response": {
    "Code": "sample string 1",
    "Message": "sample string 2",
    "Description": "sample string 3",
    "Link": "sample string 4"
  },
  "synergyAccrualDataJson": [
    {
      "PropertyHmy": 1,
      "CommPropCode": "sample string 2",
      "Community": "sample string 3",
      "New": 4.0,
      "CommSCode": "sample string 5",
      "GLAcctNumber": "sample string 6",
      "AccountHmy": 7,
      "AccountNumber": "sample string 8",
      "Provider": "sample string 9",
      "ServiceLocation": "sample string 10",
      "MeterNumber": "sample string 11",
      "BillStep": 12,
      "BillFrequency": "sample string 13",
      "PaidDate": "2025-11-03T02:34:18.0123515-07:00",
      "BillStepIndicator": "sample string 15",
      "BillStepIndicatorColumnName": "sample string 16",
      "BaseChargeHmy": 17,
      "BaseUtility": "sample string 18",
      "ParentChargeHmy": 19,
      "ParentUtility": "sample string 20",
      "LocationBillHmy": 21,
      "ServiceStart": "2025-11-03T02:34:18.0123515-07:00",
      "ServiceEnd": "2025-11-03T02:34:18.0123515-07:00",
      "RecurringCharges": 24.0,
      "NonRecurringCharges": 25.0,
      "ServiceDays": 26,
      "AccrualDays": 27,
      "PerDiemRate": 28.0,
      "AccrualAmount": 29.0,
      "CustCommCode": "sample string 30"
    },
    {
      "PropertyHmy": 1,
      "CommPropCode": "sample string 2",
      "Community": "sample string 3",
      "New": 4.0,
      "CommSCode": "sample string 5",
      "GLAcctNumber": "sample string 6",
      "AccountHmy": 7,
      "AccountNumber": "sample string 8",
      "Provider": "sample string 9",
      "ServiceLocation": "sample string 10",
      "MeterNumber": "sample string 11",
      "BillStep": 12,
      "BillFrequency": "sample string 13",
      "PaidDate": "2025-11-03T02:34:18.0123515-07:00",
      "BillStepIndicator": "sample string 15",
      "BillStepIndicatorColumnName": "sample string 16",
      "BaseChargeHmy": 17,
      "BaseUtility": "sample string 18",
      "ParentChargeHmy": 19,
      "ParentUtility": "sample string 20",
      "LocationBillHmy": 21,
      "ServiceStart": "2025-11-03T02:34:18.0123515-07:00",
      "ServiceEnd": "2025-11-03T02:34:18.0123515-07:00",
      "RecurringCharges": 24.0,
      "NonRecurringCharges": 25.0,
      "ServiceDays": 26,
      "AccrualDays": 27,
      "PerDiemRate": 28.0,
      "AccrualAmount": 29.0,
      "CustCommCode": "sample string 30"
    }
  ]
}

application/xml, text/xml

Sample:

<SynergyAccrualResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <response>
    <Code>sample string 1</Code>
    <Description>sample string 3</Description>
    <Link>sample string 4</Link>
    <Message>sample string 2</Message>
  </response>
  <synergyAccrualDataJson>
    <SynergyAccrual>
      <AccountHmy>7</AccountHmy>
      <AccountNumber>sample string 8</AccountNumber>
      <AccrualAmount>29</AccrualAmount>
      <AccrualDays>27</AccrualDays>
      <BaseChargeHmy>17</BaseChargeHmy>
      <BaseUtility>sample string 18</BaseUtility>
      <BillFrequency>sample string 13</BillFrequency>
      <BillStep>12</BillStep>
      <BillStepIndicator>sample string 15</BillStepIndicator>
      <BillStepIndicatorColumnName>sample string 16</BillStepIndicatorColumnName>
      <CommPropCode>sample string 2</CommPropCode>
      <CommSCode>sample string 5</CommSCode>
      <Community>sample string 3</Community>
      <CustCommCode>sample string 30</CustCommCode>
      <GLAcctNumber>sample string 6</GLAcctNumber>
      <LocationBillHmy>21</LocationBillHmy>
      <MeterNumber>sample string 11</MeterNumber>
      <New>4</New>
      <NonRecurringCharges>25</NonRecurringCharges>
      <PaidDate>2025-11-03T02:34:18.0123515-07:00</PaidDate>
      <ParentChargeHmy>19</ParentChargeHmy>
      <ParentUtility>sample string 20</ParentUtility>
      <PerDiemRate>28</PerDiemRate>
      <PropertyHmy>1</PropertyHmy>
      <Provider>sample string 9</Provider>
      <RecurringCharges>24</RecurringCharges>
      <ServiceDays>26</ServiceDays>
      <ServiceEnd>2025-11-03T02:34:18.0123515-07:00</ServiceEnd>
      <ServiceLocation>sample string 10</ServiceLocation>
      <ServiceStart>2025-11-03T02:34:18.0123515-07:00</ServiceStart>
    </SynergyAccrual>
    <SynergyAccrual>
      <AccountHmy>7</AccountHmy>
      <AccountNumber>sample string 8</AccountNumber>
      <AccrualAmount>29</AccrualAmount>
      <AccrualDays>27</AccrualDays>
      <BaseChargeHmy>17</BaseChargeHmy>
      <BaseUtility>sample string 18</BaseUtility>
      <BillFrequency>sample string 13</BillFrequency>
      <BillStep>12</BillStep>
      <BillStepIndicator>sample string 15</BillStepIndicator>
      <BillStepIndicatorColumnName>sample string 16</BillStepIndicatorColumnName>
      <CommPropCode>sample string 2</CommPropCode>
      <CommSCode>sample string 5</CommSCode>
      <Community>sample string 3</Community>
      <CustCommCode>sample string 30</CustCommCode>
      <GLAcctNumber>sample string 6</GLAcctNumber>
      <LocationBillHmy>21</LocationBillHmy>
      <MeterNumber>sample string 11</MeterNumber>
      <New>4</New>
      <NonRecurringCharges>25</NonRecurringCharges>
      <PaidDate>2025-11-03T02:34:18.0123515-07:00</PaidDate>
      <ParentChargeHmy>19</ParentChargeHmy>
      <ParentUtility>sample string 20</ParentUtility>
      <PerDiemRate>28</PerDiemRate>
      <PropertyHmy>1</PropertyHmy>
      <Provider>sample string 9</Provider>
      <RecurringCharges>24</RecurringCharges>
      <ServiceDays>26</ServiceDays>
      <ServiceEnd>2025-11-03T02:34:18.0123515-07:00</ServiceEnd>
      <ServiceLocation>sample string 10</ServiceLocation>
      <ServiceStart>2025-11-03T02:34:18.0123515-07:00</ServiceStart>
    </SynergyAccrual>
  </synergyAccrualDataJson>
</SynergyAccrualResponse>