GET v2/facilities/{facilityId}/tenants/{tenantId}/charges?TenantPin={TenantPin}&TenantFirstName={TenantFirstName}&TenantLastName={TenantLastName}&UnitId={UnitId}&UnitName={UnitName}&PayPeriods={PayPeriods}&IsConvenienceFeeAdded={IsConvenienceFeeAdded}&ConvenienceFeeOrName={ConvenienceFeeOrName}

Gets the tenant's charges and ensures the FacilityTenantUnitsList list is populated. K2 noticed the list was only being populated during an error condition and needed it in the response at all times.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
facilityId

The facility identifier.

globally unique identifier

Required

tenantId

The tenant identifier.

string

Required

TenantPin

string

None.

TenantFirstName

string

None.

TenantLastName

string

None.

UnitId

string

None.

UnitName

string

None.

PayPeriods

integer

None.

IsConvenienceFeeAdded

boolean

None.

ConvenienceFeeOrName

string

None.

Body Parameters

None.

Response Information

Resource Description

FacilityTenantCurrentCharges
NameDescriptionTypeAdditional information
FacilityTenantCurrentChargesUnitList

Collection of FacilityTenantCurrentChargesUnitItem

None.

FacilityTenantUnitsList

Collection of FacilityTenantUnitsItem

None.

Errors

Collection of Exception

None.

IsSuccess

boolean

None.

AmountDue

decimal number

None.

Response Formats

application/json, text/json

Sample:
{
  "AmountDue": 1.1,
  "FacilityTenantCurrentChargesUnitList": [
    {
      "UnitId": "sample string 1",
      "UnitName": "sample string 2",
      "IssnUnitTypeId": "8df07091-a941-4b35-9e36-108b27e7b38f",
      "UnitTypeDescription": "sample string 4",
      "AmountDue": 5.1,
      "IsHasCharges": true,
      "FacilityTenantCurrentChargesUnitItemChargesList": [
        {
          "Description": "sample string 1",
          "StartTimeStamp": "2025-06-30T23:26:22.8618323-07:00",
          "EndTimeStamp": "2025-06-30T23:26:22.8618323-07:00",
          "Amount": 4.1,
          "Tax": 5.1
        },
        {
          "Description": "sample string 1",
          "StartTimeStamp": "2025-06-30T23:26:22.8618323-07:00",
          "EndTimeStamp": "2025-06-30T23:26:22.8618323-07:00",
          "Amount": 4.1,
          "Tax": 5.1
        }
      ]
    },
    {
      "UnitId": "sample string 1",
      "UnitName": "sample string 2",
      "IssnUnitTypeId": "8df07091-a941-4b35-9e36-108b27e7b38f",
      "UnitTypeDescription": "sample string 4",
      "AmountDue": 5.1,
      "IsHasCharges": true,
      "FacilityTenantCurrentChargesUnitItemChargesList": [
        {
          "Description": "sample string 1",
          "StartTimeStamp": "2025-06-30T23:26:22.8618323-07:00",
          "EndTimeStamp": "2025-06-30T23:26:22.8618323-07:00",
          "Amount": 4.1,
          "Tax": 5.1
        },
        {
          "Description": "sample string 1",
          "StartTimeStamp": "2025-06-30T23:26:22.8618323-07:00",
          "EndTimeStamp": "2025-06-30T23:26:22.8618323-07:00",
          "Amount": 4.1,
          "Tax": 5.1
        }
      ]
    }
  ],
  "FacilityTenantUnitsList": [
    {
      "ReserveType": "sample string 1",
      "UnitId": "sample string 2",
      "UnitName": "sample string 3",
      "IssnUnitTypeId": "8d50d919-09b7-4924-a4e7-a682b44f994b",
      "UnitTypeDescription": "sample string 5",
      "StartDate": "2025-06-30T23:26:22.8618323-07:00",
      "EndDate": "2025-06-30T23:26:22.8618323-07:00",
      "LockedOut": true,
      "PaidThruDate": "2025-06-30T23:26:22.8618323-07:00",
      "PaymentAllowed": true
    },
    {
      "ReserveType": "sample string 1",
      "UnitId": "sample string 2",
      "UnitName": "sample string 3",
      "IssnUnitTypeId": "8d50d919-09b7-4924-a4e7-a682b44f994b",
      "UnitTypeDescription": "sample string 5",
      "StartDate": "2025-06-30T23:26:22.8618323-07:00",
      "EndDate": "2025-06-30T23:26:22.8618323-07:00",
      "LockedOut": true,
      "PaidThruDate": "2025-06-30T23:26:22.8618323-07:00",
      "PaymentAllowed": true
    }
  ],
  "Errors": [
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    },
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    }
  ],
  "IsSuccess": true
}

application/xml, text/xml

