Bank files

Bank files enable Sage Intacct to support electronic payments using a local bank file format. The bank file is uploaded to the company's banking portal to provide the bank with the required payment data. The bank can then process payments using the bank file.

For more information, read about bank files in the Sage Intacct Help Center.

List bank files

get/objects/cash-management/bank-file

Returns a collection with a key, ID, and link for each bank file. This operation is mostly for use in testing; use the query service 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": "29",
      • "id": "29",
      • "href": "/objects/cash-management/bank-file/29"
      },
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/cash-management/bank-file/1"
      },
    • {
      • "key": "28",
      • "id": "28",
      • "href": "/objects/cash-management/bank-file/28"
      },
    • {
      • "key": "5",
      • "id": "5",
      • "href": "/objects/cash-management/bank-file/5"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": 0,
    • "previous": 0
    }
}
Get a bank file
get/objects/cash-management/bank-file/{key}
Returns detailed information for a specified bank file.


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


 
 Example:  134
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "13",
    • "key": "13",
    • "bankAccount": {
      • "id": "88",
      • "key": "88",
      • "name": "HSBC UK",
      • "href": "/objects/cash-management/checking-account/88"
      },
    • "fileName": "UKAccount-Dec-08-2022 08:50:07686",
    • "fileExtension": "csv",
    • "totalPayments": 1,
    • "totalAmount": "1200",
    • "currency": "GBP",
    • "audit": {
      • "createdDateTime": "2025-03-27T16:24:18Z",
      • "modifiedDateTime": "2025-03-27T16:24:18Z",
      • "createdByUser": {
        },
      • "createdBy": "159",
      • "modifiedByUser": {
        },
      • "modifiedBy": "159"
      },
    • "state": "failed",
    • "bankFileDetails": [
      • {
        }
      ],
    • "href": "/objects/cash-management/bank-file/13"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a Bank file
delete/objects/cash-management/bank-file/{key}
Deletes a Bank file.


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


 
 Example:  134
Responses 
204
No Content


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
    }
}