Creates a new bank account for the employee.

Request

POST https://keypay.yourpayroll.com.au/api/v2/ess/{employeeId}/bankaccounts

Path parameters

Parameter name Value Description Additional
employeeId string Required

Request body

The request body takes a complete BankAccountModel resource, containing the following writable properties:

{
    "accountName": "string",
    "accountNumber": "string",
    "accountType": "string",
    "allocateBalance": "boolean",
    "allocatedPercentage": "double",
    "bsb": "string",
    "canBeDeleted": "boolean",
    "employeeId": "int32",
    "externalReferenceId": "string",
    "fixedAmount": "double",
    "id": "int32",
    "isEmployeeEditable": "boolean"
}

Properties

Name Type Description
accountName string String
accountNumber string String
accountType string BankAccountTypeEnum

Possible values are:

  • Electronic
  • ManualDeposit
  • CashOrCheque
  • Bpay
allocateBalance boolean Boolean
allocatedPercentage double Nullable
bsb string String
canBeDeleted boolean Boolean
employeeId int32 Int32
externalReferenceId string String
fixedAmount double Nullable
id int32 Int32
isEmployeeEditable boolean Boolean

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

SaveBankAccountResponseModel