POST api/reports/expensebreakdown

Return a Breakdown of Synergy Expenses based on a given property list.

Request Information

Parameters

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

Request body formats

application/json

Sample:

{
  "PropertyList": "sample string 1",
  "ManagementFirmName": "sample string 2",
  "FileDateFrom": "sample DateTime 2024-04-30T14:20:13.2607675-06:00",
  "FileDateTo": "sample DateTime 2024-04-30T14:20:13.2607675-06:00",
  "parHistorical": "sample integer 5",
  "Utility": "sample string 6",
  "CommunityCodes": "sample string 7",
  "HideVacantAccounts": "sample string true",
  "IncludeDispositioned": "sample boolean true",
  "BillDate": "sample integer 10"
}

text/json

Sample:

{
  "PropertyList": "sample string 1",
  "ManagementFirmName": "sample string 2",
  "FileDateFrom": "2024-09-19T01:25:04.5810405-06:00",
  "FileDateTo": "2024-09-19T01:25:04.5810405-06:00",
  "parHistorical": 5,
  "Utility": "sample string 6",
  "CommunityCodes": "sample string 7",
  "HideVacantAccounts": true,
  "IncludeDispositioned": true,
  "BillDate": 10
}

application/xml, text/xml

Sample:

<ExpenseBreakdownRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <BillDate>10</BillDate>
  <CommunityCodes>sample string 7</CommunityCodes>
  <FileDateFrom>2024-09-19T01:25:04.5810405-06:00</FileDateFrom>
  <FileDateTo>2024-09-19T01:25:04.5810405-06:00</FileDateTo>
  <HideVacantAccounts>true</HideVacantAccounts>
  <IncludeDispositioned>true</IncludeDispositioned>
  <ManagementFirmName>sample string 2</ManagementFirmName>
  <PropertyList>sample string 1</PropertyList>
  <Utility>sample string 6</Utility>
  <parHistorical>5</parHistorical>
</ExpenseBreakdownRequest>

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

Response Information

application/json

Sample:

{
  "ManagementFirm": "sample string 1",
  "PropertyCode": "sample string 2",
  "PropertyName": "sample string 3",
  "UtilityProvider": "sample string 4",
  "GLCode": "sample string 5",
  "MasterAccountNumber": "sample string 6",
  "ControlNumber": "sample string 7",
  "UniqueMeterID": "sample string 8",
  "SubAccountNumber": "sample string 9",
  "UtilityName": "sample string 10",
  "RegulatoryDescription": "sample string 11",
  "ServiceAddress": "sample string 12",
  "StartDate": "sample string 13",
  "EndDate": "sample string 14",
  "BillDate": "sample string 15",
  "DueDate": "sample string 16",
  "PaidDate": "sample string 17",
  "Usage": "sample string 18",
  "UnitofMeasure": "sample string 19",
  "Tax": "sample decimal 20.0",
  "TotalRecurring": "sample decimal 21.0",
  "UtilityCharge": "sample string 22",
  "LateFees": "sample decimal 23.0",
  "Deposits": "sample decimal 24.0",
  "TotalAncillary": "sample decimal 25.0",
  "TotalNonRecurring": "sample decimal 26.0",
  "TotalInvoiceAmount": "sample decimal 27.0",
  "DNALink": "sample string 28"
}

text/json

Sample:

{
  "response": {
    "Code": "sample string 1",
    "Message": "sample string 2",
    "Description": "sample string 3",
    "Link": "sample string 4"
  },
  "expenseBreakdownDataJson": [
    {
      "ManagementFirm": "sample string 1",
      "PropertyCode": "sample string 2",
      "PropertyName": "sample string 3",
      "UtilityProvider": "sample string 4",
      "GLCode": "sample string 5",
      "MasterAccountNumber": "sample string 6",
      "ControlNumber": "sample string 7",
      "UniqueMeterID": "sample string 8",
      "SubAccountNumber": "sample string 9",
      "UtilityName": "sample string 10",
      "RegulatoryDescription": "sample string 11",
      "ServiceAddress": "sample string 12",
      "StartDate": "sample string 13",
      "EndDate": "sample string 14",
      "BillDate": "sample string 15",
      "DueDate": "sample string 16",
      "PaidDate": "sample string 17",
      "Usage": "sample string 18",
      "UnitofMeasure": "sample string 19",
      "Tax": 20.0,
      "TotalRecurring": 21.0,
      "UtilityCharge": "sample string 22",
      "LateFees": 23.0,
      "Deposits": 24.0,
      "TotalAncillary": 25.0,
      "TotalNonRecurring": 26.0,
      "TotalInvoiceAmount": 27.0,
      "DNALink": "sample string 28"
    },
    {
      "ManagementFirm": "sample string 1",
      "PropertyCode": "sample string 2",
      "PropertyName": "sample string 3",
      "UtilityProvider": "sample string 4",
      "GLCode": "sample string 5",
      "MasterAccountNumber": "sample string 6",
      "ControlNumber": "sample string 7",
      "UniqueMeterID": "sample string 8",
      "SubAccountNumber": "sample string 9",
      "UtilityName": "sample string 10",
      "RegulatoryDescription": "sample string 11",
      "ServiceAddress": "sample string 12",
      "StartDate": "sample string 13",
      "EndDate": "sample string 14",
      "BillDate": "sample string 15",
      "DueDate": "sample string 16",
      "PaidDate": "sample string 17",
      "Usage": "sample string 18",
      "UnitofMeasure": "sample string 19",
      "Tax": 20.0,
      "TotalRecurring": 21.0,
      "UtilityCharge": "sample string 22",
      "LateFees": 23.0,
      "Deposits": 24.0,
      "TotalAncillary": 25.0,
      "TotalNonRecurring": 26.0,
      "TotalInvoiceAmount": 27.0,
      "DNALink": "sample string 28"
    }
  ]
}

