NameDescriptionTypeAdditional information
idEmployeeBank

integer

None.

EmpCode

The employee's EmpCode.

string

Matching: ([^'"])*

Max length: 20

BSBCode

The BSBCode for the Bank with a dash (-) seperating the first three and last three digits.

The actual BSB will be extracted from the BSBCode by removing the dash (-). If the BSBCode does not exist and is being used for the first time the BankName, BankBranchName and BankState fields must be supplied.

string

Matching: ([^'"])*

Max length: 7

AccountNumber

The Account Number.

string

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 AccountName.

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.
Set when this account is to receive all of the remaining pay.
Only one account may be set to BalanceOfPay.

boolean

Required

Order

The Order for the Bank. For a Bank Split to work correctly, the default bank account must be set as the lowest order value, with each bank account thereafter being allocated a higher value. For example, if the default bank account order value is set to 2 then the bank order value for each bank account requiring a bank split amount, must be greater than 2.

integer

None.

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