COconductor-is

Retrieve a deposit

Changed on

Retrieves a deposit by ID.

IMPORTANT: If you need to fetch multiple specific deposits 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/deposits/{id}

Request

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the deposit 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 deposit.

idstring required

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

objectType'qbd_deposit' required

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

createdAtstring required

The date and time when this deposit 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 deposit 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 deposit 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 deposit, in ISO 8601 format (YYYY-MM-DD).

memostring nullable required

A memo or note for this deposit.

totalAmountstring nullable required

The total monetary amount deposited into this deposit's destination account, represented as a decimal string.

exchangeRatenumber nullable required

The market exchange rate between this deposit's currency and the home currency in QuickBooks at the time of this transaction. Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).

totalAmountInHomeCurrencystring nullable required

This deposit's total monetary amount converted to the home currency of the QuickBooks company file, represented as a decimal string.

externalIdstring nullable required

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

Example response

{
  "id": "123ABC-1234567890",
  "objectType": "qbd_deposit",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "transactionDate": "2024-10-01",
  "depositToAccount": {
    "id": "80000001-1234567890",
    "fullName": "Checking"
  },
  "memo": "Batch settlement deposit",
  "totalAmount": "1000.00",
  "currency": {
    "id": "80000001-1234567890",
    "fullName": "USD"
  },
  "exchangeRate": 1.2345,
  "totalAmountInHomeCurrency": "1234.56",
  "cashBack": {
    "id": "456DEF-1234567890",
    "objectType": "qbd_deposit_cash_back_line",
    "account": {
      "id": "80000001-1234567890",
      "fullName": "Petty Cash"
    },
    "memo": "Cash back from deposit",
    "amount": "1000.00"
  },
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "lines": [
    {
      "transactionType": "invoice",
      "paymentTransactionId": "123ABC-1234567890",
      "id": "456DEF-1234567890",
      "objectType": "qbd_deposit_line",
      "paymentTransactionLineId": "456DEF-1234567890",
      "entity": {
        "id": "80000001-1234567890",
        "fullName": "Acme Corporation"
      },
      "account": {
        "id": "80000001-1234567890",
        "fullName": "Undeposited Funds"
      },
      "memo": "Payment batched into settlement deposit",
      "checkNumber": "1234567890",
      "paymentMethod": {
        "id": "80000001-1234567890",
        "fullName": "Credit Card"
      },
      "class": {
        "id": "80000001-1234567890",
        "fullName": "Retail Sales"
      },
      "amount": "1000.00"
    }
  ],
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}

Changes

  • 8ee3502091a4Revision changes
    • warning

      added the new transfer_inventory enum value to the /// response property for the response status

  • daabb801a173Revision changes
    • warning

      added the new unknown enum value to the /// response property for the response status