Add a new batch for transactions

POST /batch
OAuth2
application/json

Body Required

New bank batch parameters

  • batch_code string

    Use this to store the short version of a batch, generally around 20 chars max

    Maximum length is 255.

  • description string

    Longer description of the batch

    Maximum length is 255.

  • bank_account_id integer

    Optional but recommended. If supplied, must link to the BankAccount this batch is imported from.

  • for_group_id integer

    If the user is a clustered login, then this must be supplied. Otherwise its optional but must link to a group the login has access to.

  • bank_account_code string

    Optional parts of a bank account code. Use as required by your bank account coding configurations. Free text

    Maximum length is 100.

  • currency_code string

    Which 3 character code for this currency

    Maximum length is 20.

  • account_type string

    Optional. Describes the type of bank account

    Maximum length is 50.

  • name string

    Name of the bank account

    Maximum length is 255.

  • xero_account_id string

    If this is a xero account code, its the ID in xero. Read only

    Maximum length is 100.

  • xero_status string

    shows if the code is still available in xero. Blank if its not a xero account code. Read only

    Maximum length is 50. Values are OK or No longer in Xero.

Responses

  • 200 application/json

    Item has been saved successfully

    Hide response attribute Show response attribute object
  • 401 application/json

    Authentication unauthorised

    Hide response attribute Show response attribute object
  • 403 application/json

    Invalid permission

    Hide response attribute Show response attribute object
POST /batch 
curl \
 -X POST https://YOURSITE.infoodle.com/apiv2/batch \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"batch_code":"Imported-2025-05-01","description":"Transactions imported during 1st May 2025 for event cash donations","bank_account_id":24,"for_group_id":543,"bank_account_code":"12-309123-1390291123-10232","currency_code":"NZD","account_type":"checking","name":"ASB Donations Account","xero_account_id":"62f28bd8-3d47-4302-88a3-dc6ff53d8126","xero_status":"OK"}'
Request examples 
{
  "batch_code": "Imported-2025-05-01",
  "description": "Transactions imported during 1st May 2025 for event cash donations",
  "bank_account_id": 24,
  "for_group_id": 543,
  "bank_account_code": "12-309123-1390291123-10232",
  "currency_code": "NZD",
  "account_type": "checking",
  "name": "ASB Donations Account",
  "xero_account_id": "62f28bd8-3d47-4302-88a3-dc6ff53d8126",
  "xero_status": "OK"
}
Response examples (200) 
{
  "id": 4325342
}
Response examples (401) 
{
  "error": "Unauthorised"
}
Response examples (403) 
{
  "error": "Invalid Permission"
}