GET api/bankcodes/getListByEntityNumber?entityNumber={entityNumber}&includeInactive={includeInactive}&excludeAbaNumber={excludeAbaNumber}

GET: api/BankCodes/getListByEntityNumber

Request Information

URI Parameters

Name	Type	Additional information
entityNumber	string	Required
includeInactive	boolean	Required
excludeAbaNumber	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of BankCodeItemViewModel

Name	Description	Type	Additional information
BankCodeId	Bank Code Id	integer	None.
BankCode	Bank Code	string	None.
BankCodeDescription	Bank Code Description	string	None.
BankAccountNumber	Bank Account Number	string	None.
IsActive	IsActive	boolean	None.
ChartOfAccountsID	ChartOfAccountsID	integer	None.
InterestBearingAccount	Interest bearing account	InterestBearingAccountViewModel	None.
AbaId	AbaId	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "abaId": 1,
    "bankCodeId": 1,
    "bankCode": "sample string 2",
    "bankCodeDescription": "sample string 3",
    "bankAccountNumber": "sample string 4",
    "isActive": true,
    "chartOfAccountsID": 6,
    "interestBearingAccount": {
      "term": 1,
      "id": 1,
      "accountTypeId": 2,
      "effectiveRate": 1.0,
      "effectiveDate": "2024-10-14T04:22:36.6476822-04:00",
      "maturityDate": "2024-10-14T04:22:36.6476822-04:00"
    }
  },
  {
    "abaId": 1,
    "bankCodeId": 1,
    "bankCode": "sample string 2",
    "bankCodeDescription": "sample string 3",
    "bankAccountNumber": "sample string 4",
    "isActive": true,
    "chartOfAccountsID": 6,
    "interestBearingAccount": {
      "term": 1,
      "id": 1,
      "accountTypeId": 2,
      "effectiveRate": 1.0,
      "effectiveDate": "2024-10-14T04:22:36.6476822-04:00",
      "maturityDate": "2024-10-14T04:22:36.6476822-04:00"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfBankCodeItemViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <BankCodeItemViewModel>
    <AbaId>1</AbaId>
    <BankAccountNumber>sample string 4</BankAccountNumber>
    <BankCode>sample string 2</BankCode>
    <BankCodeDescription>sample string 3</BankCodeDescription>
    <BankCodeId>1</BankCodeId>
    <ChartOfAccountsID>6</ChartOfAccountsID>
    <InterestBearingAccount xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.AccountType">
      <d3p1:AccountTypeId>2</d3p1:AccountTypeId>
      <d3p1:EffectiveDate>2024-10-14T04:22:36.6476822-04:00</d3p1:EffectiveDate>
      <d3p1:EffectiveRate>1</d3p1:EffectiveRate>
      <d3p1:MaturityDate>2024-10-14T04:22:36.6476822-04:00</d3p1:MaturityDate>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:Term>1</d3p1:Term>
    </InterestBearingAccount>
  </BankCodeItemViewModel>
  <BankCodeItemViewModel>
    <AbaId>1</AbaId>
    <BankAccountNumber>sample string 4</BankAccountNumber>
    <BankCode>sample string 2</BankCode>
    <BankCodeDescription>sample string 3</BankCodeDescription>
    <BankCodeId>1</BankCodeId>
    <ChartOfAccountsID>6</ChartOfAccountsID>
    <InterestBearingAccount xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.AccountType">
      <d3p1:AccountTypeId>2</d3p1:AccountTypeId>
      <d3p1:EffectiveDate>2024-10-14T04:22:36.6476822-04:00</d3p1:EffectiveDate>
      <d3p1:EffectiveRate>1</d3p1:EffectiveRate>
      <d3p1:MaturityDate>2024-10-14T04:22:36.6476822-04:00</d3p1:MaturityDate>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:Term>1</d3p1:Term>
    </InterestBearingAccount>
  </BankCodeItemViewModel>
</ArrayOfBankCodeItemViewModel>