GET api/um/v1/account/{accountNumber}

Returns Account 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.

Response Information

Account object.

Response body formats

application/json, text/json

Sample:

{
  "AccountNumber": "00000001-001",
  "AccountStatus": "Active",
  "PrimaryCustomerLastName": "sample string 3",
  "PrimaryCustomerFirstName": "sample string 4",
  "PrimaryCustomerMiddleName": "sample string 5",
  "PrimaryCustomerNameSuffix": "sample string 6",
  "ServiceAddressHouseNumber": "sample string 7",
  "ServiceAddressAdditionalInfo": "sample string 8",
  "ServiceAddressStreetPrefix": "sample string 9",
  "ServiceAddressStreetType": "sample string 10",
  "ServiceAddressStreetPreType": "sample string 11",
  "ServiceAddressStreetName": "sample string 12",
  "ServiceAddressStreetSuffix": "sample string 13",
  "ServiceAddressApartment": "sample string 14",
  "ServiceAddressCity": "sample string 15",
  "ServiceAddressState": "sample string 16",
  "ServiceAddressZip": "sample string 17",
  "ServiceAddressZip4": "sample string 18",
  "BillingAddressLineOne": "sample string 19",
  "BillingAddressLineTwo": "sample string 20",
  "BillingAddressLineThree": "sample string 21",
  "BillingAddressCity": "sample string 22",
  "BillingAddressState": "sample string 23",
  "BillingAddressZip": "sample string 24",
  "TotalDueAmount": 25.0,
  "PastDueAmount": 26.0,
  "LastBillDueDate": "2025-05-12T04:02:39.8986983-05:00",
  "LastBillTransactionDate": "2025-05-12T04:02:39.8986983-05:00",
  "PrimaryPhoneNumber": "sample string 27",
  "PrimaryEmailAddress": "sample string 28",
  "LastPaymentAmount": 29.0,
  "LastPaymentDate": "2025-05-12T04:02:39.8986983-05:00",
  "OnAutopayProgram": true,
  "OnPaperlessBilling": true,
  "OnBudgetBilling": true,
  "BudgetBillEnrollmentDate": "2025-05-12T04:02:39.8986983-05:00",
  "BudgetBillAmount": 33.0,
  "CustomerType": "sample string 34",
  "RestrictedPaymentMethods": "sample string 35",
  "ShutOffDate": "2025-05-12T04:02:39.8986983-05:00",
  "AccountBlocked": true,
  "AccountBlockedReason": "sample string 37",
  "OnPaymentPlan": true,
  "PaymentPlanRecentChargesAmountDue": 39.0,
  "PaymentPlanRecentChargesDueDate": "2025-05-12T04:02:39.8986983-05:00",
  "PaymentPlanInstallmentAmountDue": 40.0,
  "PaymentPlanInstallmentDueDate": "2025-05-12T04:02:39.8986983-05:00"
}

application/xml, text/xml

Sample:

<Account xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NewWorld.Logos.WebApi.Models.UM.Accounts">
  <AccountBlocked>true</AccountBlocked>
  <AccountBlockedReason>sample string 37</AccountBlockedReason>
  <AccountNumber>00000001-001</AccountNumber>
  <AccountStatus>Active</AccountStatus>
  <BillingAddressCity>sample string 22</BillingAddressCity>
  <BillingAddressLineOne>sample string 19</BillingAddressLineOne>
  <BillingAddressLineThree>sample string 21</BillingAddressLineThree>
  <BillingAddressLineTwo>sample string 20</BillingAddressLineTwo>
  <BillingAddressState>sample string 23</BillingAddressState>
  <BillingAddressZip>sample string 24</BillingAddressZip>
  <BudgetBillAmount>33</BudgetBillAmount>
  <BudgetBillEnrollmentDate>2025-05-12T04:02:39.8986983-05:00</BudgetBillEnrollmentDate>
  <CustomerType>sample string 34</CustomerType>
  <LastBillDueDate>2025-05-12T04:02:39.8986983-05:00</LastBillDueDate>
  <LastBillTransactionDate>2025-05-12T04:02:39.8986983-05:00</LastBillTransactionDate>
  <LastPaymentAmount>29</LastPaymentAmount>
  <LastPaymentDate>2025-05-12T04:02:39.8986983-05:00</LastPaymentDate>
  <OnAutopayProgram>true</OnAutopayProgram>
  <OnBudgetBilling>true</OnBudgetBilling>
  <OnPaperlessBilling>true</OnPaperlessBilling>
  <OnPaymentPlan>true</OnPaymentPlan>
  <PastDueAmount>26</PastDueAmount>
  <PaymentPlanInstallmentAmountDue>40</PaymentPlanInstallmentAmountDue>
  <PaymentPlanInstallmentDueDate>2025-05-12T04:02:39.8986983-05:00</PaymentPlanInstallmentDueDate>
  <PaymentPlanRecentChargesAmountDue>39</PaymentPlanRecentChargesAmountDue>
  <PaymentPlanRecentChargesDueDate>2025-05-12T04:02:39.8986983-05:00</PaymentPlanRecentChargesDueDate>
  <PrimaryCustomerFirstName>sample string 4</PrimaryCustomerFirstName>
  <PrimaryCustomerLastName>sample string 3</PrimaryCustomerLastName>
  <PrimaryCustomerMiddleName>sample string 5</PrimaryCustomerMiddleName>
  <PrimaryCustomerNameSuffix>sample string 6</PrimaryCustomerNameSuffix>
  <PrimaryEmailAddress>sample string 28</PrimaryEmailAddress>
  <PrimaryPhoneNumber>sample string 27</PrimaryPhoneNumber>
  <RestrictedPaymentMethods>sample string 35</RestrictedPaymentMethods>
  <ServiceAddressAdditionalInfo>sample string 8</ServiceAddressAdditionalInfo>
  <ServiceAddressApartment>sample string 14</ServiceAddressApartment>
  <ServiceAddressCity>sample string 15</ServiceAddressCity>
  <ServiceAddressHouseNumber>sample string 7</ServiceAddressHouseNumber>
  <ServiceAddressState>sample string 16</ServiceAddressState>
  <ServiceAddressStreetName>sample string 12</ServiceAddressStreetName>
  <ServiceAddressStreetPreType>sample string 11</ServiceAddressStreetPreType>
  <ServiceAddressStreetPrefix>sample string 9</ServiceAddressStreetPrefix>
  <ServiceAddressStreetSuffix>sample string 13</ServiceAddressStreetSuffix>
  <ServiceAddressStreetType>sample string 10</ServiceAddressStreetType>
  <ServiceAddressZip>sample string 17</ServiceAddressZip>
  <ServiceAddressZip4>sample string 18</ServiceAddressZip4>
  <ShutOffDate>2025-05-12T04:02:39.8986983-05:00</ShutOffDate>
  <TotalDueAmount>25</TotalDueAmount>
</Account>