application/xml, text/xml

Sample:

<ExpenseBreakdownResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <expenseBreakdownDataJson>
    <ExpenseBreakdown>
      <BillDate>sample string 15</BillDate>
      <ControlNumber>sample string 7</ControlNumber>
      <DNALink>sample string 28</DNALink>
      <Deposits>24</Deposits>
      <DueDate>sample string 16</DueDate>
      <EndDate>sample string 14</EndDate>
      <GLCode>sample string 5</GLCode>
      <LateFees>23</LateFees>
      <ManagementFirm>sample string 1</ManagementFirm>
      <MasterAccountNumber>sample string 6</MasterAccountNumber>
      <PaidDate>sample string 17</PaidDate>
      <PropertyCode>sample string 2</PropertyCode>
      <PropertyName>sample string 3</PropertyName>
      <RegulatoryDescription>sample string 11</RegulatoryDescription>
      <ServiceAddress>sample string 12</ServiceAddress>
      <StartDate>sample string 13</StartDate>
      <SubAccountNumber>sample string 9</SubAccountNumber>
      <Tax>20</Tax>
      <TotalAncillary>25</TotalAncillary>
      <TotalInvoiceAmount>27</TotalInvoiceAmount>
      <TotalNonRecurring>26</TotalNonRecurring>
      <TotalRecurring>21</TotalRecurring>
      <UniqueMeterID>sample string 8</UniqueMeterID>
      <UnitofMeasure>sample string 19</UnitofMeasure>
      <Usage>sample string 18</Usage>
      <UtilityCharge>sample string 22</UtilityCharge>
      <UtilityName>sample string 10</UtilityName>
      <UtilityProvider>sample string 4</UtilityProvider>
    </ExpenseBreakdown>
    <ExpenseBreakdown>
      <BillDate>sample string 15</BillDate>
      <ControlNumber>sample string 7</ControlNumber>
      <DNALink>sample string 28</DNALink>
      <Deposits>24</Deposits>
      <DueDate>sample string 16</DueDate>
      <EndDate>sample string 14</EndDate>
      <GLCode>sample string 5</GLCode>
      <LateFees>23</LateFees>
      <ManagementFirm>sample string 1</ManagementFirm>
      <MasterAccountNumber>sample string 6</MasterAccountNumber>
      <PaidDate>sample string 17</PaidDate>
      <PropertyCode>sample string 2</PropertyCode>
      <PropertyName>sample string 3</PropertyName>
      <RegulatoryDescription>sample string 11</RegulatoryDescription>
      <ServiceAddress>sample string 12</ServiceAddress>
      <StartDate>sample string 13</StartDate>
      <SubAccountNumber>sample string 9</SubAccountNumber>
      <Tax>20</Tax>
      <TotalAncillary>25</TotalAncillary>
      <TotalInvoiceAmount>27</TotalInvoiceAmount>
      <TotalNonRecurring>26</TotalNonRecurring>
      <TotalRecurring>21</TotalRecurring>
      <UniqueMeterID>sample string 8</UniqueMeterID>
      <UnitofMeasure>sample string 19</UnitofMeasure>
      <Usage>sample string 18</Usage>
      <UtilityCharge>sample string 22</UtilityCharge>
      <UtilityName>sample string 10</UtilityName>
      <UtilityProvider>sample string 4</UtilityProvider>
    </ExpenseBreakdown>
  </expenseBreakdownDataJson>
  <response>
    <Code>sample string 1</Code>
    <Description>sample string 3</Description>
    <Link>sample string 4</Link>
    <Message>sample string 2</Message>
  </response>
</ExpenseBreakdownResponse>