GET api/entities/{entityId}/bankcodes?activesOnly={activesOnly}&transactionalBanksOnly={transactionalBanksOnly}&transactionalAccountsOnly={transactionalAccountsOnly}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
entityId

integer

Required
activesOnly

boolean

Default value is False
transactionalBanksOnly

boolean

Default value is False
transactionalAccountsOnly

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of BankCodeDetailsViewModel
NameDescriptionTypeAdditional information
BankCodeId

Bank Code Id

integer

None.
BankId

Bank ID

integer

None.
SuperEntityId

Super Entity ID

integer

None.
ChartOfAccountsId

Chart Of Accounts ID

integer

None.
InterestChartOfAccountID

Interest Chart Of Account ID

integer

None.
InterestGlSubAccountID

Interest Gl SubAccount ID

integer

None.
BankFeeChartOfAccountID

Bank Fee Chart of Account ID

integer

None.
BankFeeGlSubAccountID

Bank Fee SubAccount ID

integer

None.
Code

Code

string

None.
BankCodeDescription

Bank Code Description

string

None.
GLAccountId

GL Account ID

integer

None.
GLAccountNumber

GL Account Number

string

None.
GLAccountDescription

GL Account Description

string

None.
GLSubAccountName

GL Sub Account Nmae

string

None.
AchCode

ACH Code

string

None.
AbaNumber

ABA Number

string

None.
AbaNumberId

Aba ID

integer

None.
BankAccount

Bank Account

string

None.
BrokerageAccount

Brokerage Account

string

None.
McirDescription1

MCIR Description 1

string

None.
McirDescription2

MCIR Description 2

string

None.
CheckPrintDescription1

MCIR Description 1

string

None.
CheckPrintDescription2

MCIR Description 2

string

None.
CheckPrintDescription3

Check Print Description 3

string

None.
Micr1

MCIR 1

string

None.
Micr2

MCIR 2

string

None.
LastCheckNumber

Last Check Number

integer

None.
AddressId

Address ID

integer

None.
Address1

Address Line 1

string

None.
Address2

Address Line 2

string

None.
City

City

string

None.
State

State

string

None.
Country

Country

string

None.
ZipCode

Zip Code

string

None.
IsActive

Is Active

boolean

None.
IsTransactionalBank

Is Lockbox

boolean

None.
NonTransactionalAccount

Non Transactional Account

boolean

None.
IsCheckExport

Is Check Export

boolean

None.
AccountTypeId

Account Type Id

integer

None.
AccountUseId

Account Use Id

integer

None.
PositivePayEligible

Positive Pay Eligible

boolean

None.
BankBalanceMinimum

Bank Balance Minimum

integer

None.
GLSubAccountId

GL SubAccount Id

integer

None.
AutoSignMaxAmount

AutoSignMaxAmount

decimal number

None.
InterestBearingAccount

Interest bearing account

InterestBearingAccountViewModel

None.
CheckSignatureId

Check Signature Id

