Employee bank file setups

A bank file enables electronic payments to be made to employees using a local bank file format. Bank files are standard files used by banks to make multiple payments.

List employee bank file setups

get/objects/company-config/employee-bank-file-setup

Returns a collection with a key, ID, and link for each employee bank file setup.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "25",
      • "id": "25",
      • "href": "/objects/company-config/employee-bank-file-setup/25"
      },
    • {
      • "key": "85",
      • "id": "85",
      • "href": "/objects/company-config/employee-bank-file-setup/85"
      },
    • {
      • "key": "60",
      • "id": "60",
      • "href": "/objects/company-config/employee-bank-file-setup/60"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Get an employee bank file setup
get/objects/company-config/employee-bank-file-setup/{key}
Returns detailed information for a specified employee bank file setup.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the employee bank file setup.


 
 Example:  120
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "25",
    • "id": "25",
    • "employee": {
      • "key": "202",
      • "id": "SAEmployee",
      • "href": "/objects/company-config/employee/202"
      },
    • "paymentReference": "Supplier Inc",
    • "branchCode": "123433",
    • "bankAccountType": "1",
    • "bankAccountCode": "345678",
    • "proofOfPayment": true,
    • "bankAccountNumber": "87402896",
    • "bankAccountName": "Jane Blogs Corp",
    • "href": "/objects/company-config/employee-bank-file-setup/25"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Query employee bank file setups
post/services/core/query
Use the query service to find employee bank file setups that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}