POST api/genericreports/getamliapireport

Get AMLI API Report

Request Information

Parameters

NameDescriptionAdditional information
request

Define this parameter in the request body.

Request body formats

application/json

Sample:
{
  "StartPostMonth": "sample DateTime 2024-08-01T00:00:00.000000-06:00",
  "EndPostMonth": "sample DateTime 2024-10-01T00:00:00.000000-06:00",
  "Property": "sample string 1",
  "ManagementFirmName": "sample string 2"
}

text/json

Sample:
{
  "StartPostMonth": "2025-04-03T19:15:38.5074427-06:00",
  "EndPostMonth": "2025-04-03T19:15:38.5074427-06:00",
  "Property": "sample string 3",
  "ManagementFirmName": "sample string 4"
}

application/xml, text/xml

Sample:
<AMLIApiReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <EndPostMonth>2025-04-03T19:15:38.5074427-06:00</EndPostMonth>
  <ManagementFirmName>sample string 4</ManagementFirmName>
  <Property>sample string 3</Property>
  <StartPostMonth>2025-04-03T19:15:38.5074427-06:00</StartPostMonth>
</AMLIApiReportRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

application/json

Sample:
{
  "Community": "sample string community",
  "AccountNumber": "sample string accountNumber",
  "BillControlNumber": "sample string billControlNumber",
  "BillMonth": "sample DateTime 2024-12-01T00:00:00.000000-06:00",
  "BillDate": "sample DateTime 2024-12-05T00:00:00.000000-06:00",
  "ProviderDatesStart": "sample DateTime 2024-11-02T00:00:00.000000-06:00",
  "ProviderDatesEnd": "sample DateTime 2024-12-02T00:00:00.000000-06:00",
  "ParentUtilityType": "sample string parentUtilityType",
  "UtilityName": "sample string utilityName",
  "UtilityConsumption": "sample decimal 21.60",
  "UtilityExpense": "sample decimal 282.75",
  "GLCode": "sample string GLCode",
  "ARCode": "sample string ARCode"
}

text/json

Sample:
{
  "AMLIApiReportDataJson": [
    {
      "Community": "sample string 1",
      "AccountNumber": "sample string 2",
      "BillControlNumber": "sample string 3",
      "BillMonth": "2025-04-03T19:15:38.5074427-06:00",
      "BillDate": "2025-04-03T19:15:38.5074427-06:00",
      "ProviderDatesStart": "2025-04-03T19:15:38.5074427-06:00",
      "ProviderDatesEnd": "2025-04-03T19:15:38.5074427-06:00",
      "ParentUtilityType": "sample string 8",
      "UtilityName": "sample string 9",
      "UtilityConsumption": 10.0,
      "UtilityExpense": 11.0,
      "GLCode": "sample string 12",
      "ARCode": "sample string 13"
    },
    {
      "Community": "sample string 1",
      "AccountNumber": "sample string 2",
      "BillControlNumber": "sample string 3",
      "BillMonth": "2025-04-03T19:15:38.5074427-06:00",
      "BillDate": "2025-04-03T19:15:38.5074427-06:00",
      "ProviderDatesStart": "2025-04-03T19:15:38.5074427-06:00",
      "ProviderDatesEnd": "2025-04-03T19:15:38.5074427-06:00",
      "ParentUtilityType": "sample string 8",
      "UtilityName": "sample string 9",
      "UtilityConsumption": 10.0,
      "UtilityExpense": 11.0,
      "GLCode": "sample string 12",
      "ARCode": "sample string 13"
    }
  ],
  "Response": {
    "Code": "sample string 1",
    "Message": "sample string 2",
    "Description": "sample string 3",
    "Link": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<AMLIApiReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <AMLIApiReportDataJson>
    <AMLIApiReportFormatted>
      <ARCode>sample string 13</ARCode>
      <AccountNumber>sample string 2</AccountNumber>
      <BillControlNumber>sample string 3</BillControlNumber>
      <BillDate>2025-04-03T19:15:38.5074427-06:00</BillDate>
      <BillMonth>2025-04-03T19:15:38.5074427-06:00</BillMonth>
      <Community>sample string 1</Community>
      <GLCode>sample string 12</GLCode>
      <ParentUtilityType>sample string 8</ParentUtilityType>
      <ProviderDatesEnd>2025-04-03T19:15:38.5074427-06:00</ProviderDatesEnd>
      <ProviderDatesStart>2025-04-03T19:15:38.5074427-06:00</ProviderDatesStart>
      <UtilityConsumption>10</UtilityConsumption>
      <UtilityExpense>11</UtilityExpense>
      <UtilityName>sample string 9</UtilityName>
    </AMLIApiReportFormatted>
    <AMLIApiReportFormatted>
      <ARCode>sample string 13</ARCode>
      <AccountNumber>sample string 2</AccountNumber>
      <BillControlNumber>sample string 3</BillControlNumber>
      <BillDate>2025-04-03T19:15:38.5074427-06:00</BillDate>
      <BillMonth>2025-04-03T19:15:38.5074427-06:00</BillMonth>
      <Community>sample string 1</Community>
      <GLCode>sample string 12</GLCode>
      <ParentUtilityType>sample string 8</ParentUtilityType>
      <ProviderDatesEnd>2025-04-03T19:15:38.5074427-06:00</ProviderDatesEnd>
      <ProviderDatesStart>2025-04-03T19:15:38.5074427-06:00</ProviderDatesStart>
      <UtilityConsumption>10</UtilityConsumption>
      <UtilityExpense>11</UtilityExpense>
      <UtilityName>sample string 9</UtilityName>
    </AMLIApiReportFormatted>
  </AMLIApiReportDataJson>
  <Response>
    <Code>sample string 1</Code>
    <Description>sample string 3</Description>
    <Link>sample string 4</Link>
    <Message>sample string 2</Message>
  </Response>
</AMLIApiReportResponse>