Sample:
<FacilityTenantCurrentCharges xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
  </Errors>
  <IsSuccess>true</IsSuccess>
  <AmountDue>1.1</AmountDue>
  <FacilityTenantCurrentChargesUnitList>
    <FacilityTenantCurrentChargesUnitItem>
      <AmountDue>5.1</AmountDue>
      <FacilityTenantCurrentChargesUnitItemChargesList>
        <FacilityTenantCurrentChargesUnitItemCharges>
          <Amount>4.1</Amount>
          <Description>sample string 1</Description>
          <EndTimeStamp>2025-06-30T23:26:22.8618323-07:00</EndTimeStamp>
          <StartTimeStamp>2025-06-30T23:26:22.8618323-07:00</StartTimeStamp>
          <Tax>5.1</Tax>
        </FacilityTenantCurrentChargesUnitItemCharges>
        <FacilityTenantCurrentChargesUnitItemCharges>
          <Amount>4.1</Amount>
          <Description>sample string 1</Description>
          <EndTimeStamp>2025-06-30T23:26:22.8618323-07:00</EndTimeStamp>
          <StartTimeStamp>2025-06-30T23:26:22.8618323-07:00</StartTimeStamp>
          <Tax>5.1</Tax>
        </FacilityTenantCurrentChargesUnitItemCharges>
      </FacilityTenantCurrentChargesUnitItemChargesList>
      <IsHasCharges>true</IsHasCharges>
      <IssnUnitTypeId>8df07091-a941-4b35-9e36-108b27e7b38f</IssnUnitTypeId>
      <UnitId>sample string 1</UnitId>
      <UnitName>sample string 2</UnitName>
      <UnitTypeDescription>sample string 4</UnitTypeDescription>
    </FacilityTenantCurrentChargesUnitItem>
    <FacilityTenantCurrentChargesUnitItem>
      <AmountDue>5.1</AmountDue>
      <FacilityTenantCurrentChargesUnitItemChargesList>
        <FacilityTenantCurrentChargesUnitItemCharges>
          <Amount>4.1</Amount>
          <Description>sample string 1</Description>
          <EndTimeStamp>2025-06-30T23:26:22.8618323-07:00</EndTimeStamp>
          <StartTimeStamp>2025-06-30T23:26:22.8618323-07:00</StartTimeStamp>
          <Tax>5.1</Tax>
        </FacilityTenantCurrentChargesUnitItemCharges>
        <FacilityTenantCurrentChargesUnitItemCharges>
          <Amount>4.1</Amount>
          <Description>sample string 1</Description>
          <EndTimeStamp>2025-06-30T23:26:22.8618323-07:00</EndTimeStamp>
          <StartTimeStamp>2025-06-30T23:26:22.8618323-07:00</StartTimeStamp>
          <Tax>5.1</Tax>
        </FacilityTenantCurrentChargesUnitItemCharges>
      </FacilityTenantCurrentChargesUnitItemChargesList>
      <IsHasCharges>true</IsHasCharges>
      <IssnUnitTypeId>8df07091-a941-4b35-9e36-108b27e7b38f</IssnUnitTypeId>
      <UnitId>sample string 1</UnitId>
      <UnitName>sample string 2</UnitName>
      <UnitTypeDescription>sample string 4</UnitTypeDescription>
    </FacilityTenantCurrentChargesUnitItem>
  </FacilityTenantCurrentChargesUnitList>
  <FacilityTenantUnitsList>
    <FacilityTenantUnitsItem>
      <EndDate>2025-06-30T23:26:22.8618323-07:00</EndDate>
      <IssnUnitTypeId>8d50d919-09b7-4924-a4e7-a682b44f994b</IssnUnitTypeId>
      <LockedOut>true</LockedOut>
      <PaidThruDate>2025-06-30T23:26:22.8618323-07:00</PaidThruDate>
      <PaymentAllowed>true</PaymentAllowed>
      <ReserveType>sample string 1</ReserveType>
      <StartDate>2025-06-30T23:26:22.8618323-07:00</StartDate>
      <UnitId>sample string 2</UnitId>
      <UnitName>sample string 3</UnitName>
      <UnitTypeDescription>sample string 5</UnitTypeDescription>
    </FacilityTenantUnitsItem>
    <FacilityTenantUnitsItem>
      <EndDate>2025-06-30T23:26:22.8618323-07:00</EndDate>
      <IssnUnitTypeId>8d50d919-09b7-4924-a4e7-a682b44f994b</IssnUnitTypeId>
      <LockedOut>true</LockedOut>
      <PaidThruDate>2025-06-30T23:26:22.8618323-07:00</PaidThruDate>
      <PaymentAllowed>true</PaymentAllowed>
      <ReserveType>sample string 1</ReserveType>
      <StartDate>2025-06-30T23:26:22.8618323-07:00</StartDate>
      <UnitId>sample string 2</UnitId>
      <UnitName>sample string 3</UnitName>
      <UnitTypeDescription>sample string 5</UnitTypeDescription>
    </FacilityTenantUnitsItem>
  </FacilityTenantUnitsList>
</FacilityTenantCurrentCharges>