PUT api/customerbank/{id}

Update a specific Customer Bank record by CustomerBankID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

CustomerBank
NameDescriptionTypeAdditional information
CustomerBankId

Sedona internal autonumber for the Customer Bank record; required for PUT

integer

None.

CustomerId

Foreign key from AR_Customer table; required for POST/PUT

integer

Required

BankId

Foreign key from AR_Bank table (not the Customer_Bank_Id); set automatically on POST; set to zero on PUTS to change the Bank

integer

None.

RoutingNumber

The bank's 9-digit routing number; required for POST; set automatically on PUT (already created)

string

Max length: 9

Min length: 9

BankName

BankName (i.e. Wells Fargo, US Bank, etc.); set (and required) only on POST

string

String length: inclusive between 0 and 50

AccountNumber

The customer's bank account number; either AccountNumber or ACHDirectToken is required for POST; value will come back encrypted on GET

string

String length: inclusive between 0 and 20

AccountNumberEncrypted

read only; used internally

string

None.

CheckingOrSavings

C = Checking; S = Savings

string

Max length: 1

Min length: 1

String length: inclusive between 0 and 1

AccountType

Checking or Savings (based on CheckingOrSavings field)

string

None.

PaymentMethodId

Foreign key from AR_Payment_Method table; set automatically during POST/PUT

integer

None.

NameOnAccount

maps to Bank_Account_Name (changed to be more intuitive)

string

String length: inclusive between 0 and 22

UsedForAutoProcess

This bank account should be used for Recurring Auto Processing; if set to true, all other payment methods for this customer will be set to false

boolean

None.

AutoPay

Display only; Y if UsedForAutoProcess = true

string

None.

AutoProcessDay

Day of month to auto-process payment; required if UsedForAutoProcess is true

integer

None.

LastFour

Last four digits of the Bank Account Number; required

string

String length: inclusive between 0 and 4

ACHDirectToken

the token returned from Forte; either AccountNumber or ACHDirectToken is required for POST

string

None.

UsedForNonRecurAuto

This bank account should be used for Non-Recurring Auto Processing

boolean

None.

UsedForInitialPmt

Set to true only to designate this bank account in conjunction with an initial ACH payment

boolean

None.

CustomerBillId

Optional - pass in the CustomerBillId this is tied to; defaults to 1 if not supplied

integer

None.

ChangeExistingEFTDay

Optional - set true on PUT to update the Hold Date for any unsubmitted EFT transactions using this Bank Account to a new AutoProcessDay (same month only)

boolean

None.

VoidExistingEFTs

Optional - set true on PUT to void any existing unsubmitted EFT transactions using this Bank Account

boolean

None.

VoidExistingEFTsReason

string

String length: inclusive between 0 and 50

ReplaceEFTsForCustomerBankID

Optional - pass in a previous CustomerBankID that this payment method is replacing; the system will void any pending ACH transactions (unsubmitted only) for that CustomerBankID, and replace them with this new Customer Bank

integer

None.

ReplaceEFTsForCustomerCCID

Optional - pass in an existing CustomerCCID that this payment method is replacing; the system will void any pending ACH transactions (unsubmitted only) for that CustomerCCID, and replace them with this new Customer Bank

integer

None.

ReplaceExistingEFTsReason

string

String length: inclusive between 0 and 50

PrintCycleInvoices

Print Cycle Invoices in AR_Customer table

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerBankId": 1,
  "CustomerId": 1,
  "BankId": 1,
  "RoutingNumber": "sample string 2",
  "BankName": "sample string 3",
  "AccountNumber": "sample string 4",
  "AccountNumberEncrypted": "sample string 5",
  "CheckingOrSavings": "sample string 6",
  "AccountType": "sample string 7",
  "PaymentMethodId": 1,
  "NameOnAccount": "sample string 8",
  "UsedForAutoProcess": true,
  "AutoPay": "sample string 9",
  "AutoProcessDay": 1,
  "LastFour": "sample string 10",
  "ACHDirectToken": "sample string 11",
  "UsedForNonRecurAuto": true,
  "UsedForInitialPmt": true,
  "CustomerBillId": 1,
  "ChangeExistingEFTDay": true,
  "VoidExistingEFTs": true,
  "VoidExistingEFTsReason": "sample string 12",
  "ReplaceEFTsForCustomerBankID": 1,
  "ReplaceEFTsForCustomerCCID": 1,
  "ReplaceExistingEFTsReason": "sample string 13",
  "PrintCycleInvoices": true
}

application/xml, text/xml

Sample:
<CustomerBank xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <ACHDirectToken>sample string 11</ACHDirectToken>
  <AccountNumber>sample string 4</AccountNumber>
  <AccountNumberEncrypted>sample string 5</AccountNumberEncrypted>
  <AccountType>sample string 7</AccountType>
  <AutoPay>sample string 9</AutoPay>
  <AutoProcessDay>1</AutoProcessDay>
  <BankId>1</BankId>
  <BankName>sample string 3</BankName>
  <ChangeExistingEFTDay>true</ChangeExistingEFTDay>
  <CheckingOrSavings>sample string 6</CheckingOrSavings>
  <CustomerBankId>1</CustomerBankId>
  <CustomerBillId>1</CustomerBillId>
  <CustomerId>1</CustomerId>
  <LastFour>sample string 10</LastFour>
  <NameOnAccount>sample string 8</NameOnAccount>
  <PaymentMethodId>1</PaymentMethodId>
  <PrintCycleInvoices>true</PrintCycleInvoices>
  <ReplaceEFTsForCustomerBankID>1</ReplaceEFTsForCustomerBankID>
  <ReplaceEFTsForCustomerCCID>1</ReplaceEFTsForCustomerCCID>
  <ReplaceExistingEFTsReason>sample string 13</ReplaceExistingEFTsReason>
  <RoutingNumber>sample string 2</RoutingNumber>
  <UsedForAutoProcess>true</UsedForAutoProcess>
  <UsedForInitialPmt>true</UsedForInitialPmt>
  <UsedForNonRecurAuto>true</UsedForNonRecurAuto>
  <VoidExistingEFTs>true</VoidExistingEFTs>
  <VoidExistingEFTsReason>sample string 12</VoidExistingEFTsReason>
</CustomerBank>

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 'CustomerBank'.

Response Information

Resource Description

None.