POST api/bankcodes

Route for creating bank code

Request Information

URI Parameters

None.

Body Parameters

BankCodeCreateViewModel
NameDescriptionTypeAdditional information
SuperEntityId

Super Entity Id

integer

Required
Code

Code (OP01, SEC1, etc.)

string

Required
InterestBearingAccount

interest bearing account update

InterestBearingAccountCreateViewModel

None.
Address

Address

SaveAddressViewModel

None.
BankCodeDescription

Bank Code Description

string

Required
ChartOfAccountsId

GL Account Id

integer

Required
BankId

Bank ID

integer

Required
GLSubAccountId

GL Sub Account Nmae Required when GL Account are linked to GL Sub Account via Chart of Accounts

integer

None.
InterestChartOfAccountID

Interest Chart of Account Id Optional

integer

None.
InterestGlSubAccountID

Interest GL Sub Account ID Required if InterestChartOfAccountID is not empty

integer

None.
BankFeeChartOfAccountID

Bank Fee Chart of Account ID Optional

integer

None.
BankFeeGlSubAccountID

Bank Fee Gl Sub Account Id Required if BankFeeChartOfAccountID is not empty

integer

None.
AbaNumberId

ABA Number Id Highly recommended to be Required on UI but user able to create Bank Code without Aba Number Id

integer

None.
BankAccount

Bank Account

string

Required
BrokerageAccount

Brokerage Account

string

None.
CheckPrintDescription1

MCIR Description 1 Required only for Canadian Banks

string

None.
CheckPrintDescription2

MCIR Description 2 Required only for Canadian Banks

string

None.
CheckPrintDescription3

Check Print Description 3 Required only for Canadian Banks

string

None.
Micr1

MCIR 1

string

None.
Micr2

MCIR 2

string

None.
LastCheckNumber

Last Check Number

integer

Range: inclusive between 0 and 999999999
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

Required
AccountUseId

Account Use Id

integer

Required
PositivePayEligible

Positive Pay Eligible

boolean

None.
BankBalanceMinimum

Bank Balance Minimum

integer

Range: inclusive between 0 and 10000000
AutoSignMaxAmount

Bank auto Sign Max Amount

decimal number

None.
CheckSignatureID

integer

None.
EntityId

Entity

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "superEntityId": 1,
  "code": "sample string 2",
  "interestBearingAccount": {
    "accountTypeId": 1,
    "effectiveRate": 1.0,
    "effectiveDate": "2024-10-13T16:16:24.9199231-04:00",
    "maturityDate": "2024-10-13T16:16:24.9199231-04:00"
  },
  "address": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "city": "sample string 3",
    "state": "sample string 4",
    "zipCode": "sample string 5",
    "country": "sample string 6"
  },
  "bankCodeDescription": "sample string 3",
  "chartOfAccountsId": 4,
  "bankId": 5,
  "glSubAccountId": 1,
  "interestChartOfAccountID": 1,
  "interestGlSubAccountID": 1,
  "bankFeeChartOfAccountID": 1,
  "bankFeeGlSubAccountID": 1,
  "abaNumberId": 1,
  "bankAccount": "sample string 6",
  "brokerageAccount": "sample string 7",
  "checkPrintDescription1": "sample string 8",
  "checkPrintDescription2": "sample string 9",
  "checkPrintDescription3": "sample string 10",
  "micr1": "sample string 11",
  "micr2": "sample string 12",
  "lastCheckNumber": 13,
  "isActive": true,
  "isTransactionalBank": true,
  "nonTransactionalAccount": true,
  "isCheckExport": true,
  "accountTypeId": 18,
  "accountUseId": 19,
  "positivePayEligible": true,
  "bankBalanceMinimum": 20,
  "autoSignMaxAmount": 1.0,
  "checkSignatureID": 1,
  "entityId": 1
}

application/xml, text/xml

