A financial institution serves as an umbrella object for bank accounts that use the same sign-in process to connect to bank feeds.
Returns up to 100 object references from the collection with a key, ID, and link for each financial institution. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Subscription | Cash Management, Sage Cloud Services |
---|---|
User type | Business user with admin permissions |
Permissions | List, View Financial Institutions |
OK
Bad Request
{- "ia::result": [
- {
- "key": "1",
- "id": "FinInst1",
- "href": "/objects/cash-management/financial-institution/1"
}, - {
- "key": "2",
- "id": "FinInst2",
- "href": "/objects/cash-management/financial-institution/2"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100
}
}
Creates a new financial institution.
Subscription | Cash Management, Sage Cloud Services |
---|---|
User type | Business user with admin permissions |
Permissions | Add Financial Institution |
id required | string Unique identifier for the financial institution. Example: "USA_FinInst" | ||||||
name | string Name of the financial institution. Example: "USA financial institution" | ||||||
Array of objects Services associated with the financial institution. | |||||||
Array
| |||||||
Array of objects Checking accounts associated with the financial institution. | |||||||
Array
| |||||||
Array of objects Savings accounts associated with the financial institution. | |||||||
Array
|
Created
Bad Request
{- "id": "FinInst-BOA",
- "name": "FinOn4ss5e",
- "addOnServices": [
- {
- "name": "MAL",
- "serviceContract": {
- "key": "129",
- "accountType": "checking"
}
}
], - "checkingAccounts": [
- {
- "key": "72",
- "externalBankAccount": {
- "id": "a421d6c8-ed48-454d-a60e-7b697c67b956",
- "name": "Plaid Saving"
}, - "requestedStartDate": "2021-01-23"
}, - {
- "key": "69",
- "externalBankAccount": {
- "id": "412f0837-c236-4917-9796-84ec52cd3edb",
- "name": "Plaid CD"
}, - "requestedStartDate": "2021-01-23"
}
], - "savingsAccounts": [
- {
- "key": "33",
- "externalBankAccount": {
- "id": "d6c05270-66f0-4d1b-8c1e-d35b4914e991",
- "name": "Plaid IRA"
}, - "requestedStartDate": "2021-01-23"
}, - {
- "key": "30",
- "externalBankAccount": {
- "id": "11dd5715-2585-43e5-8a6c-501923ca72ec",
- "name": "Plaid 401k"
}, - "requestedStartDate": "2021-01-23"
}
], - "creditCards": [
- {
- "key": "60",
- "externalBankAccount": {
- "id": "be157d12-d181-4409-958f-1d8fb95b504f",
- "name": "Plaid Credit Card"
}, - "requestedStartDate": "2021-01-23"
}, - {
- "key": "7",
- "externalBankAccount": {
- "id": "41650f07-0f3f-432d-9d57-e56a6286bdf0",
- "name": "Plaid Money Market"
}, - "requestedStartDate": "2021-01-23"
}
]
}
{- "ia::result": {
- "key": "103",
- "href": "/objects/cash-management/financial-institution/103"
}, - "ia::meta": {
- "totalCount": 1
}
}
Returns detailed information for a specified financial institution.
Subscription | Cash Management, Sage Cloud Services |
---|---|
User type | Business user with admin permissions |
Permissions | List, View Financial Institutions |
key required | string System-assigned key for the financial institution. |
OK
Bad Request
{- "ia::result": {
- "key": "1",
- "id": "FinInst1",
- "name": "FinOn4ddss5e",
- "totalAccounts": 7,
- "checkingAccounts": [
- {
- "key": "129",
- "href": "/objects/cash-management/checking-account/129"
}, - {
- "key": "72",
- "href": "/objects/cash-management/checking-account/72"
}, - {
- "key": "69",
- "href": "/objects/cash-management/checking-account/69"
}
], - "savingsAccounts": [
- {
- "key": "33",
- "href": "/objects/cash-management/savings-account/33"
}, - {
- "key": "30",
- "href": "/objects/cash-management/savings-account/30"
}
], - "creditCards": [
- {
- "key": "7",
- "href": "/objects/cash-management/credit-card-account/7"
}, - {
- "key": "60",
- "href": "/objects/cash-management/credit-card-account/60"
}
], - "addOnServices": [
- {
- "name": "MAL",
- "serviceContract": {
- "primaryAccountKey": "129",
- "primaryAccountType": "checking"
}
}
], - "href": "/objects/cash-management/financial-institution/96"
}, - "ia::meta": {
- "totalCount": 1
}
}
Updates an existing financial institution by setting field values. Any fields not provided remain unchanged.
Subscription | Cash Management, Sage Cloud Services |
---|---|
User type | Business user with admin permissions |
Permissions | Map accounts, List, View, Add, Edit Financial Institution |
key required | string System-assigned key for the financial institution. |
id required | string Unique identifier for the financial institution. Example: "USA_FinInst" | ||||||
name | string Name of the financial institution. Example: "USA financial institution" | ||||||
Array of objects Services associated with the financial institution. | |||||||
Array
| |||||||
Array of objects Checking accounts associated with the financial institution. | |||||||
Array
| |||||||
Array of objects Savings accounts associated with the financial institution. | |||||||
Array
|
OK
Bad Request
{- "id": "FinInst-BOA",
- "checkingAccounts": [
- {
- "key": "99",
- "externalBankAccount": {
- "id": "a532e7d9-ed59-565d-a71e-8b718c7c167",
- "name": "Corp Saving"
}, - "requestedStartDate": "2021-01-23"
}
]
}
{- "ia::result": {
- "key": "96",
- "href": "/objects/cash-management/financial-institution/96"
}, - "ia::meta": {
- "totalCount": 1
}
}
Deletes a financial institution.
key required | string System-assigned key for the financial institution. |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "A POST request requires a payload",
- "errorId": "REST-1028",
- "additionalInfo": {
- "messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
- "placeholders": {
- "OPERATION": "POST"
}, - "propertySet": { }
}, - "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 0,
- "totalError": 1
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "cash-management/financial-institution" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
Example: ["key","id","max:vendor.creditLimit"] | ||||||||
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object) Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}] | |||||||||
Array Any of: Field value must be equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
Array of objects Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order. Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}] | |||||||||
Array
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the response. Example: 100 |
OK
Bad Request
{- "object": "accounts-payable/vendor",
- "fields": [
- "id",
- "name",
- "status",
- "href"
], - "filters": [
- {
- "$eq": {
- "status": "active"
}
}, - {
- "$eq": {
- "billingType": "openItem"
}
}
], - "filterExpression": "1 and 2",
- "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "id": "Vend-00002",
- "name": "Test vendor",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/85"
}, - {
- "id": "VEND-00010",
- "name": "Design Works",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/111"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}