Savings accounts

Provides the relevant information for a savings account, including account ID, number, and so on.

List savings accounts

get/objects/cash-management/savings-account

Returns up to 100 object references from the collection with a key, ID, and link for each savings account. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "84",
      • "id": "AUDCHK",
      • "href": "/objects/cash-management/savings-account/84"
      },
    • {
      • "key": "85",
      • "id": "BDF",
      • "href": "/objects/cash-management/savings-account/85"
      },
    • {
      • "key": "60",
      • "id": "BOA",
      • "href": "/objects/cash-management/savings-account/60"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Create a savings account
post/objects/cash-management/savings-account
Create a new savings account.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string
Name or other unique identifier for the savings account. The account ID cannot be modified.


 
 Example:  "SBI"
required
object
location


 
key
string
 
 Example:  "4"
id
string
 
 Example:  "4--Australia"
object
Bank account details


 
bankName
required
string
Name of the bank for this savings account.


 
 Example:  "Bank of the West"
currency
required
string
The currency for this account. The default is the base currency for the company or entity. If this account is with a foreign bank, the currency should match the country.


 
 Example:  "USD"
accountNumber
string
Bank account number for this savings account.


 
 Example:  "4356789400"
routingNumber
string
Routing number for this savings account.


 
 Example:  "123456791"
branchId
string
Bank branch ID for this savings account.


 
 Example:  "123456791"
phoneNumber
string
Phone number of the bank branch.


 
 Example:  "555-927-6200"
object
 
city
string
City where the bank is located.


 
 Example:  "Fremont"
state
string
State where the bank is located.


 
 Example:  "CA"
postCode
string
Zip or postal code for the bank.


 
 Example:  "94536"
country
string
Country where the bank is located.


 
 Example:  "United States"
addressLine1
string
Line 1 of the street address for the bank.


 
 Example:  "39148 Paseo Padre Pkwy"
addressLine2
string
Line 2 of the street address for the bank.


 
 Example:  "Suite 104"
addressLine3
string
Line 3 of the street address for the bank which provides additional geographical information.


 
 Example:  "Western industrial area"
object
Accounting information


 
required
object
General Ledger account that this savings account is associated with.


 
key
string
 
 Example:  "90"
id
string
 
 Example:  "1047--Savings a/c France"
object
Default payables GL journal


 
key
string
System-assigned key for the gl-journal.


 
 Example:  "3"
id
string
The id of the journal


 
 Example:  "AP ADJ--AP Adjustment Journal"
object
Default receivables GL journal


 
key
string
System-assigned key for the gl-journal.


 
 Example:  "3"
id
string
The id of the journal


 
 Example:  "AR ADJ--AR Adjustment Journal"
bankingTimeZone
string or null
 Default:  null
Time zone


 Enum: "GMT (Greenwich Mean Time) Dublin, Edinburgh, London" "GMT+00:00 Western Europe Time" "GMT+01:00 Berlin, Stockholm, Rome, Bern, Brussels" "GMT+01:00 British Summer Time" "GMT+01:00 Central Europe Time" "GMT+01:00 Irish Summer Time" "GMT+01:00 Lisbon, Warsaw" "GMT+01:00 Paris, Madrid" "GMT+01:00 Prague" "GMT+01:00 Western Europe Summer Time" "GMT+02:00 Athens, Helsinki, Istanbul" "GMT+02:00 Cairo" "GMT+02:00 Central Europe Summer Time" "GMT+02:00 Eastern Europe Time" "GMT+02:00 Harare, Pretoria" "GMT+02:00 Israel" "GMT+03:00 Baghdad, Kuwait, Nairobi, Riyadh" "GMT+03:00 Eastern Europe Summer Time" "GMT+03:00 Moscow, St. Petersburg, Volgograd" "GMT+03:30 Tehran" "GMT+04:00 Abu Dhabi, Muscat, Tbilisi, Kazan" "GMT+04:00 Moscow Summer Time" "GMT+04:30 Kabul" "GMT+05:00 Islamabad, Karachi, Sverdlovsk, Tashkent" "GMT+05:30 Bombay, Calcutta, Madras, New Delhi" "GMT+06:00 Almaty, Dhaka" "GMT+07:00 Bangkok, Jakarta, Hanoi" "GMT+08:00 (Australian) Western Standard Time" "GMT+08:00 Beijing, Chongqing, Urumqi" "GMT+08:00 Hong Kong SAR, Perth, Singapore, Taipei" "GMT+09:00 Tokyo, Osaka, Sapporo, Seoul, Yakutsk" "GMT+09:30 (Australian) Central Standard Time" "GMT+09:30 Adelaide" "GMT+09:30 Darwin" "GMT+10:00 (Australian) Eastern Standard Time" "GMT+10:00 Brisbane, Melbourne, Sydney" "GMT+10:00 Guam, Port Moresby" "GMT+10:00 Vladivostok" "GMT+10:30 (Australian) Central Daylight Time" "GMT+11:00  (Australian) Eastern Daylight Time" "GMT+12:00 Fiji Islands, Marshall Islands" "GMT+12:00 Kamchatka" "GMT+12:00 Magadan, Solomon Islands, New Caledonia" "GMT+12:00 Wellington, Auckland" "GMT+13:00 Nuku`alofa" "GMT+13:00 Samoa" "GMT-01:00 Azores, Cape Verde Island" "GMT-02:30 Newfoundland Daylight Time" "GMT-03:00 Atlantic Daylight Time" "GMT-03:00 Brasilia" "GMT-03:00 Buenos Aires, Georgetown" "GMT-03:30 Newfoundland Standard Time" "GMT-04:00 Atlantic Standard Time" "GMT-04:00 Caracas, La Paz" "GMT-04:00 Eastern Daylight Saving Time" "GMT-05:00 Bogota, Lima" "GMT-05:00 Central Daylight Saving Time" "GMT-05:00 Eastern Standard Time" "GMT-05:00 Indiana (East)" "GMT-06:00 Central Standard Time" "GMT-06:00 Mexico City, Tegucigalpa" "GMT-06:00 Mountain Daylight Saving Time" "GMT-06:00 Saskatchewan" "GMT-07:00 Arizona" "GMT-07:00 Mountain Standard Time" "GMT-07:00 Pacific Daylight Saving Time" "GMT-08:00 Alaska Standard Daylight Saving Time" "GMT-08:00 Pacific Standard Time" "GMT-09:00 Alaska Standard Time" "GMT-10:00 Hawaii" "GMT-11:00 Midway Island, Samoa" "GMT-12:00 Eniwetok, Kwajalein" null  
 Example:  "GMT+02:00 Eastern Europe Time"
disableInterEntityTransfer
boolean
 Default:  false
Exclude this account from inter-entity transfers (IET) even if IET is globally enabled for the entire multi-entity shared structure of companies.


 
 Example:  false
object
General ledger account for service charges. Used for reconciliation.


 
key
string
 
 Example:  "13"
id
string
 
 Example:  "1004--Lloyds bank"
object
General ledger account label for service charges.


 
key
string
 
 Example:  "8"
id
string
 
 Example:  "Accounting Fees"
href
string
 
 Example:  "/objects/accounts-payable/account-label/8"
object
General ledger account for earned interest. Used for reconciliation.


 
key
string
 
 Example:  "15"
id
string
 
 Example:  "1006--Banorte Bank"
object
General ledger account label for earned interest.


 
key
string
 
 Example:  "35"
id
string
 
 Example:  "Interest Fees"
object
Reconciliation information


 
object
Reconciliation match sequence


 
key
string
System-assigned key for the document sequence number.


 
 Example:  "2"
id
string
Document sequence ID


 
 Example:  "2--Bank sequence Id"
useMatchSequenceForAutoMatch
boolean
 Default:  true
Use sequence number for automatically matched transactions.


 
 Example:  false
useMatchSequenceForManualMatch
boolean
 Default:  true
Use sequence number for manually matched transactions.


 
 Example:  false
object
department


 
key
string
 
 Example:  "8"
id
string
 
 Example:  "8--Finance"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
object
 
object
Applied rule set


 
key
string
 
 Example:  "1"
id
string
 
 Example:  "36--RuleSetToMatch"
object
Restrict a bank account to a specfic location or restrict one or more entity/locations to a specific account.


 
restrictionType
string
 Default:  "unrestricted"
Set which entities/locations within the company can access and use this checking account.


Valid values


    

  • unrestricted - (default) This account is available to the top-level company and all entity-level locations.
    • 

  • rootOnly - Only the top-level company of a multi-entity structure can access this account.
    • 

  • restricted - Only specified locations, location groups, departments, or department groups can access this account.
    • 



 Enum: "restricted" "rootOnly" "unrestricted"  
 Example:  "unrestricted"
locations
Array of strings
List of locations that can access this checking account when restrictionType is set to restricted.


 
 Example:  ["1--United States of America","2--United Kingdom"]
Responses 
201
Created savings account


Request samples 
application/json
{
  • "id": "SAVINGS455_6780",
  • "bankAccountDetails": {
    • "accountNumber": "",
    • "bankName": "Savings Bank of America New",
    • "routingNumber": "565676545",
    • "branchId": "123456791",
    • "phoneNumber": "6509876545",
    • "bankAddress": {
      • "addressLine1": "73466 Linkln St",
      • "addressLine2": null,
      • "addressLine3": null,
      • "city": "Montaine View",
      • "country": "United States",
      • "postCode": "67898",
      • "state": "CA"
      },
    • "currency": "USD"
    },
  • "accounting": {
    • "glAccount": {
      • "id": "2458.90.33--SAVINGS455 GL"
      },
    • "apJournal": {
      • "key": "18"
      },
    • "arJournal": {
      • "id": "ARJ--Accounts Receivable Journal"
      },
    • "bankingTimeZone": "GMT+05:30 Bombay, Calcutta, Madras, New Delhi",
    • "serviceChargeGLAccount": {
      • "key": "417"
      },
    • "interestGLAccount": {
      • "key": "572"
      },
    • "disableInterEntityTransfer": true
    },
  • "reconciliation": {
    • "matchingSequenceNumber": {
      • "key": "48"
      },
    • "useSequenceNumberForAutoMatch": false,
    • "useMatchSequenceForManualMatch": true
    },
  • "department": {
    • "id": "11--Accounting"
    },
  • "location": {
    • "id": "1--United States of America"
    },
  • "status": "active",
  • "ruleSet": {
    • "key": "53"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12345",
    • "id": "ID123",
    • "href": "/objects/<application>/<name>/12345"
    },
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 2,
    • "totalError": 1
    }
}
Get a savings account
get/objects/cash-management/savings-account/{key}
Returns detailed information for a specified savings account.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the savings account.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "SAVINGS455_6780",
    • "bankAccountDetails": {
      • "accountNumber": "789678988",
      • "bankName": "Savings Bank of America New",
      • "routingNumber": "565676545",
      • "branchId": "123456791",
      • "phoneNumber": "6509876545",
      • "bankAddress": {
        },
      • "currency": "USD"
      },
    • "accounting": {
      • "glAccount": {
        },
      • "apJournal": {
        },
      • "arJournal": {
        },
      • "bankingTimeZone": "GMT+05:30 Bombay, Calcutta, Madras, New Delhi",
      • "serviceChargeGLAccount": {
        },
      • "serviceChargeAccountLabel": {
        },
      • "interestGLAccount": {
        },
      • "interestAccountLabel": {
        },
      • "disableInterEntityTransfer": true
      },
    • "reconciliation": {
      • "matchingSequenceNumber": {
        },
      • "useSequenceNumberForAutoMatch": false,
      • "useMatchSequenceForManualMatch": true,
      • "lastReconciledBalance": null,
      • "lastReconciledDate": null,
      • "cutOffDate": null,
      • "inProgressBalance": null,
      • "inProgressDate": null
      },
    • "department": {
      • "key": "9",
      • "id": "11--Accounting",
      • "href": "/objects/company-config/department/9"
      },
    • "location": {
      • "key": "1",
      • "id": "1--United States of America",
      • "href": "/objects/company-config/location/1"
      },
    • "status": "active",
    • "entity": {
      • "key": "46",
      • "id": "Western Region",
      • "name": "Western Region",
      • "href": "/objects/company-config/entity/46"
      },
    • "audit": {
      • "createdDateTime": "2024-03-07T18:35:38Z",
      • "modifiedDateTime": "2024-03-07T18:40:25Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "key": "288",
    • "bankingCloudConnection": {
      • "status": "notConnected",
      • "bankName": null,
      • "name": null,
      • "lastBankTxnDateTime": null,
      • "lastRefreshedDateTime": null,
      • "supportMultiAccountLinking": null
      },
    • "financialInstitution": {
      • "key": null,
      • "id": null
      },
    • "ruleSet": {
      • "id": "53--MatchDateAmountGrpbyDateRuleSet",
      • "key": "53",
      • "href": "/objects/cash-management/bank-txn-rule-set/53"
      },
    • "href": "/objects/cash-management/savings-account/288"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a savings account
patch/objects/cash-management/savings-account/{key}
Updates an existing savings account by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the savings account.


 
 Example:  99
Request Body schema: application/json
required
object
Bank account details


 
accountNumber
string
Bank account number for this savings account.


 
 Example:  "4356789400"
bankName
string
Name of the bank for this savings account.


 
 Example:  "Bank of the West"
routingNumber
string
Routing number for this savings account.


 
 Example:  "123456791"
branchId
string
Bank branch ID for this savings account.


 
 Example:  "123456791"
phoneNumber
string
Phone number of the bank branch.


 
 Example:  "555-927-6200"
currency
string
The currency for this account. The default is the base currency for the company or entity. If this account is with a foreign bank, the currency should match the country.


 
 Example:  "USD"
object
 
city
string
City where the bank is located.


 
 Example:  "Fremont"
state
string
State where the bank is located.


 
 Example:  "CA"
postCode
string
Zip or postal code for the bank.


 
 Example:  "94536"
country
string
Country where the bank is located.


 
 Example:  "United States"
addressLine1
string
Line 1 of the street address for the bank.


 
 Example:  "39148 Paseo Padre Pkwy"
addressLine2
string
Line 2 of the street address for the bank.


 
 Example:  "Suite 104"
addressLine3
string
Line 3 of the street address for the bank which provides additional geographical information.


 
 Example:  "Western industrial area"
object
Accounting information


 
object
General Ledger account that this savings account is associated with.


 
key
string
 
 Example:  "90"
id
string
 
 Example:  "1047--Savings a/c France"
object
Default payables GL journal


 
key
string
System-assigned key for the gl-journal.


 
 Example:  "3"
id
string
The id of the journal


 
 Example:  "AP ADJ--AP Adjustment Journal"
object
Default receivables GL journal


 
key
string
System-assigned key for the gl-journal.


 
 Example:  "3"
id
string
The id of the journal


 
 Example:  "AR ADJ--AR Adjustment Journal"
bankingTimeZone
string or null
 Default:  null
Time zone


 Enum: "GMT (Greenwich Mean Time) Dublin, Edinburgh, London" "GMT+00:00 Western Europe Time" "GMT+01:00 Berlin, Stockholm, Rome, Bern, Brussels" "GMT+01:00 British Summer Time" "GMT+01:00 Central Europe Time" "GMT+01:00 Irish Summer Time" "GMT+01:00 Lisbon, Warsaw" "GMT+01:00 Paris, Madrid" "GMT+01:00 Prague" "GMT+01:00 Western Europe Summer Time" "GMT+02:00 Athens, Helsinki, Istanbul" "GMT+02:00 Cairo" "GMT+02:00 Central Europe Summer Time" "GMT+02:00 Eastern Europe Time" "GMT+02:00 Harare, Pretoria" "GMT+02:00 Israel" "GMT+03:00 Baghdad, Kuwait, Nairobi, Riyadh" "GMT+03:00 Eastern Europe Summer Time" "GMT+03:00 Moscow, St. Petersburg, Volgograd" "GMT+03:30 Tehran" "GMT+04:00 Abu Dhabi, Muscat, Tbilisi, Kazan" "GMT+04:00 Moscow Summer Time" "GMT+04:30 Kabul" "GMT+05:00 Islamabad, Karachi, Sverdlovsk, Tashkent" "GMT+05:30 Bombay, Calcutta, Madras, New Delhi" "GMT+06:00 Almaty, Dhaka" "GMT+07:00 Bangkok, Jakarta, Hanoi" "GMT+08:00 (Australian) Western Standard Time" "GMT+08:00 Beijing, Chongqing, Urumqi" "GMT+08:00 Hong Kong SAR, Perth, Singapore, Taipei" "GMT+09:00 Tokyo, Osaka, Sapporo, Seoul, Yakutsk" "GMT+09:30 (Australian) Central Standard Time" "GMT+09:30 Adelaide" "GMT+09:30 Darwin" "GMT+10:00 (Australian) Eastern Standard Time" "GMT+10:00 Brisbane, Melbourne, Sydney" "GMT+10:00 Guam, Port Moresby" "GMT+10:00 Vladivostok" "GMT+10:30 (Australian) Central Daylight Time" "GMT+11:00  (Australian) Eastern Daylight Time" "GMT+12:00 Fiji Islands, Marshall Islands" "GMT+12:00 Kamchatka" "GMT+12:00 Magadan, Solomon Islands, New Caledonia" "GMT+12:00 Wellington, Auckland" "GMT+13:00 Nuku`alofa" "GMT+13:00 Samoa" "GMT-01:00 Azores, Cape Verde Island" "GMT-02:30 Newfoundland Daylight Time" "GMT-03:00 Atlantic Daylight Time" "GMT-03:00 Brasilia" "GMT-03:00 Buenos Aires, Georgetown" "GMT-03:30 Newfoundland Standard Time" "GMT-04:00 Atlantic Standard Time" "GMT-04:00 Caracas, La Paz" "GMT-04:00 Eastern Daylight Saving Time" "GMT-05:00 Bogota, Lima" "GMT-05:00 Central Daylight Saving Time" "GMT-05:00 Eastern Standard Time" "GMT-05:00 Indiana (East)" "GMT-06:00 Central Standard Time" "GMT-06:00 Mexico City, Tegucigalpa" "GMT-06:00 Mountain Daylight Saving Time" "GMT-06:00 Saskatchewan" "GMT-07:00 Arizona" "GMT-07:00 Mountain Standard Time" "GMT-07:00 Pacific Daylight Saving Time" "GMT-08:00 Alaska Standard Daylight Saving Time" "GMT-08:00 Pacific Standard Time" "GMT-09:00 Alaska Standard Time" "GMT-10:00 Hawaii" "GMT-11:00 Midway Island, Samoa" "GMT-12:00 Eniwetok, Kwajalein" null  
 Example:  "GMT+02:00 Eastern Europe Time"
disableInterEntityTransfer
boolean
 Default:  false
Exclude this account from inter-entity transfers (IET) even if IET is globally enabled for the entire multi-entity shared structure of companies.


 
 Example:  false
object
General ledger account for service charges. Used for reconciliation.


 
key
string
 
 Example:  "13"
id
string
 
 Example:  "1004--Lloyds bank"
object
General ledger account label for service charges.


 
key
string
 
 Example:  "8"
id
string
 
 Example:  "Accounting Fees"
href
string
 
 Example:  "/objects/accounts-payable/account-label/8"
object
General ledger account for earned interest. Used for reconciliation.


 
key
string
 
 Example:  "15"
id
string
 
 Example:  "1006--Banorte Bank"
object
General ledger account label for earned interest.


 
key
string
 
 Example:  "35"
id
string
 
 Example:  "Interest Fees"
object
Reconciliation information


 
object
Reconciliation match sequence


 
key
string
System-assigned key for the document sequence number.


 
 Example:  "2"
id
string
Document sequence ID


 
 Example:  "2--Bank sequence Id"
useMatchSequenceForAutoMatch
boolean
 Default:  true
Use sequence number for automatically matched transactions.


 
 Example:  false
useMatchSequenceForManualMatch
boolean
 Default:  true
Use sequence number for manually matched transactions.


 
 Example:  false
object
department


 
key
string
 
 Example:  "8"
id
string
 
 Example:  "8--Finance"
object
location


 
key
string
 
 Example:  "4"
id
string
 
 Example:  "4--Australia"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
object
 
object
Applied rule set


 
key
string
 
 Example:  "1"
id
string
 
 Example:  "36--RuleSetToMatch"
object
Restrict a bank account to a specfic location or restrict one or more entity/locations to a specific account.


 
restrictionType
string
 Default:  "unrestricted"
Set which entities/locations within the company can access and use this checking account.


Valid values


    

  • unrestricted - (default) This account is available to the top-level company and all entity-level locations.
    • 

  • rootOnly - Only the top-level company of a multi-entity structure can access this account.
    • 

  • restricted - Only specified locations, location groups, departments, or department groups can access this account.
    • 



 Enum: "restricted" "rootOnly" "unrestricted"  
 Example:  "unrestricted"
locations
Array of strings
List of locations that can access this checking account when restrictionType is set to restricted.


 
 Example:  ["1--United States of America","2--United Kingdom"]
Responses 
201
Updated savings-account


Request samples 
application/json
{
  • "bankAccountDetails": {
    • "bankName": "Bank of America New"
    },
  • "ruleSet": {
    • "key": "53",
    • "id": "MatchDateAmountGrpbyDateRuleSet"
    },
  • "restrictions": {
    • "restrictionType": "unrestricted",
    • "locations": [ ]
    },
  • "reconciliation": {
    • "matchingSequenceNumber": {
      • "key": "48"
      },
    • "useSequenceNumberForAutoMatch": true,
    • "useMatchSequenceForManualMatch": true
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12345",
    • "id": "ID123",
    • "href": "/objects/<application>/<name>/12345"
    },
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 2,
    • "totalError": 1
    }
}
Delete a savings account
delete/objects/cash-management/savings-account/{key}
Deletes a savings account. You can only delete accounts that are not tied to any transactions or payments.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the savings account.


 
 Example:  99
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
    }
}