Skip to main content
POST
/
quickbooks-desktop
/
deposits
JavaScript
import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});

const deposit = await conductor.qbd.deposits.create({
  depositToAccountId: '80000001-1234567890',
  transactionDate: '2024-10-01',
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(deposit.id);
{
  "id": "123ABC-1234567890",
  "objectType": "qbd_deposit",
  "createdAt": "2025-01-01T12:34:56.000Z",
  "updatedAt": "2025-02-01T12:34:56.000Z",
  "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"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.conductor.is/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

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

Example:

"end_usr_1234567abcdefg"

Body

application/json
​
transactionDate
string<date>
required

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

Example:

"2024-10-01"

​
depositToAccountId
string
required

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

Example:

"80000001-1234567890"

​
memo
string

A memo or note for this deposit.

Example:

"Batch settlement deposit"

​
cashBack
object

Cash back taken out of this deposit and recorded to another account, such as Petty Cash.

​
currencyId
string

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.

Example:

"80000001-1234567890"

​
exchangeRate
number

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

Example:

1.2345

​
externalId
string<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:

"12345678-abcd-1234-abcd-1234567890ab"

​
lines
object[]

The deposit's deposit lines, each representing either an existing payment selected for deposit or a manual transfer from another account into the deposit account.

Minimum array length: 1

Response

200 - application/json

Returns the newly created deposit.

​
id
string
required

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

Example:

"123ABC-1234567890"

​
objectType
string
required

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

Allowed value: "qbd_deposit"
Example:

"qbd_deposit"

​
createdAt
string
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.

Example:

"2025-01-01T12:34:56.000Z"

​
updatedAt
string
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.

Example:

"2025-02-01T12:34:56.000Z"

​
revisionNumber
string
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.

Example:

"1721172183"

​
transactionDate
string<date>
required

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

Example:

"2024-10-01"

​
depositToAccount
object
required

The account where the funds for this deposit have been deposited.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Checking"
}
​
memo
string | null
required

A memo or note for this deposit.

Example:

"Batch settlement deposit"

​
totalAmount
string | null
required

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

Example:

"1000.00"

​
currency
object
required

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.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "USD"
}
​
exchangeRate
number | null
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).

Example:

1.2345

​
totalAmountInHomeCurrency
string | null
required

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

Example:

"1234.56"

​
cashBack
The Deposit Cash-Back Line object · object
required

Cash back taken out of this deposit and recorded to another account, such as Petty Cash.

​
externalId
string | null
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:

"12345678-abcd-1234-abcd-1234567890ab"

​
lines
The Deposit Line object · object[]
required

The deposit's deposit lines, each representing either an existing payment selected for deposit or a manual transfer from another account into the deposit account.

​
customFields
The Custom Field object · object[]
required

The custom fields for the deposit object, added as user-defined data extensions, not included in the standard QuickBooks object.