Accounts Test
CRM/Accounts?constituentId={constituentId}&accountTypeId={accountTypeId}&includeInactive={includeInactive}&includeAffiliates={includeAffiliates}
Get details of all the credit card, direct debit, and SEPA accounts for the specified constituent id and all its visible affiliates' accounts as well.

To exclude accounts of the visible affiliates pass includeAffiliations=false.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/CRM/Accounts?constituentId={constituentId}&accountTypeId={accountTypeId}&includeInactive={includeInactive}&includeAffiliates={includeAffiliates}

URI Parameters

Parameter Name Data Type Required Notes
constituentId integer Y Limit results by constituent.
accountTypeId integer N Filter by account type ID.
includeInactive boolean N Inactive accounts are included by default (true).
includeAffiliates boolean N Accounts for visible affiliates are shown by default (true).

Request Body

None.
No request body.

Response object type : Collection of AccountResponse

Response object type Collection of AccountResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
AccountNumber string Masked account number.
AccountType AccountTypeSummary N Card type (MC, Visa, etc) or Direct Debit type.
FK: TR_ACCOUNT_TYPE.id
BankIdentifierCode string Used for SEPA direct debit accounts.
CardExpiryMonth integer
CardExpiryYear integer
ConstituentId integer N
FK: T_CUSTOMER.customer_no   Resource: Constituents
CreatedBy string
CreatedDateTime date
CreateLocation string
DirectDebitAccountType DirectDebitAccountTypeSummary N Used for direct debit accounts. Required if creating or updating a direct debit account.
FK: TR_DIRECT_DEBIT_ACCOUNT_TYPE.id
Id integer
Inactive boolean
MandateNumber string Used for SEPA direct debit accounts.
MandateType integer Used for SEPA direct debit accounts.
MerchantId string If payment card tokenization is turned on, this is the merchant that was used to generate the token with the processor.
Name string Name on card, or name on the direct debit account.
NumberFirstSix string First six digits of account, unencrypted. Not all six digits may be available.
NumberLastFour string Last 4 digits of account, unencrypted.
PaymentMethodGroup PaymentMethodGroupSummary N If payment card tokenization is turned on, this is the payment method group that was used to locate the merchant to create the token.
FK: TR_PMT_METHOD_GROUP.id   Resource: PaymentMethodUserGroups
ShopperReference string
SignatureDate date Used for SEPA direct debit accounts.
Token string If payment card tokenization is turned on, this is the token that will be submitted to the processor in lieu of actual card details.
UpdatedBy string
UpdatedDateTime date 
[
  {
    "AccountNumber": "sample string 1",
    "AccountType": {
      "Id": 1,
      "Description": "sample string 1",
      "CardPrefix": "sample string 2",
      "CardtypeIndicator": "sample string 3",
      "EditMask": "sample string 4",
      "Inactive": true
    },
    "BankIdentifierCode": "sample string 2",
    "CardExpiryMonth": 1,
    "CardExpiryYear": 1,
    "ConstituentId": 3,
    "CreatedBy": "sample string 4",
    "CreatedDateTime": "2025-04-24T05:08:08.0927516-07:00",
    "CreateLocation": "sample string 5",
    "DirectDebitAccountType": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true
    },
    "Id": 6,
    "Inactive": true,
    "MandateNumber": "sample string 8",
    "MandateType": 1,
    "MerchantId": "sample string 9",
    "Name": "sample string 10",
    "NumberFirstSix": "sample string 11",
    "NumberLastFour": "sample string 12",
    "PaymentMethodGroup": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true,
      "MerchantId": "sample string 3"
    },
    "SignatureDate": "2025-04-24T05:08:08.0927516-07:00",
    "Token": "sample string 14",
    "UpdatedBy": "sample string 15",
    "UpdatedDateTime": "2025-04-24T05:08:08.0927516-07:00",
    "ShopperReference": "sample string 16"
  },
  {
    "AccountNumber": "sample string 1",
    "AccountType": {
      "Id": 1,
      "Description": "sample string 1",
      "CardPrefix": "sample string 2",
      "CardtypeIndicator": "sample string 3",
      "EditMask": "sample string 4",
      "Inactive": true
    },
    "BankIdentifierCode": "sample string 2",
    "CardExpiryMonth": 1,
    "CardExpiryYear": 1,
    "ConstituentId": 3,
    "CreatedBy": "sample string 4",
    "CreatedDateTime": "2025-04-24T05:08:08.0927516-07:00",
    "CreateLocation": "sample string 5",
    "DirectDebitAccountType": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true
    },
    "Id": 6,
    "Inactive": true,
    "MandateNumber": "sample string 8",
    "MandateType": 1,
    "MerchantId": "sample string 9",
    "Name": "sample string 10",
    "NumberFirstSix": "sample string 11",
    "NumberLastFour": "sample string 12",
    "PaymentMethodGroup": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true,
      "MerchantId": "sample string 3"
    },
    "SignatureDate": "2025-04-24T05:08:08.0927516-07:00",
    "Token": "sample string 14",
    "UpdatedBy": "sample string 15",
    "UpdatedDateTime": "2025-04-24T05:08:08.0927516-07:00",
    "ShopperReference": "sample string 16"
  }
]
<AccountsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AccountResponse>
    <AccountNumber>sample string 1</AccountNumber>
    <AccountType>
      <CardPrefix>sample string 2</CardPrefix>
      <CardtypeIndicator>sample string 3</CardtypeIndicator>
      <Description>sample string 1</Description>
      <EditMask>sample string 4</EditMask>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </AccountType>
    <BankIdentifierCode>sample string 2</BankIdentifierCode>
    <CardExpiryMonth>1</CardExpiryMonth>
    <CardExpiryYear>1</CardExpiryYear>
    <ConstituentId>3</ConstituentId>
    <CreateLocation>sample string 5</CreateLocation>
    <CreatedBy>sample string 4</CreatedBy>
    <CreatedDateTime>2025-04-24T05:08:08.0927516-07:00</CreatedDateTime>
    <DirectDebitAccountType>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </DirectDebitAccountType>
    <Id>6</Id>
    <Inactive>true</Inactive>
    <MandateNumber>sample string 8</MandateNumber>
    <MandateType>1</MandateType>
    <MerchantId>sample string 9</MerchantId>
    <Name>sample string 10</Name>
    <NumberFirstSix>sample string 11</NumberFirstSix>
    <NumberLastFour>sample string 12</NumberLastFour>
    <PaymentMethodGroup>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <MerchantId>sample string 3</MerchantId>
    </PaymentMethodGroup>
    <ShopperReference>sample string 16</ShopperReference>
    <SignatureDate>2025-04-24T05:08:08.0927516-07:00</SignatureDate>
    <Token>sample string 14</Token>
    <UpdatedBy>sample string 15</UpdatedBy>
    <UpdatedDateTime>2025-04-24T05:08:08.0927516-07:00</UpdatedDateTime>
  </AccountResponse>
  <AccountResponse>
    <AccountNumber>sample string 1</AccountNumber>
    <AccountType>
      <CardPrefix>sample string 2</CardPrefix>
      <CardtypeIndicator>sample string 3</CardtypeIndicator>
      <Description>sample string 1</Description>
      <EditMask>sample string 4</EditMask>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </AccountType>
    <BankIdentifierCode>sample string 2</BankIdentifierCode>
    <CardExpiryMonth>1</CardExpiryMonth>
    <CardExpiryYear>1</CardExpiryYear>
    <ConstituentId>3</ConstituentId>
    <CreateLocation>sample string 5</CreateLocation>
    <CreatedBy>sample string 4</CreatedBy>
    <CreatedDateTime>2025-04-24T05:08:08.0927516-07:00</CreatedDateTime>
    <DirectDebitAccountType>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </DirectDebitAccountType>
    <Id>6</Id>
    <Inactive>true</Inactive>
    <MandateNumber>sample string 8</MandateNumber>
    <MandateType>1</MandateType>
    <MerchantId>sample string 9</MerchantId>
    <Name>sample string 10</Name>
    <NumberFirstSix>sample string 11</NumberFirstSix>
    <NumberLastFour>sample string 12</NumberLastFour>
    <PaymentMethodGroup>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
      <MerchantId>sample string 3</MerchantId>
    </PaymentMethodGroup>
    <ShopperReference>sample string 16</ShopperReference>
    <SignatureDate>2025-04-24T05:08:08.0927516-07:00</SignatureDate>
    <Token>sample string 14</Token>
    <UpdatedBy>sample string 15</UpdatedBy>
    <UpdatedDateTime>2025-04-24T05:08:08.0927516-07:00</UpdatedDateTime>
  </AccountResponse>
</AccountsResponse>
Change Version Description Contract Old New
Property Added 15.2.26 ShopperReference has been added to AccountResponse AccountResponse AccountResponse.ShopperReference
Parameter Added 15.1.0 New parameter added accountTypeId accountTypeId
Parameter Changed 15.0.0 constituentId has been marked as required. Required