Sample: 
<BankCodeCreateViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.BankCode">
  <AbaNumberId>1</AbaNumberId>
  <AccountTypeId>18</AccountTypeId>
  <AccountUseId>19</AccountUseId>
  <AutoSignMaxAmount>1</AutoSignMaxAmount>
  <BankAccount>sample string 6</BankAccount>
  <BankBalanceMinimum>20</BankBalanceMinimum>
  <BankCodeDescription>sample string 3</BankCodeDescription>
  <BankFeeChartOfAccountID>1</BankFeeChartOfAccountID>
  <BankFeeGlSubAccountID>1</BankFeeGlSubAccountID>
  <BankId>5</BankId>
  <BrokerageAccount>sample string 7</BrokerageAccount>
  <ChartOfAccountsId>4</ChartOfAccountsId>
  <CheckPrintDescription1>sample string 8</CheckPrintDescription1>
  <CheckPrintDescription2>sample string 9</CheckPrintDescription2>
  <CheckPrintDescription3>sample string 10</CheckPrintDescription3>
  <CheckSignatureID>1</CheckSignatureID>
  <EntityId>1</EntityId>
  <GLSubAccountId>1</GLSubAccountId>
  <InterestChartOfAccountID>1</InterestChartOfAccountID>
  <InterestGlSubAccountID>1</InterestGlSubAccountID>
  <IsActive>true</IsActive>
  <IsCheckExport>true</IsCheckExport>
  <IsTransactionalBank>true</IsTransactionalBank>
  <LastCheckNumber>13</LastCheckNumber>
  <Micr1>sample string 11</Micr1>
  <Micr2>sample string 12</Micr2>
  <NonTransactionalAccount>true</NonTransactionalAccount>
  <PositivePayEligible>true</PositivePayEligible>
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:State>sample string 4</d2p1:State>
    <d2p1:ZipCode>sample string 5</d2p1:ZipCode>
  </Address>
  <Code>sample string 2</Code>
  <InterestBearingAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.AccountType">
    <d2p1:AccountTypeId>1</d2p1:AccountTypeId>
    <d2p1:EffectiveDate>2024-10-13T16:16:24.9199231-04:00</d2p1:EffectiveDate>
    <d2p1:EffectiveRate>1</d2p1:EffectiveRate>
    <d2p1:MaturityDate>2024-10-13T16:16:24.9199231-04:00</d2p1:MaturityDate>
  </InterestBearingAccount>
  <SuperEntityId>1</SuperEntityId>
</BankCodeCreateViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BankCodeCreateViewModel'.

Response Information

Resource Description

BankCodeCreateViewModel
NameDescriptionTypeAdditional information
SuperEntityId

Super Entity Id

integer

Required
Code

Code (OP01, SEC1, etc.)

string

Required
InterestBearingAccount

interest bearing account update

InterestBearingAccountCreateViewModel

None.
Address

Address

SaveAddressViewModel

None.
BankCodeDescription

Bank Code Description

string

Required
ChartOfAccountsId

GL Account Id

integer

Required
BankId

Bank ID

integer

Required
GLSubAccountId

GL Sub Account Nmae Required when GL Account are linked to GL Sub Account via Chart of Accounts

integer

None.
InterestChartOfAccountID

Interest Chart of Account Id Optional

integer

None.
InterestGlSubAccountID

Interest GL Sub Account ID Required if InterestChartOfAccountID is not empty

integer

None.
BankFeeChartOfAccountID

Bank Fee Chart of Account ID Optional

integer

None.
BankFeeGlSubAccountID

Bank Fee Gl Sub Account Id Required if BankFeeChartOfAccountID is not empty

integer

None.
AbaNumberId

ABA Number Id Highly recommended to be Required on UI but user able to create Bank Code without Aba Number Id

integer

None.
BankAccount

Bank Account

string

Required
BrokerageAccount

Brokerage Account

string

None.
CheckPrintDescription1

MCIR Description 1 Required only for Canadian Banks

string

None.
CheckPrintDescription2

MCIR Description 2 Required only for Canadian Banks

string

None.
CheckPrintDescription3

Check Print Description 3 Required only for Canadian Banks

string

None.
Micr1

MCIR 1

string

None.
Micr2

MCIR 2

string

None.
LastCheckNumber

Last Check Number

integer

Range: inclusive between 0 and 999999999
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

Required
AccountUseId

Account Use Id

integer

Required
PositivePayEligible

Positive Pay Eligible

boolean

None.
BankBalanceMinimum

Bank Balance Minimum

integer

Range: inclusive between 0 and 10000000
AutoSignMaxAmount

Bank auto Sign Max Amount

decimal number

None.
CheckSignatureID

integer

