GET api/um/v1/statementhistory/{accountNumber}/{startDate}
Returns collection of PaymentHistory object for requested account number.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
accountNumber | Account Number including tenant number separated by dash. |
Define this parameter in the request URI. |
startDate | Gets records on or after given date. Date format yyyy-MM-dd. |
Define this parameter in the request URI. |
Response Information
IEnumerable of StatementHistory object.
Response body formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml, text/xml
Sample:
<ArrayOfStatementHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NewWorld.Logos.WebApi.Models.UM.Accounts"> <StatementHistory> <AccountNumber>00000001-001</AccountNumber> <Adjustments>5</Adjustments> <BalanceAtBilling>7</BalanceAtBilling> <BalanceDue>9</BalanceDue> <BalanceDueAfterDueDate>11</BalanceDueAfterDueDate> <BillDate>2025-05-12T03:12:29.9924385-05:00</BillDate> <BillFromDate>2025-05-12T03:12:29.9924385-05:00</BillFromDate> <BillToDate>2025-05-12T03:12:29.9924385-05:00</BillToDate> <CurrentCharges>8</CurrentCharges> <CurrentMeterReadDate>2025-05-12T03:12:29.9924385-05:00</CurrentMeterReadDate> <DueDate>2025-05-12T03:12:29.9924385-05:00</DueDate> <LastPaymentDate>2025-05-12T03:12:29.9924385-05:00</LastPaymentDate> <Payments>6</Payments> <Penalties>4</Penalties> <PenaltyDate>2025-05-12T03:12:29.9924385-05:00</PenaltyDate> <PreviousBalance>3</PreviousBalance> <PreviousMeterReadDate>2025-05-12T03:12:29.9924385-05:00</PreviousMeterReadDate> </StatementHistory> <StatementHistory> <AccountNumber>sample string 1</AccountNumber> <Adjustments>5</Adjustments> <BalanceAtBilling>7</BalanceAtBilling> <BalanceDue>9</BalanceDue> <BalanceDueAfterDueDate>11</BalanceDueAfterDueDate> <BillDate>2025-05-12T03:12:29.9924385-05:00</BillDate> <BillFromDate>2025-05-12T03:12:29.9924385-05:00</BillFromDate> <BillToDate>2025-05-12T03:12:29.9924385-05:00</BillToDate> <CurrentCharges>8</CurrentCharges> <CurrentMeterReadDate>2025-05-12T03:12:29.9924385-05:00</CurrentMeterReadDate> <DueDate>2025-05-12T03:12:29.9924385-05:00</DueDate> <LastPaymentDate>2025-05-12T03:12:29.9924385-05:00</LastPaymentDate> <Payments>6</Payments> <Penalties>4</Penalties> <PenaltyDate>2025-05-12T03:12:29.9924385-05:00</PenaltyDate> <PreviousBalance>3</PreviousBalance> <PreviousMeterReadDate>2025-05-12T03:12:29.9924385-05:00</PreviousMeterReadDate> </StatementHistory> <StatementHistory> <AccountNumber>sample string 1</AccountNumber> <Adjustments>5</Adjustments> <BalanceAtBilling>7</BalanceAtBilling> <BalanceDue>9</BalanceDue> <BalanceDueAfterDueDate>11</BalanceDueAfterDueDate> <BillDate>2025-05-12T03:12:29.9924385-05:00</BillDate> <BillFromDate>2025-05-12T03:12:29.9924385-05:00</BillFromDate> <BillToDate>2025-05-12T03:12:29.9924385-05:00</BillToDate> <CurrentCharges>8</CurrentCharges> <CurrentMeterReadDate>2025-05-12T03:12:29.9924385-05:00</CurrentMeterReadDate> <DueDate>2025-05-12T03:12:29.9924385-05:00</DueDate> <LastPaymentDate>2025-05-12T03:12:29.9924385-05:00</LastPaymentDate> <Payments>6</Payments> <Penalties>4</Penalties> <PenaltyDate>2025-05-12T03:12:29.9924385-05:00</PenaltyDate> <PreviousBalance>3</PreviousBalance> <PreviousMeterReadDate>2025-05-12T03:12:29.9924385-05:00</PreviousMeterReadDate> </StatementHistory> </ArrayOfStatementHistory>