Session Test
Web/Session/{sessionKey}/Constituent/OnAccount?paymentMethodIds={paymentMethodIds}
Returns the balance of on account money held by the constituent associated to the provided session key.

Results can be filtered by specific on-account payment methods. The Amount used in current session is also indicated.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Session/{sessionKey}/Constituent/OnAccount?paymentMethodIds={paymentMethodIds}

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y
paymentMethodIds string N Comma separated list of ids from TR_PAYMENT_METHOD that are the on-account payment method type.

Request Body

None.
No request body.

Response object type : Collection of OnAccountBalance

Response object type Collection of OnAccountBalance has the following properties.
Property Name Data Type Length Required Readonly Notes
Balance decimal number The total balance of the on-account money for this payment method and constituent disregarding the current session payments.
ConstituentId integer
CurrentBalance decimal number The net balance, taking the current session amount into account.
Description string The description of the on-account payment method.
PaymentMethodId integer
UsedInSession decimal number The amount of the on-account money that is being used in the current session. 
[
  {
    "ConstituentId": 1,
    "PaymentMethodId": 2,
    "Description": "sample string 3",
    "Balance": 4.0,
    "UsedInSession": 5.0,
    "CurrentBalance": 6.0
  },
  {
    "ConstituentId": 1,
    "PaymentMethodId": 2,
    "Description": "sample string 3",
    "Balance": 4.0,
    "UsedInSession": 5.0,
    "CurrentBalance": 6.0
  }
]
<OnAccountBalances xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <OnAccountBalance>
    <Balance>4</Balance>
    <ConstituentId>1</ConstituentId>
    <CurrentBalance>6</CurrentBalance>
    <Description>sample string 3</Description>
    <PaymentMethodId>2</PaymentMethodId>
    <UsedInSession>5</UsedInSession>
  </OnAccountBalance>
  <OnAccountBalance>
    <Balance>4</Balance>
    <ConstituentId>1</ConstituentId>
    <CurrentBalance>6</CurrentBalance>
    <Description>sample string 3</Description>
    <PaymentMethodId>2</PaymentMethodId>
    <UsedInSession>5</UsedInSession>
  </OnAccountBalance>
</OnAccountBalances>
Change Version Description Contract Old New
Parameter Changed 15.0.0 sessionKey has been marked as required. Required