None.
EntityId

Entity

integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "superEntityId": 1,
  "code": "sample string 2",
  "interestBearingAccount": {
    "accountTypeId": 1,
    "effectiveRate": 1.0,
    "effectiveDate": "2024-10-13T16:16:24.9355539-04:00",
    "maturityDate": "2024-10-13T16:16:24.9355539-04:00"
  },
  "address": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "city": "sample string 3",
    "state": "sample string 4",
    "zipCode": "sample string 5",
    "country": "sample string 6"
  },
  "bankCodeDescription": "sample string 3",
  "chartOfAccountsId": 4,
  "bankId": 5,
  "glSubAccountId": 1,
  "interestChartOfAccountID": 1,
  "interestGlSubAccountID": 1,
  "bankFeeChartOfAccountID": 1,
  "bankFeeGlSubAccountID": 1,
  "abaNumberId": 1,
  "bankAccount": "sample string 6",
  "brokerageAccount": "sample string 7",
  "checkPrintDescription1": "sample string 8",
  "checkPrintDescription2": "sample string 9",
  "checkPrintDescription3": "sample string 10",
  "micr1": "sample string 11",
  "micr2": "sample string 12",
  "lastCheckNumber": 13,
  "isActive": true,
  "isTransactionalBank": true,
  "nonTransactionalAccount": true,
  "isCheckExport": true,
  "accountTypeId": 18,
  "accountUseId": 19,
  "positivePayEligible": true,
  "bankBalanceMinimum": 20,
  "autoSignMaxAmount": 1.0,
  "checkSignatureID": 1,
  "entityId": 1
}

application/xml, text/xml

Sample: 
<BankCodeCreateViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.BankCode">
  <AbaNumberId>1</AbaNumberId>
  <AccountTypeId>18</AccountTypeId>
  <AccountUseId>19</AccountUseId>
  <AutoSignMaxAmount>1</AutoSignMaxAmount>
  <BankAccount>sample string 6</BankAccount>
  <BankBalanceMinimum>20</BankBalanceMinimum>
  <BankCodeDescription>sample string 3</BankCodeDescription>
  <BankFeeChartOfAccountID>1</BankFeeChartOfAccountID>
  <BankFeeGlSubAccountID>1</BankFeeGlSubAccountID>
  <BankId>5</BankId>
  <BrokerageAccount>sample string 7</BrokerageAccount>
  <ChartOfAccountsId>4</ChartOfAccountsId>
  <CheckPrintDescription1>sample string 8</CheckPrintDescription1>
  <CheckPrintDescription2>sample string 9</CheckPrintDescription2>
  <CheckPrintDescription3>sample string 10</CheckPrintDescription3>
  <CheckSignatureID>1</CheckSignatureID>
  <EntityId>1</EntityId>
  <GLSubAccountId>1</GLSubAccountId>
  <InterestChartOfAccountID>1</InterestChartOfAccountID>
  <InterestGlSubAccountID>1</InterestGlSubAccountID>
  <IsActive>true</IsActive>
  <IsCheckExport>true</IsCheckExport>
  <IsTransactionalBank>true</IsTransactionalBank>
  <LastCheckNumber>13</LastCheckNumber>
  <Micr1>sample string 11</Micr1>
  <Micr2>sample string 12</Micr2>
  <NonTransactionalAccount>true</NonTransactionalAccount>
  <PositivePayEligible>true</PositivePayEligible>
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Address">
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:City>sample string 3</d2p1:City>
    <d2p1:Country>sample string 6</d2p1:Country>
    <d2p1:State>sample string 4</d2p1:State>
    <d2p1:ZipCode>sample string 5</d2p1:ZipCode>
  </Address>
  <Code>sample string 2</Code>
  <InterestBearingAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.AccountType">
    <d2p1:AccountTypeId>1</d2p1:AccountTypeId>
    <d2p1:EffectiveDate>2024-10-13T16:16:24.9355539-04:00</d2p1:EffectiveDate>
    <d2p1:EffectiveRate>1</d2p1:EffectiveRate>
    <d2p1:MaturityDate>2024-10-13T16:16:24.9355539-04:00</d2p1:MaturityDate>
  </InterestBearingAccount>
  <SuperEntityId>1</SuperEntityId>
</BankCodeCreateViewModel>