Fund Transfer

Fund Transfers is used to move money, assets or funds between the balance sheet accounts. It allows you to transfer funds between similar but different accounts, e.g., from a checking account to a petty cash account or from a savings account to your checking account. Fund Transfers object allows you to perform the following operations:

Retrieve a specific fund transfer or a list of fund transfers
Create a fund transfer
Update a fund transfer
Delete a fund transfer

cURL
NODE.JS
PHP
C#
PYTHON
JAVA

Name	Description	Format	Attributes
amount	Represents the fund transfer amount	double	Filterable, Sortable
date	Represents the date of the fund transfer	date-time	Filterable, Sortable
destinationId	Identifier of the account to which funds are transferred	uuid	Filterable, Sortable
sourceId	Identifier of the account from which funds are transferred	uuid	Filterable, Sortable
accountingDate	Date that determines the accounting period to which the transaction belongs in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
createdById	Identifier of the user who created this object	uuid	Filterable
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time	Filterable, Sortable
customFields []Array: Parent object can have multiple instances of this nested object under it.	List of custom fields	CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
destinationAccount	Name of the account to which funds are transferred	string	Filterable, Sortable
id	Object identifier	uuid	Filterable
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time	Filterable, Sortable
lastUpdatedById	Identifier of the user who last updated this object	uuid	Filterable
memo	Records any extra information against a fund transfer for recapitulation	string
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectState Enumerated type: Click to see possible values and their descriptions.
sourceAccount	Name of the account from which funds are transferred	string	Filterable, Sortable
token	Represents the token for update operations	int32
version	Implements concurrency on this object	byte

Fund Transfer List

Use this method to retrieve a list of fund transfers. You can optionally pass where, orderBy, and page as query parameters to filter the result. Use the fields parameter to request a subset of the model. By default, a complete model is returned. The expand parameter is used to request nested properties in the model.

Request URL

base_url/fundtransfer

/fundtransfer

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Fund Transfer

Required Scopes:

read:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
fields	Query	Specifies the model properties you want in the response body	string
where	Query	Specifies only those records that match an expression in the query	string
orderBy	Query	Specifies the order of the records	string
page	Query	Specifies the page number and number of records on each page	string
expand	Query	Specifies the nested model properties you want in the response body	string

Response Body

Name	Description	Format
amount	Represents the fund transfer amount	double
date	Represents the date of the fund transfer	date-time
destinationId	Identifier of the account to which funds are transferred	uuid
sourceId	Identifier of the account from which funds are transferred	uuid
accountingDate	Date that determines the accounting period to which the transaction belongs in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
customFields []Array: Parent object can have multiple instances of this nested object under it.	List of custom fields	CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
destinationAccount	Name of the account to which funds are transferred	string
id	Object identifier	uuid
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
memo	Records any extra information against a fund transfer for recapitulation	string
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
sourceAccount	Name of the account from which funds are transferred	string
token	Represents the token for update operations	int32
version	Implements concurrency on this object	byte

Example Response

