Create a deposit

Creates a deposit into a QuickBooks Desktop bank or other asset account. Lines can either reference existing payments waiting to be deposited, using paymentTransactionId and optionally paymentTransactionLineId, or describe a manual transfer from another account using accountId and related line details.

post/quickbooks-desktop/deposits

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

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

Request body

transactionDatestring date required

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

depositToAccountIdstring required

The account where the funds for this deposit will be deposited.

memostring

A memo or note for this deposit.

currencyIdstring

The deposit's currency. For built-in currencies, the name and code are standard ISO 4217 international values. For user-defined currencies, all values are editable.

exchangeRatenumber

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).

externalIdstring uuid

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.

IMPORTANT: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.

Example request

{
  "transactionDate": "2024-10-01",
  "depositToAccountId": "80000001-1234567890",
  "memo": "Batch settlement deposit",
  "cashBack": {
    "accountId": "80000001-1234567890",
    "memo": "Cash back from deposit",
    "amount": "1000.00"
  },
  "currencyId": "80000001-1234567890",
  "exchangeRate": 1.2345,
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "lines": [
    {
      "paymentTransactionId": "123ABC-1234567890",
      "paymentTransactionLineId": "456DEF-1234567890",
      "overrideMemo": "Batch settlement deposit",
      "overrideCheckNumber": "1234567890",
      "overrideClassId": "80000001-1234567890",
      "entityId": "80000001-1234567890",
      "accountId": "80000001-1234567890",
      "memo": "Payment batched into settlement deposit",
      "checkNumber": "1234567890",
      "paymentMethodId": "80000001-1234567890",
      "classId": "80000001-1234567890",
      "amount": "1000.00"
    }
  ]
}

Response

Returns the newly created 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

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

Changed in 3 of the 46 revisions of this API.111

Jul 2, 2026daabb801a1731See the full diff
- ●
  added the new unknown enum value to the lines/items/transactionType/anyOf[subschema #1]/ response property for the response status 200
  response-property-enum-value-added
May 2, 20261de07095c4b710See the full diff
- ●
  the cashBack/accountId request property's maxLength was set to 36
  request-property-max-length-set
- ●
  the currencyId request property's maxLength was set to 36
  request-property-max-length-set
- ●
  the depositToAccountId request property's maxLength was set to 36
  request-property-max-length-set
- ●
  the lines/items/accountId request property's maxLength was set to 36
  request-property-max-length-set
- ●
  the lines/items/classId request property's maxLength was set to 36
  request-property-max-length-set
- ●
  the lines/items/entityId request property's maxLength was set to 36
  request-property-max-length-set
- ●
  the lines/items/overrideClassId request property's maxLength was set to 36
  request-property-max-length-set
- ●
  the lines/items/paymentMethodId request property's maxLength was set to 36
  request-property-max-length-set
- ●
  the lines/items/paymentTransactionId request property's maxLength was set to 36
  request-property-max-length-set
- ●
  the lines/items/paymentTransactionLineId request property's maxLength was set to 36
  request-property-max-length-set
May 1, 2026246263e100a61See the full diff
- ○
  endpoint added
  endpoint-added

Full history