Vendor bank file setups

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

List vendor bank file setup objects

get/objects/accounts-payable/vendor-bank-file-setup

Returns a collection with a key, ID, and link for each vendor bank file setup object. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

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


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "25",
    • "id": "25",
    • "vendor": {
      • "key": "202",
      • "id": "SAVendor",
      • "href": "/objects/accounts-payable/vendor/202"
      },
    • "bsbNumber": null,
    • "paymentReference": "Supplier Inc",
    • "sortCode": null,
    • "branchCode": "123433",
    • "bankAccountType": "1",
    • "bankAccountCode": "345678",
    • "proofOfPayment": true,
    • "bankAccountNumber": "87402896",
    • "bankAccountName": "Jane Blogs Corp",
    • "businessIdCode": null,
    • "href": "/objects/accounts-payable/vendor-bank-file-setup/25"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Query vendor bank file setup objects
post/services/core/query
Use the query service to find vendor bank file setup objects 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
    }
}