GET BankAccounts/Employee?employeeId={employeeId}&includeArchived={includeArchived}

Gets the BankAccount matching the specified employee id.


Parameters

NameDescriptionAdditional information
employeeId 
The Id of the Employee whos bank accounts are required.

Define this parameter in the request URI.
includeArchived 
Return Employees archived accounts(true or false).

Define this parameter in the request URI.

Response body formats

A BankAccountResponse containing the matching BankAccount.

application/json, text/json

Sample: 
{
  "List": [
    {
      "BankAccountId": 1,
      "EmployeeId": 2,
      "AccountName": "sample string 3",
      "AccountNumber": "sample string 4",
      "AccountType": 5,
      "SortCode": "sample string 6",
      "Reference": "sample string 7",
      "CurrencyId": 8,
      "CurrencyName": "sample string 9",
      "CountryId": 10,
      "Archived": true,
      "Outcome": "sample string 12",
      "Iban": "sample string 13",
      "SwiftCode": "sample string 14"
    },
    {
      "BankAccountId": 1,
      "EmployeeId": 2,
      "AccountName": "sample string 3",
      "AccountNumber": "sample string 4",
      "AccountType": 5,
      "SortCode": "sample string 6",
      "Reference": "sample string 7",
      "CurrencyId": 8,
      "CurrencyName": "sample string 9",
      "CountryId": 10,
      "Archived": true,
      "Outcome": "sample string 12",
      "Iban": "sample string 13",
      "SwiftCode": "sample string 14"
    },
    {
      "BankAccountId": 1,
      "EmployeeId": 2,
      "AccountName": "sample string 3",
      "AccountNumber": "sample string 4",
      "AccountType": 5,
      "SortCode": "sample string 6",
      "Reference": "sample string 7",
      "CurrencyId": 8,
      "CurrencyName": "sample string 9",
      "CountryId": 10,
      "Archived": true,
      "Outcome": "sample string 12",
      "Iban": "sample string 13",
      "SwiftCode": "sample string 14"
    }
  ],
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<BankAccountsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <List xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:BankAccount>
      <d2p1:AccountName>sample string 3</d2p1:AccountName>
      <d2p1:AccountNumber>sample string 4</d2p1:AccountNumber>
      <d2p1:AccountType>5</d2p1:AccountType>
      <d2p1:Archived>true</d2p1:Archived>
      <d2p1:BankAccountId>1</d2p1:BankAccountId>
      <d2p1:CountryId>10</d2p1:CountryId>
      <d2p1:CurrencyId>8</d2p1:CurrencyId>
      <d2p1:CurrencyName>sample string 9</d2p1:CurrencyName>
      <d2p1:EmployeeId>2</d2p1:EmployeeId>
      <d2p1:Iban>sample string 13</d2p1:Iban>
      <d2p1:Outcome>sample string 12</d2p1:Outcome>
      <d2p1:Reference>sample string 7</d2p1:Reference>
      <d2p1:SortCode>sample string 6</d2p1:SortCode>
      <d2p1:SwiftCode>sample string 14</d2p1:SwiftCode>
    </d2p1:BankAccount>
    <d2p1:BankAccount>
      <d2p1:AccountName>sample string 3</d2p1:AccountName>
      <d2p1:AccountNumber>sample string 4</d2p1:AccountNumber>
      <d2p1:AccountType>5</d2p1:AccountType>
      <d2p1:Archived>true</d2p1:Archived>
      <d2p1:BankAccountId>1</d2p1:BankAccountId>
      <d2p1:CountryId>10</d2p1:CountryId>
      <d2p1:CurrencyId>8</d2p1:CurrencyId>
      <d2p1:CurrencyName>sample string 9</d2p1:CurrencyName>
      <d2p1:EmployeeId>2</d2p1:EmployeeId>
      <d2p1:Iban>sample string 13</d2p1:Iban>
      <d2p1:Outcome>sample string 12</d2p1:Outcome>
      <d2p1:Reference>sample string 7</d2p1:Reference>
      <d2p1:SortCode>sample string 6</d2p1:SortCode>
      <d2p1:SwiftCode>sample string 14</d2p1:SwiftCode>
    </d2p1:BankAccount>
    <d2p1:BankAccount>
      <d2p1:AccountName>sample string 3</d2p1:AccountName>
      <d2p1:AccountNumber>sample string 4</d2p1:AccountNumber>
      <d2p1:AccountType>5</d2p1:AccountType>
      <d2p1:Archived>true</d2p1:Archived>
      <d2p1:BankAccountId>1</d2p1:BankAccountId>
      <d2p1:CountryId>10</d2p1:CountryId>
      <d2p1:CurrencyId>8</d2p1:CurrencyId>
      <d2p1:CurrencyName>sample string 9</d2p1:CurrencyName>
      <d2p1:EmployeeId>2</d2p1:EmployeeId>
      <d2p1:Iban>sample string 13</d2p1:Iban>
      <d2p1:Outcome>sample string 12</d2p1:Outcome>
      <d2p1:Reference>sample string 7</d2p1:Reference>
      <d2p1:SortCode>sample string 6</d2p1:SortCode>
      <d2p1:SwiftCode>sample string 14</d2p1:SwiftCode>
    </d2p1:BankAccount>
  </List>
</BankAccountsResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body