integer

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "bankCodeId": 1,
    "bankId": 1,
    "superEntityId": 2,
    "chartOfAccountsId": 3,
    "interestChartOfAccountID": 1,
    "interestGlSubAccountID": 1,
    "bankFeeChartOfAccountID": 1,
    "bankFeeGlSubAccountID": 1,
    "code": "sample string 4",
    "bankCodeDescription": "sample string 5",
    "glAccountId": 6,
    "glAccountNumber": "sample string 7",
    "glAccountDescription": "sample string 8",
    "glSubAccountName": "sample string 9",
    "achCode": "sample string 10",
    "abaNumber": "sample string 11",
    "abaNumberId": 1,
    "bankAccount": "sample string 12",
    "brokerageAccount": "sample string 13",
    "mcirDescription1": "sample string 14",
    "mcirDescription2": "sample string 15",
    "checkPrintDescription1": "sample string 16",
    "checkPrintDescription2": "sample string 17",
    "checkPrintDescription3": "sample string 18",
    "micr1": "sample string 19",
    "micr2": "sample string 20",
    "lastCheckNumber": 21,
    "addressId": 22,
    "address1": "sample string 23",
    "address2": "sample string 24",
    "city": "sample string 25",
    "state": "sample string 26",
    "country": "sample string 27",
    "zipCode": "sample string 28",
    "isActive": true,
    "isTransactionalBank": true,
    "nonTransactionalAccount": true,
    "isCheckExport": true,
    "accountTypeId": 1,
    "accountUseId": 1,
    "positivePayEligible": true,
    "bankBalanceMinimum": 32,
    "glSubAccountId": 33,
    "autoSignMaxAmount": 1.0,
    "interestBearingAccount": {
      "term": 1,
      "id": 1,
      "accountTypeId": 2,
      "effectiveRate": 1.0,
      "effectiveDate": "2025-04-03T18:13:03.3267266-04:00",
      "maturityDate": "2025-04-03T18:13:03.3267266-04:00"
    },
    "checkSignatureId": 1
  },
  {
    "bankCodeId": 1,
    "bankId": 1,
    "superEntityId": 2,
    "chartOfAccountsId": 3,
    "interestChartOfAccountID": 1,
    "interestGlSubAccountID": 1,
    "bankFeeChartOfAccountID": 1,
    "bankFeeGlSubAccountID": 1,
    "code": "sample string 4",
    "bankCodeDescription": "sample string 5",
    "glAccountId": 6,
    "glAccountNumber": "sample string 7",
    "glAccountDescription": "sample string 8",
    "glSubAccountName": "sample string 9",
    "achCode": "sample string 10",
    "abaNumber": "sample string 11",
    "abaNumberId": 1,
    "bankAccount": "sample string 12",
    "brokerageAccount": "sample string 13",
    "mcirDescription1": "sample string 14",
    "mcirDescription2": "sample string 15",
    "checkPrintDescription1": "sample string 16",
    "checkPrintDescription2": "sample string 17",
    "checkPrintDescription3": "sample string 18",
    "micr1": "sample string 19",
    "micr2": "sample string 20",
    "lastCheckNumber": 21,
    "addressId": 22,
    "address1": "sample string 23",
    "address2": "sample string 24",
    "city": "sample string 25",
    "state": "sample string 26",
    "country": "sample string 27",
    "zipCode": "sample string 28",
    "isActive": true,
    "isTransactionalBank": true,
    "nonTransactionalAccount": true,
    "isCheckExport": true,
    "accountTypeId": 1,
    "accountUseId": 1,
    "positivePayEligible": true,
    "bankBalanceMinimum": 32,
    "glSubAccountId": 33,
    "autoSignMaxAmount": 1.0,
    "interestBearingAccount": {
      "term": 1,
      "id": 1,
      "accountTypeId": 2,
      "effectiveRate": 1.0,
      "effectiveDate": "2025-04-03T18:13:03.3267266-04:00",
      "maturityDate": "2025-04-03T18:13:03.3267266-04:00"
    },
    "checkSignatureId": 1
  }
]

application/xml, text/xml

