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
The Fund Transfer Object
asterisk denotes requiredName | 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 |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string | Filterable, Sortable |
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
Method Overview
HTTP Method:
GET
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
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 |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
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 |
[
{
"amount": 1,
"date": "2025-06-24T05:52:00Z",
"destinationId": "9f82c497-b095-48ce-8d85-cba6c2b6348d",
"sourceId": "0c28dc82-0665-4f35-bf01-5bb854655b45",
"accountingDate": "2025-06-24T05:52:00Z",
"createdById": "fc984989-cc83-4312-877a-dca7e84f37a8",
"createdOn": "2025-06-24T05:52:00Z",
"customFields": [
{
"definitionId": "d2402ebb-6af0-4754-8643-48427ba3b523",
"createdById": "e96cf550-bea4-4f05-b31d-4cd294d7e1a5",
"createdOn": "2025-06-24T05:52:00Z",
"description": "CustomFieldData Description",
"id": "4e024105-f8d0-4914-9fec-50f57bb3a5e3",
"integrationSourceId": "integrationSourceId",
"label": "label",
"lastUpdated": "2025-06-24T05:52:00Z",
"lastUpdatedById": "cb013e94-bb04-439f-baa5-1ee2b7d86c00",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"destinationAccount": "destinationAccount",
"id": "fdb7dfc8-add8-4ca1-95b3-2a29d0fef145",
"integrationSourceId": "integrationSourceId",
"lastUpdated": "2025-06-24T05:52:00Z",
"lastUpdatedById": "7096496a-cb2c-46a8-b0b5-79e4a473139d",
"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
Method Overview
HTTP Method:
GET
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
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 |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
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 |
{
"amount": 1,
"date": "2025-06-24T05:52:00Z",
"destinationId": "a7de6275-d9c8-49c1-b9c3-9237ea784741",
"sourceId": "6f3b71d5-bf68-4161-8022-19868b735a78",
"accountingDate": "2025-06-24T05:52:00Z",
"createdById": "77925797-ec75-4007-8062-275440cd08a8",
"createdOn": "2025-06-24T05:52:00Z",
"customFields": [
{
"definitionId": "e07a9b64-a6ba-4b48-a2ea-953ba59f2106",
"createdById": "ee931210-716b-4438-a502-2bad7f854fcf",
"createdOn": "2025-06-24T05:52:00Z",
"description": "CustomFieldData Description",
"id": "386ab7b2-350f-4d10-8cdb-db0c9ce6ce78",
"integrationSourceId": "integrationSourceId",
"label": "label",
"lastUpdated": "2025-06-24T05:52:00Z",
"lastUpdatedById": "be943144-4ea9-4de3-b59c-8d68aa5f563a",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"destinationAccount": "destinationAccount",
"id": "81adf435-11b6-4c1d-9baf-ec891945c1c5",
"integrationSourceId": "integrationSourceId",
"lastUpdated": "2025-06-24T05:52:00Z",
"lastUpdatedById": "95b8b90a-2051-494a-9d21-01e298be26d4",
"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
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
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 |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
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 |
{
"amount": 1,
"date": "2025-06-24T05:52:00Z",
"destinationId": "12a2e464-2458-4e9d-aa79-1585c90684ad",
"sourceId": "9e00b13e-e287-44c3-9694-cd436525dbc2",
"accountingDate": "2025-06-24T05:52:00Z",
"createdById": "e407c6dd-02d9-43a7-b034-d3716b429c3a",
"createdOn": "2025-06-24T05:52:00Z",
"customFields": [
{
"definitionId": "e002a1be-c129-40ce-9ef7-f9b8864db1c5",
"createdById": "17d593cc-48b6-4d19-9757-74bbae65ce70",
"createdOn": "2025-06-24T05:52:00Z",
"description": "CustomFieldData Description",
"id": "cacafd35-3d5a-401b-8f10-76ca49d6b64f",
"integrationSourceId": "integrationSourceId",
"label": "label",
"lastUpdated": "2025-06-24T05:52:00Z",
"lastUpdatedById": "9e5e9bdb-fefb-4fea-8ce0-ac12fd7e1374",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"destinationAccount": "destinationAccount",
"id": "b01deb16-8248-476b-b60c-3a9e683b3f24",
"integrationSourceId": "integrationSourceId",
"lastUpdated": "2025-06-24T05:52:00Z",
"lastUpdatedById": "d1c2fc58-899d-4c64-abdb-2d5870ee65e9",
"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.
Request URL
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
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 |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
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 |
{
"batchSize": 0,
"createdById": "3bb395eb-7980-40a4-8209-4d98bf4f9b08",
"createdOn": "2025-06-24T05:52:00Z",
"id": "fbc42f24-e829-4830-ad8e-ec1d92407bee",
"integrationSourceId": "integrationSourceId",
"lastUpdated": "2025-06-24T05:52:00Z",
"lastUpdatedById": "8aabeed9-98ad-4249-8e44-bf808715b0b1",
"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
Method Overview
HTTP Method:
PUT
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
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 |
integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
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 |
{
"amount": 1,
"date": "2025-06-24T05:52:00Z",
"destinationId": "f8fc1ebf-95e6-4fb6-9f8d-002eb5ac2c33",
"sourceId": "d99a1fec-cefb-4568-a43d-1c63f774112f",
"accountingDate": "2025-06-24T05:52:00Z",
"createdById": "7f474c2a-a759-4bfa-9a81-dad148e547ff",
"createdOn": "2025-06-24T05:52:00Z",
"customFields": [
{
"definitionId": "7ce7b80b-8dd0-47fb-84aa-1065d5fbe249",
"createdById": "13ff124b-24ed-4cd4-bb6b-8988c495f646",
"createdOn": "2025-06-24T05:52:00Z",
"description": "CustomFieldData Description",
"id": "377d7f73-36dd-44c4-8df7-c9fd9bf5df8c",
"integrationSourceId": "integrationSourceId",
"label": "label",
"lastUpdated": "2025-06-24T05:52:00Z",
"lastUpdatedById": "5a57e35a-fc69-41d1-b742-f0e4e795e56f",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"destinationAccount": "destinationAccount",
"id": "c5c568a4-9def-4f39-9567-480e3a8a29af",
"integrationSourceId": "integrationSourceId",
"lastUpdated": "2025-06-24T05:52:00Z",
"lastUpdatedById": "b32ec7b4-3a5f-43f5-b2a3-c7182d421e4a",
"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
Method Overview
HTTP Method:
DELETE
Content Type:
application/json
Response Format:
N/A
Requires Authentication?
Yes
Headers:
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
Method Overview
HTTP Method:
PATCH
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
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 |
---|