Funds transfer transactions

Transaction record for transfer of funds between 2 accounts.

List Funds transfer transactions

get/objects/cash-management/funds-transfer

Returns a collection with a key, ID, and link for each Funds transfer transaction. 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": "30",
      • "id": "30",
      • "href": "/objects/cash-management/funds-transfer/30"
      },
    • {
      • "key": "31",
      • "id": "31",
      • "href": "/objects/cash-management/funds-transfer/31"
      },
    • {
      • "key": "32",
      • "id": "32",
      • "href": "/objects/cash-management/funds-transfer/32"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a Funds transfer transaction
post/objects/cash-management/funds-transfer
Creates a new Funds transfer transaction.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
sendDate
required
string <date> 
Date of the transaction.


 
 Example:  "2021-11-30"
referenceNumber
string
Reference number for the transaction.


 
 Example:  "Ref--BOA to CHSE transfer"
description
string
Brief description of the purpose of the transaction.


 
 Example:  "BOA to chase bank transfer in November"
object
Supporting document attached to this transaction.


 
key
string
System-assigned key for the supporting document.


 
 Example:  "1"
id
string
System-assigned ID for the supporting document.


 
 Example:  "1"
object
Financial account from which transfer is made.


 
transferAmount
required
string <decimal-precision-2> 
For multi-currency companies, provide a transaction amount, which is the total amount entered in the transaction currency.


 
 Example:  "2500.10"
object
 
id
required
string
Account number or other unique identifier for the financial account.


 
 Example:  "CHASE"
object
Financial account to which transfer is made.


 
receivedAmount
required
string <decimal-precision-2> 
For multi-currency companies, provide a transaction amount, which is the total amount entered in the transaction currency.


 
 Example:  "2500.10"
object
 
id
required
string
Account number or other unique identifier for the financial account.


 
 Example:  "BOA"
object
Exchange rate details for base currency conversion


 
object
Currency conversion details for transfer from account.


 
companyBaseCurrency
string
Base currency


 
 Example:  "USD"
exchangeRateDate
string <date> 
Exchange rate date


 
 Example:  "2014-01-08"
exchangeRateTypeId
string
Exchange rate type


 
 Example:  "Intacct Daily Rate"
exchangeRate
number
Exchange rate


 
 Example:  0.78
object
Currency conversion details for transfer to account.


 
companyBaseCurrency
string
Base currency


 
 Example:  "USD"
exchangeRateDate
string <date> 
Exchange rate date


 
 Example:  "2014-01-08"
exchangeRateTypeId
string
Exchange rate type


 
 Example:  "Intacct Daily Rate"
exchangeRate
number
Exchange rate


 
 Example:  0.78
Array of objects
Line items for the funds transfer transaction.


 
 Array 
object
 
object
 
object
 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "sendDate": "2024-02-14",
  • "transferFromAccount": {
    • "bankAccount": {
      • "id": "CHSE"
      },
    • "transferAmount": "1000.50"
    },
  • "transferToAccount": {
    • "bankAccount": {
      • "id": "BOA"
      },
    • "receivedAmount": "1000.50"
    },
  • "description": "Transfer to boa from Chase",
  • "referenceNumber": "Transfer 001 "
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "39",
    • "key": "39",
    • "href": "/objects/cash-management/funds-transfer/39"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a Funds transfer transaction
get/objects/cash-management/funds-transfer/{key}
Returns detailed information for a specified Funds transfer transaction.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the Funds transfer transaction.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "40",
    • "key": "40",
    • "sendDate": "2024-02-14",
    • "transferFromAccount": {
      • "bankAccount": {
        },
      • "transferAmount": "3457.00"
      },
    • "transferToAccount": {
      • "bankAccount": {
        },
      • "receivedAmount": "3457.00"
      },
    • "referenceNumber": "Transfer 002",
    • "description": "Transfer to BOM",
    • "baseCurrencyConversion": {
      • "transferFromCurrency": {
        },
      • "transferToCurrency": {
        }
      },
    • "reversedBy": {
      • "id": null,
      • "key": null,
      • "reversalDate": null
      },
    • "reversalOf": {
      • "id": null,
      • "key": null,
      • "txnDate": null
      },
    • "state": "posted",
    • "reconciliationState": "uncleared",
    • "audit": {
      • "createdDateTime": "2024-02-15T03:03:31Z",
      • "modifiedDateTime": "2024-02-15T03:03:32Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "attachment": {
      • "id": null,
      • "key": null
      },
    • "entity": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "lines": [
      • {
        }
      ],
    • "href": "/objects/cash-management/funds-transfer/40"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query funds transfers
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "cash-management/funds-transfer"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 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 has (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 {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 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 asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
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 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the result set, 4000 maximum.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "cash-management/funds-transfer",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "sendDate",
    • "referenceNumber",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "239",
      • "id": "239",
      • "sendDate": "2025-02-11",
      • "referenceNumber": "TRANSFER-239 BOA to CHSE",
      • "href": "/objects/cash-management/funds-transfer/239"
      },
    • {
      • "key": "280",
      • "id": "280",
      • "sendDate": "2025-03-15",
      • "referenceNumber": "TRANSFER-280 BOA to HSBC",
      • "href": "/objects/cash-management/funds-transfer/280"
      },
    • {
      • "key": "337",
      • "id": "337",
      • "sendDate": "2025-04-01",
      • "referenceNumber": "TRANSFER-337 HSBC to CHSE",
      • "href": "/objects/cash-management/funds-transfer/337"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}