POST api/genericreports/getamliapireport

Get AMLI API Report

Request Information

Parameters

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

Request body formats

application/json

Sample:

{
  "StartPostMonth": "sample DateTime 2024-05-30T14:20:13.2607675-06:00",
  "EndPostMonth": "sample DateTime 2024-06-30T14:20:13.2607675-06:00",
  "Property": "sample string 1",
  "EnforceTimeConstraint": "sample bool false",
  "ManagementFirmName": "sample string 2"
}

text/json

Sample:

{
  "StartPostMonth": "2024-11-24T21:22:52.3005807-07:00",
  "EndPostMonth": "2024-11-24T21:22:52.3005807-07:00",
  "Property": "sample string 3",
  "EnforceTimeConstraint": true,
  "ManagementFirmName": "sample string 5"
}

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>2024-11-24T21:22:52.3005807-07:00</EndPostMonth>
  <EnforceTimeConstraint>true</EnforceTimeConstraint>
  <ManagementFirmName>sample string 5</ManagementFirmName>
  <Property>sample string 3</Property>
  <StartPostMonth>2024-11-24T21:22:52.3005807-07:00</StartPostMonth>
</AMLIApiReportRequest>

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

Response Information

application/json

Sample:

{
  "PropName": "sample string 1",
  "ParentUtility": "sample string 2",
  "InvoiceDatesStart": "sample DateTime 2024-04-30T14:20:13.2607675-06:00",
  "InvoiceDatesEnd": "sample DateTime 2024-04-30T14:20:13.2607675-06:00",
  "Expense": "sample decimal 100.0",
  "Usage": "sample decimal 100.0",
  "GLCode": "sample string 3",
  "PostMonth": "sample DateTime 2024-04-30T14:20:13.2607675-06:00",
  "BillingStart": "sample DateTime 2024-04-30T14:20:13.2607675-06:00",
  "BillingEnd": "sample DateTime 2024-04-30T14:20:13.2607675-06:00",
  "SubmeterUsageSum": "sample decimal 100.0",
  "BilledAmountSum": "sample decimal 100.0",
  "TotalExpenseSum": "sample decimal 100.0",
  "BillableExpenseSum": "sample decimal 100.0",
  "BillingMethods": "sample string 4",
  "ARCode": "sample string 5"
}

text/json

Sample:

{
  "AMLIApiReportDataJson": [
    {
      "PropName": "sample string 1",
      "ParentUtility": "sample string 2",
      "InvoiceDatesStart": "2024-11-24T21:22:52.3005807-07:00",
      "InvoiceDatesEnd": "2024-11-24T21:22:52.3005807-07:00",
      "Expense": 1.0,
      "Usage": 1.0,
      "GLCode": "sample string 3",
      "PostMonth": "2024-11-24T21:22:52.3005807-07:00",
      "BillingStart": "2024-11-24T21:22:52.3005807-07:00",
      "BillingEnd": "2024-11-24T21:22:52.3005807-07:00",
      "SubmeterUsageSum": 1.0,
      "BilledAmountSum": 1.0,
      "TotalExpenseSum": 1.0,
      "BillableExpenseSum": 1.0,
      "BillingMethods": "sample string 4",
      "ARCode": "sample string 5"
    },
    {
      "PropName": "sample string 1",
      "ParentUtility": "sample string 2",
      "InvoiceDatesStart": "2024-11-24T21:22:52.3005807-07:00",
      "InvoiceDatesEnd": "2024-11-24T21:22:52.3005807-07:00",
      "Expense": 1.0,
      "Usage": 1.0,
      "GLCode": "sample string 3",
      "PostMonth": "2024-11-24T21:22:52.3005807-07:00",
      "BillingStart": "2024-11-24T21:22:52.3005807-07:00",
      "BillingEnd": "2024-11-24T21:22:52.3005807-07:00",
      "SubmeterUsageSum": 1.0,
      "BilledAmountSum": 1.0,
      "TotalExpenseSum": 1.0,
      "BillableExpenseSum": 1.0,
      "BillingMethods": "sample string 4",
      "ARCode": "sample string 5"
    }
  ],
  "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>
    <AMLIApiReport>
      <ARCode>sample string 5</ARCode>
      <BillableExpenseSum>1</BillableExpenseSum>
      <BilledAmountSum>1</BilledAmountSum>
      <BillingEnd>2024-11-24T21:22:52.3005807-07:00</BillingEnd>
      <BillingMethods>sample string 4</BillingMethods>
      <BillingStart>2024-11-24T21:22:52.3005807-07:00</BillingStart>
      <Expense>1</Expense>
      <GLCode>sample string 3</GLCode>
      <InvoiceDatesEnd>2024-11-24T21:22:52.3005807-07:00</InvoiceDatesEnd>
      <InvoiceDatesStart>2024-11-24T21:22:52.3005807-07:00</InvoiceDatesStart>
      <ParentUtility>sample string 2</ParentUtility>
      <PostMonth>2024-11-24T21:22:52.3005807-07:00</PostMonth>
      <PropName>sample string 1</PropName>
      <SubmeterUsageSum>1</SubmeterUsageSum>
      <TotalExpenseSum>1</TotalExpenseSum>
      <Usage>1</Usage>
    </AMLIApiReport>
    <AMLIApiReport>
      <ARCode>sample string 5</ARCode>
      <BillableExpenseSum>1</BillableExpenseSum>
      <BilledAmountSum>1</BilledAmountSum>
      <BillingEnd>2024-11-24T21:22:52.3005807-07:00</BillingEnd>
      <BillingMethods>sample string 4</BillingMethods>
      <BillingStart>2024-11-24T21:22:52.3005807-07:00</BillingStart>
      <Expense>1</Expense>
      <GLCode>sample string 3</GLCode>
      <InvoiceDatesEnd>2024-11-24T21:22:52.3005807-07:00</InvoiceDatesEnd>
      <InvoiceDatesStart>2024-11-24T21:22:52.3005807-07:00</InvoiceDatesStart>
      <ParentUtility>sample string 2</ParentUtility>
      <PostMonth>2024-11-24T21:22:52.3005807-07:00</PostMonth>
      <PropName>sample string 1</PropName>
      <SubmeterUsageSum>1</SubmeterUsageSum>
      <TotalExpenseSum>1</TotalExpenseSum>
      <Usage>1</Usage>
    </AMLIApiReport>
  </AMLIApiReportDataJson>
  <Response>
    <Code>sample string 1</Code>
    <Description>sample string 3</Description>
    <Link>sample string 4</Link>
    <Message>sample string 2</Message>
  </Response>
</AMLIApiReportResponse>