About VendorBankAccount
To pay vendors via an Automated Clearing House (ACH), the vendor must provide bank account information. The Bill.com system securely stores and encrypts this information. Read results only display the last 4 digits of the account and routing details.
This is a Multi Factor Authentication (MFA) trusted endpoint. For more information, see the Multi Factor Authentication Workflow in order to establish an MFA trusted session prior to using this endpoint.
Note: Developers who joined the Developer Program and used this endpoint prior to March 31st, 2017 will not require an MFA Trusted Session to use this endpoint and can continue using this endpoint as they normally would.
After adding the bank account, the bank account is immediately in the verified status [status="1"] (in the old UI, the bank account is in the pending status). Within 1-2 business days, a test deposit is sent to your vendor's bank account to confirm if it is able to receive payments.
If a VendorBankAccount is invalidated or deactivated the Vendors payBy field will switch back to 0.
Note: Only one active Vendor Bank account is allowed. To Correct a Vendor's Bank Account information, the Vendor Bank Account must be deleted and a new vendor bank account needs to be created.
Create
Request
<API_URL_EndPoint>/Crud/Create/VendorBankAccount.json
data={
"obj" : {
"entity" : "VendorBankAccount",
"isActive" : "1",
"vendorId" : "00901ILFOCYSHLIeegga",
"accountNumber" : "1234567",
"routingNumber" : "121000358",
"usersId" : "00601ESFEIZCZKTJf6d4",
"isSavings" : false,
"isPersonalAcct" : true
}
}Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"entity" : "VendorBankAccount",
"id" : "vba01RXXGGIGMOZ4dex5",
"isActive" : "1",
"createdTime" : "2016-11-21T18:44:10.000+0000",
"updatedTime" : "2016-11-21T18:44:10.000+0000",
"vendorId" : "00901ILFOCYSHLIeegga",
"accountNumber" : "***4567",
"routingNumber" : "*****0358",
"usersId" : "00601ESFEIZCZKTJf6d4",
"status" : "1",
"isSavings" : false,
"isPersonalAcct" : true
}
}Read
Request
<API_URL_EndPoint>/Crud/Read/VendorBankAccount.json
data={
"id" : "vba01RXXGGIGMOZ4dex5"
}Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"entity" : "VendorBankAccount",
"id" : "vba01RXXGGIGMOZ4dex5",
"isActive" : "1",
"createdTime" : "2016-11-21T18:44:10.000+0000",
"updatedTime" : "2016-11-21T18:44:10.000+0000",
"vendorId" : "00901ILFOCYSHLIeegga",
"accountNumber" : "***4567",
"routingNumber" : "*****0358",
"usersId" : "00601ESFEIZCZKTJf6d4",
"status" : "1",
"isSavings" : false,
"isPersonalAcct" : true
}
}Delete
Request
<API_URL_EndPoint>/Crud/Delete/VendorBankAccount.json
data={
"id" : "vba01RXXGGIGMOZ4dex5"
}Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"entity" : "VendorBankAccount",
"id" : "vba01RXXGGIGMOZ4dex5",
"isActive" : "2",
"createdTime" : "2016-11-21T18:44:10.000+0000",
"updatedTime" : "2016-11-21T18:47:31.000+0000",
"vendorId" : "00901ILFOCYSHLIeegga",
"accountNumber" : "***4567",
"routingNumber" : "*****0358",
"usersId" : "00601ESFEIZCZKTJf6d4",
"status" : "5",
"isSavings" : false,
"isPersonalAcct" : true
}
}Resources
Parameters