ChangeEmployeeBankView
Use the ChangeEmployeeBank view to supply the COMPLETE set of bank details for an employee.<br /> Multiple ChangeEmployeeBank records may be supplied for each employee.<br /> It is not possible to add, change or delete individual existing bank records.<br /> If the supplied bank records are valid, all existing bank records are deleted and the new set of bank records.<br /><br /> If adding a new employee use a ChangeType of Add.<br /> If changing an employee use a ChangeType of Change.<br /> A ChangeType of Delete is not allowed on a ChangeEmployeeBankView.<br /> Exactly one record must have BalanceOfPay set to true.<br />
| Name | Description | Type | Additional information |
|---|---|---|---|
| ChangeEmployee  BankId |
integer |
None. |
|
| Change  EmployeeId |
The ChangeEmployeeId for the Bank. Do not supply |
integer |
None. |
| ChangeType |
The ChangeType for the Bank. Not required. Delete is not allowed. If supplied, set to the same value as the ChangeType on the ChanegEmployeeView. |
string |
Matching: ([^'"])* Max length: 20 |
| ChangeStatus |
The ChangeStatus for the Bank. Do not supply. |
string |
Matching: ([^'"])* Max length: 20 |
| EmpCode |
The employee's EmpCode. Must be the same as the containing ChangeEmployee. |
string |
Matching: ([^'"])* Max length: 20 |
| BSBCode |
The BSBCode for the Bank with a dash (-) seperating the first three and last three digits. |
string |
Required Matching: ([^'"])* Max length: 7 |
| AccountNumber |
The Bank account number |
string |
Required Matching: ([^"])* Max length: 50 |
| EFTCode |
The EFTParameters code (i.e. Bank account) that is the source of the funds to pay the employee. This should generally be left blank as it is usually up to Payroll to set the EFT Parameters EFTCode codes may be found at api/Lookups?type=EFTCode |
string |
Matching: ([^'"])* Max length: 10 |
| AccountName |
The Bank account name |
string |
Required Max length: 50 |
| PayAmount |
The Pay Amount, must be zero for Balance of Pay Record, will be ignored where BalanceOfPay is Y |
decimal number |
None. |
| BalanceOfPay |
The BalanceOfPay. |
boolean |
Required |
| Order |
Sets the order that employee pay amounts are split into different bank accounts. Valid values are integers in the range 0 to 999. The employee's default bank account must be allocated the lowest order value,
with each bank thereafter allocated a higher value. For example, if the order for the default bank account is 2 then the order value for each bank account requiring a bank split amount must be greater than 2. |
integer |
Recommended to have |
| BankName |
The Name of the Bank. |
string |
Matching: ([^'"])* Max length: 50 |
| BankBranchName |
The name of the branch. |
string |
Matching: ([^'"])* Max length: 50 |
| BankState |
The State of the Bank. |
string |
Matching: ([^'"])* Max length: 3 |