POST 17.0/app/bankaccounts/lookup

Description

Gets the Bank Account Id based on the passed request details

URI Parameters

None.

BankAccountLookupRequest
Name Description Type Additional information
PropertyId

integer

None.
CompanyId

integer

None.
SyncBankAccount

boolean

None.
BypassCompanyCheck

boolean

None.
ContactId

integer

None.
IgnoreBlockCompany

boolean

None.
CurrentBankAccountId

integer

None.

application/json, text/json
Sample: 
{
  "propertyId": 1,
  "companyId": 2,
  "syncBankAccount": true,
  "bypassCompanyCheck": true,
  "contactId": 5,
  "ignoreBlockCompany": true,
  "currentBankAccountId": 7
}

application/xml, text/xml
Sample: 
<BankAccountLookupRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PropertyId>1</PropertyId>
  <CompanyId>2</CompanyId>
  <SyncBankAccount>true</SyncBankAccount>
  <BypassCompanyCheck>true</BypassCompanyCheck>
  <ContactId>5</ContactId>
  <IgnoreBlockCompany>true</IgnoreBlockCompany>
  <CurrentBankAccountId>7</CurrentBankAccountId>
</BankAccountLookupRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

BankAccountLookupResponse
Name Description Type Additional information
BankAccountId

integer

None.
CompanyId

integer

None.

application/json, text/json
Sample: 
{
  "bankAccountId": 1,
  "companyId": 2
}

application/xml, text/xml
Sample: 
<BankAccountLookupResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BankAccountId>1</BankAccountId>
  <CompanyId>2</CompanyId>
</BankAccountLookupResponse>