[
  {
    "amount": 1,
    "date": "2025-09-04T05:19:44Z",
    "destinationId": "03d8c8d3-c9ff-4a9c-8323-edd0e66f074e",
    "sourceId": "10cea048-3e53-4dc6-80e2-430fe985485a",
    "accountingDate": "2025-09-04T05:19:44Z",
    "createdById": "7773a319-0e88-4264-b329-779249f62d12",
    "createdOn": "2025-09-04T05:19:44Z",
    "customFields": [
      {
        "definitionId": "6a0e6010-7c18-49a6-871d-fac40fb3711a",
        "createdById": "4f72b40b-ac50-4c19-8d05-190ccb9bc577",
        "createdOn": "2025-09-04T05:19:44Z",
        "description": "CustomFieldData Description",
        "id": "07fba229-3f8d-41c0-9a1f-71e75f2cf3b2",
        "label": "label",
        "lastUpdated": "2025-09-04T05:19:44Z",
        "lastUpdatedById": "9375c9d9-589c-4d44-93db-0f70e01f3eab",
        "objectState": null,
        "token": 0,
        "type": null,
        "value": "value",
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "destinationAccount": "destinationAccount",
    "id": "edc8509b-be9a-4321-bef5-bae1e387a605",
    "lastUpdated": "2025-09-04T05:19:44Z",
    "lastUpdatedById": "cc3d56f7-a72d-458e-88ef-cdac1a07ea23",
    "memo": "memo",
    "objectState": null,
    "sourceAccount": "sourceAccount",
    "token": 0,
    "version": "U3dhZ2dlciByb2Nrcw=="
  }
]

Retrieve a Fund Transfer

Use this method to retrieve a specific fund transfer. Pass id as the parameter.

Request URL

base_url/fundtransfer/{id}

/fundtransfer/{id}

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Fund Transfer

Required Scopes:

read:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Fund Transfer identifier	string

Response Body

Name	Description	Format
amount	Represents the fund transfer amount	double
date	Represents the date of the fund transfer	date-time
destinationId	Identifier of the account to which funds are transferred	uuid
sourceId	Identifier of the account from which funds are transferred	uuid
accountingDate	Date that determines the accounting period to which the transaction belongs in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
customFields []Array: Parent object can have multiple instances of this nested object under it.	List of custom fields	CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
destinationAccount	Name of the account to which funds are transferred	string
id	Object identifier	uuid
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
memo	Records any extra information against a fund transfer for recapitulation	string
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
sourceAccount	Name of the account from which funds are transferred	string
token	Represents the token for update operations	int32
version	Implements concurrency on this object	byte

Example Response

{
  "amount": 1,
  "date": "2025-09-04T05:19:44Z",
  "destinationId": "9a023f9b-0630-4d5e-acd5-db194bcb76fb",
  "sourceId": "a7848ce8-23f8-4020-abcf-e47255d85d69",
  "accountingDate": "2025-09-04T05:19:44Z",
  "createdById": "f2c66ffe-a150-45ea-ab88-a65d02f3a57b",
  "createdOn": "2025-09-04T05:19:44Z",
  "customFields": [
    {
      "definitionId": "e6358aa0-7f00-4083-b9d7-7c936038d756",
      "createdById": "97a53a21-629f-4998-bba2-6666263e2d92",
      "createdOn": "2025-09-04T05:19:44Z",
      "description": "CustomFieldData Description",
      "id": "d7592768-64bc-40e9-a090-bbfe35f2e8ee",
      "label": "label",
      "lastUpdated": "2025-09-04T05:19:44Z",
      "lastUpdatedById": "420cb9a4-9434-4b4e-b114-ac7d4fe26cae",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "destinationAccount": "destinationAccount",
  "id": "558030af-dab8-4188-bc6b-4247b994a71c",
  "lastUpdated": "2025-09-04T05:19:44Z",
  "lastUpdatedById": "4f781a21-22e3-4164-8d68-0651efca075e",
  "memo": "memo",
  "objectState": null,
  "sourceAccount": "sourceAccount",
  "token": 0,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Create a Fund Transfer

Use this method to craete a fund transfer. Pass fund transfer object as the parameter.

Request URL

base_url/fundtransfer

/fundtransfer

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Fund Transfer

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
body	Body	Fund Transfer object	FundTransfer

Response Body

Name	Description	Format
amount	Represents the fund transfer amount	double
date	Represents the date of the fund transfer	date-time
destinationId	Identifier of the account to which funds are transferred	uuid
sourceId	Identifier of the account from which funds are transferred	uuid
accountingDate	Date that determines the accounting period to which the transaction belongs in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
customFields []Array: Parent object can have multiple instances of this nested object under it.	List of custom fields	CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
destinationAccount	Name of the account to which funds are transferred	string
id	Object identifier	uuid
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
memo	Records any extra information against a fund transfer for recapitulation	string
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
sourceAccount	Name of the account from which funds are transferred	string
token	Represents the token for update operations	int32
version	Implements concurrency on this object	byte

Example Response

{
  "amount": 1,
  "date": "2025-09-04T05:19:44Z",
  "destinationId": "c0dc33d2-1291-4b48-ad3a-548bc6415b2d",
  "sourceId": "8754399b-5078-4e4f-b629-109931aac4ab",
  "accountingDate": "2025-09-04T05:19:44Z",
  "createdById": "d9b9bb23-afb6-4880-a362-67ccf147763c",
  "createdOn": "2025-09-04T05:19:44Z",
  "customFields": [
    {
      "definitionId": "d2a8cbd1-021c-42f2-8c9f-8c66abf0a5c4",
      "createdById": "9f9ce2f4-e04b-4e25-880c-4c7ab2d1217a",
      "createdOn": "2025-09-04T05:19:44Z",
      "description": "CustomFieldData Description",
      "id": "2365485a-de3f-4ba1-a8ad-68d720ab383a",
      "label": "label",
      "lastUpdated": "2025-09-04T05:19:44Z",
      "lastUpdatedById": "3deba314-dbab-45d6-9c80-f34008b79769",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "destinationAccount": "destinationAccount",
  "id": "9c40873f-a091-488b-8a4b-aa47c75123a4",
  "lastUpdated": "2025-09-04T05:19:44Z",
  "lastUpdatedById": "7ace8892-fa46-48cf-a4e5-0f2be3446f71",
  "memo": "memo",
  "objectState": null,
  "sourceAccount": "sourceAccount",
  "token": 0,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Create a Fund Transfer List

Use this method to save multiple fund transfers. Pass model as the parameter.

As saving multiple records in a batch takes time, this endpoint returns a Job object that shows the progress of the batch operation. To check the status of the operation at any time, use the job endpoint.

Request URL

base_url/fundtransfer/batch

/fundtransfer/batch

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Fund Transfer

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
body	Body	Fund Transfer object	FundTransferBatchRequest

Response Body

Name	Description	Format
batchSize	Represents the number of entities in a batch	int64
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
id	Object identifier	uuid
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
progress	Represents the total number of entities processed	int64
status	Represents the status of a job e.g., ready, running, completed, or terminated	string
token	Represents the token for update operations	int32
type	Represents the type of a job e.g., create, update, or delete	string
version	Implements concurrency on this object	byte

Example Response

{
  "batchSize": 0,
  "createdById": "3cd64611-0384-4d27-aa4d-af3da1f5baab",
  "createdOn": "2025-09-04T05:19:44Z",
  "id": "37694bc4-55ce-43c4-8a62-471bdb63cf6e",
  "lastUpdated": "2025-09-04T05:19:44Z",
  "lastUpdatedById": "eca7172d-061a-450a-9822-e07de12e62f1",
  "objectState": null,
  "progress": 0,
  "status": "status",
  "token": 0,
  "type": "type",
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Update a Fund Transfer

Use this method to update a fund transfer. Pass id and fund transfer as parameters.

Request URL

base_url/fundtransfer/{id}

/fundtransfer/{id}

Method Overview

HTTP Method:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Fund Transfer

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Fund Transfer identifier	string
body	Body	Fund Transfer object	FundTransfer

Response Body

Name	Description	Format
amount	Represents the fund transfer amount	double
date	Represents the date of the fund transfer	date-time
destinationId	Identifier of the account to which funds are transferred	uuid
sourceId	Identifier of the account from which funds are transferred	uuid
accountingDate	Date that determines the accounting period to which the transaction belongs in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
customFields []Array: Parent object can have multiple instances of this nested object under it.	List of custom fields	CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
destinationAccount	Name of the account to which funds are transferred	string
id	Object identifier	uuid
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
memo	Records any extra information against a fund transfer for recapitulation	string
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
sourceAccount	Name of the account from which funds are transferred	string
token	Represents the token for update operations	int32
version	Implements concurrency on this object	byte

Example Response

{
  "amount": 1,
  "date": "2025-09-04T05:19:44Z",
  "destinationId": "27494380-e4f7-44ce-bc8a-715cf789bb90",
  "sourceId": "85d46ea9-7394-4072-b666-665a2166f445",
  "accountingDate": "2025-09-04T05:19:44Z",
  "createdById": "037b19de-0fcf-40b4-acbe-49e88d82a0f7",
  "createdOn": "2025-09-04T05:19:44Z",
  "customFields": [
    {
      "definitionId": "adf04d70-194c-4b5c-9481-e870317e64ad",
      "createdById": "eb5e7b24-92dc-4341-94fc-ac82f350551c",
      "createdOn": "2025-09-04T05:19:44Z",
      "description": "CustomFieldData Description",
      "id": "47a0c6a5-1cbe-4da8-95ed-26e3455bc862",
      "label": "label",
      "lastUpdated": "2025-09-04T05:19:44Z",
      "lastUpdatedById": "c51b96a6-5047-4078-86fd-070c59fee341",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "destinationAccount": "destinationAccount",
  "id": "674e86f7-6142-4d55-9ed1-889e90f7a17e",
  "lastUpdated": "2025-09-04T05:19:44Z",
  "lastUpdatedById": "8fd873f8-692a-4563-baab-93f75ebae568",
  "memo": "memo",
  "objectState": null,
  "sourceAccount": "sourceAccount",
  "token": 0,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Delete a Fund Transfer

Use this method to delete a fund transfer. Pass id as the parameter.

Request URL

base_url/fundtransfer/{id}

/fundtransfer/{id}

Method Overview

HTTP Method:

DELETE

Content Type:

application/json

Response Format:

N/A

Requires Authentication?

Yes

Headers:

Access Token

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Fund Transfer identifier	string

Patch a Fund Transfer

Use this method to perform partial modifications to a fund transfer. Pass id and patch document as parameters.

Request URL

base_url/fundtransfer/{id}

/fundtransfer/{id}

Method Overview

HTTP Method:

PATCH

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Fund Transfer

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Fund Transfer identifier	string
body	Body	A document containing an array of objects with each object representing a single operation to be performed	FundTransferPatchDocument

Response Body

Name	Description	Format

Fund Transfer

The Fund Transfer Object

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body