COconductor-is

Retrieve a transfer

Changed on

Retrieves a transfer by ID.

IMPORTANT: If you need to fetch multiple specific transfers by ID, use the list endpoint instead with the ids parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.

get/quickbooks-desktop/transfers/{id}

Request

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the transfer to retrieve.

Example:123ABC-1234567890

Headers

Conductor-End-User-Idstring required

The ID of the End-User to receive this request.

Example:end_usr_1234567abcdefg

Response

Returns the specified transfer.

idstring required

The unique identifier assigned by QuickBooks to this transfer. This ID is unique across all transaction types.

objectType'qbd_transfer' required

The type of object. This value is always "qbd_transfer".

createdAtstring required

The date and time when this transfer was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

updatedAtstring required

The date and time when this transfer was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

revisionNumberstring required

The current QuickBooks-assigned revision number of this transfer object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

transactionDatestring date required

The date of this transfer, in ISO 8601 format (YYYY-MM-DD).

sourceAccountBalancestring nullable required

The balance of the account from which money will be transferred.

targetAccountBalancestring nullable required

The balance of the account to which money will be transferred.

amountstring required

The monetary amount of this transfer, represented as a decimal string.

memostring nullable required

A memo or note for this transfer.

Example response

{
  "id": "123ABC-1234567890",
  "objectType": "qbd_transfer",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "transactionDate": "2024-10-01",
  "sourceAccount": {
    "id": "80000001-1234567890",
    "fullName": "Checking"
  },
  "sourceAccountBalance": "1000.00",
  "targetAccount": {
    "id": "80000001-1234567890",
    "fullName": "Savings"
  },
  "targetAccountBalance": "5000.00",
  "class": {
    "id": "80000001-1234567890",
    "fullName": "Inter Departmental"
  },
  "amount": "1000.00",
  "memo": "Monthly transfer to savings"
}

Changes

  • 1de07095c4b7Revision changes
    • warning

      for the path request parameter id, the maxLength was set to 36

  • 10d4e9ebd1dfRevision changes
    • breaking

      response property memo list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property sourceAccount/fullName list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property sourceAccount/id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property sourceAccountBalance list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property targetAccount/fullName list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property targetAccount/id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property targetAccountBalance list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the response's property type changed from object null to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status