Sample: 
<ArrayOfBankCodeDetailsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <BankCodeDetailsViewModel>
    <AbaNumber>sample string 11</AbaNumber>
    <AbaNumberId>1</AbaNumberId>
    <AccountTypeId>1</AccountTypeId>
    <AccountUseId>1</AccountUseId>
    <AchCode>sample string 10</AchCode>
    <Address1>sample string 23</Address1>
    <Address2>sample string 24</Address2>
    <AddressId>22</AddressId>
    <AutoSignMaxAmount>1</AutoSignMaxAmount>
    <BankAccount>sample string 12</BankAccount>
    <BankBalanceMinimum>32</BankBalanceMinimum>
    <BankCodeDescription>sample string 5</BankCodeDescription>
    <BankCodeId>1</BankCodeId>
    <BankFeeChartOfAccountID>1</BankFeeChartOfAccountID>
    <BankFeeGlSubAccountID>1</BankFeeGlSubAccountID>
    <BankId>1</BankId>
    <BrokerageAccount>sample string 13</BrokerageAccount>
    <ChartOfAccountsId>3</ChartOfAccountsId>
    <CheckPrintDescription1>sample string 16</CheckPrintDescription1>
    <CheckPrintDescription2>sample string 17</CheckPrintDescription2>
    <CheckPrintDescription3>sample string 18</CheckPrintDescription3>
    <CheckSignatureId>1</CheckSignatureId>
    <City>sample string 25</City>
    <Code>sample string 4</Code>
    <Country>sample string 27</Country>
    <GLAccountDescription>sample string 8</GLAccountDescription>
    <GLAccountId>6</GLAccountId>
    <GLAccountNumber>sample string 7</GLAccountNumber>
    <GLSubAccountId>33</GLSubAccountId>
    <GLSubAccountName>sample string 9</GLSubAccountName>
    <InterestBearingAccount xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.AccountType">
      <d3p1:AccountTypeId>2</d3p1:AccountTypeId>
      <d3p1:EffectiveDate>2025-04-03T18:13:03.3267266-04:00</d3p1:EffectiveDate>
      <d3p1:EffectiveRate>1</d3p1:EffectiveRate>
      <d3p1:MaturityDate>2025-04-03T18:13:03.3267266-04:00</d3p1:MaturityDate>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:Term>1</d3p1:Term>
    </InterestBearingAccount>
    <InterestChartOfAccountID>1</InterestChartOfAccountID>
    <InterestGlSubAccountID>1</InterestGlSubAccountID>
    <IsActive>true</IsActive>
    <IsCheckExport>true</IsCheckExport>
    <IsTransactionalBank>true</IsTransactionalBank>
    <LastCheckNumber>21</LastCheckNumber>
    <McirDescription1>sample string 14</McirDescription1>
    <McirDescription2>sample string 15</McirDescription2>
    <Micr1>sample string 19</Micr1>
    <Micr2>sample string 20</Micr2>
    <NonTransactionalAccount>true</NonTransactionalAccount>
    <PositivePayEligible>true</PositivePayEligible>
    <State>sample string 26</State>
    <SuperEntityId>2</SuperEntityId>
    <ZipCode>sample string 28</ZipCode>
  </BankCodeDetailsViewModel>
  <BankCodeDetailsViewModel>
    <AbaNumber>sample string 11</AbaNumber>
    <AbaNumberId>1</AbaNumberId>
    <AccountTypeId>1</AccountTypeId>
    <AccountUseId>1</AccountUseId>
    <AchCode>sample string 10</AchCode>
    <Address1>sample string 23</Address1>
    <Address2>sample string 24</Address2>
    <AddressId>22</AddressId>
    <AutoSignMaxAmount>1</AutoSignMaxAmount>
    <BankAccount>sample string 12</BankAccount>
    <BankBalanceMinimum>32</BankBalanceMinimum>
    <BankCodeDescription>sample string 5</BankCodeDescription>
    <BankCodeId>1</BankCodeId>
    <BankFeeChartOfAccountID>1</BankFeeChartOfAccountID>
    <BankFeeGlSubAccountID>1</BankFeeGlSubAccountID>
    <BankId>1</BankId>
    <BrokerageAccount>sample string 13</BrokerageAccount>
    <ChartOfAccountsId>3</ChartOfAccountsId>
    <CheckPrintDescription1>sample string 16</CheckPrintDescription1>
    <CheckPrintDescription2>sample string 17</CheckPrintDescription2>
    <CheckPrintDescription3>sample string 18</CheckPrintDescription3>
    <CheckSignatureId>1</CheckSignatureId>
    <City>sample string 25</City>
    <Code>sample string 4</Code>
    <Country>sample string 27</Country>
    <GLAccountDescription>sample string 8</GLAccountDescription>
    <GLAccountId>6</GLAccountId>
    <GLAccountNumber>sample string 7</GLAccountNumber>
    <GLSubAccountId>33</GLSubAccountId>
    <GLSubAccountName>sample string 9</GLSubAccountName>
    <InterestBearingAccount xmlns:d3p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.AccountType">
      <d3p1:AccountTypeId>2</d3p1:AccountTypeId>
      <d3p1:EffectiveDate>2025-04-03T18:13:03.3267266-04:00</d3p1:EffectiveDate>
      <d3p1:EffectiveRate>1</d3p1:EffectiveRate>
      <d3p1:MaturityDate>2025-04-03T18:13:03.3267266-04:00</d3p1:MaturityDate>
      <d3p1:Id>1</d3p1:Id>
      <d3p1:Term>1</d3p1:Term>
    </InterestBearingAccount>
    <InterestChartOfAccountID>1</InterestChartOfAccountID>
    <InterestGlSubAccountID>1</InterestGlSubAccountID>
    <IsActive>true</IsActive>
    <IsCheckExport>true</IsCheckExport>
    <IsTransactionalBank>true</IsTransactionalBank>
    <LastCheckNumber>21</LastCheckNumber>
    <McirDescription1>sample string 14</McirDescription1>
    <McirDescription2>sample string 15</McirDescription2>
    <Micr1>sample string 19</Micr1>
    <Micr2>sample string 20</Micr2>
    <NonTransactionalAccount>true</NonTransactionalAccount>
    <PositivePayEligible>true</PositivePayEligible>
    <State>sample string 26</State>
    <SuperEntityId>2</SuperEntityId>
    <ZipCode>sample string 28</ZipCode>
  </BankCodeDetailsViewModel>
</ArrayOfBankCodeDetailsViewModel>