> ## 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. # 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. ## OpenAPI ````yaml POST /quickbooks-desktop/deposits openapi: 3.1.0 info: title: Conductor API version: 0.0.1 servers: - url: https://api.conductor.is/v1 security: - BearerAuth: [] paths: /quickbooks-desktop/deposits: post: summary: Create a deposit description: >- 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. parameters: - in: header name: Conductor-End-User-Id schema: type: string description: The ID of the End-User to receive this request. example: end_usr_1234567abcdefg x-stainless-naming: typescript: method_argument: conductorEndUserId mcp: method_argument: conductorEndUserId required: true description: The ID of the End-User to receive this request. requestBody: required: true content: application/json: schema: type: object properties: transactionDate: type: string format: date description: The date of this deposit, in ISO 8601 format (YYYY-MM-DD). example: '2024-10-01' depositToAccountId: description: >- The account where the funds for this deposit will be deposited. example: 80000001-1234567890 type: string maxLength: 36 memo: description: A memo or note for this deposit. example: Batch settlement deposit type: string cashBack: description: >- Cash back taken out of this deposit and recorded to another account, such as Petty Cash. type: object properties: accountId: description: >- The account where this deposit cash-back line's cash-back amount is recorded, such as Petty Cash. This amount reduces the total credited to the deposit's destination account. example: 80000001-1234567890 type: string maxLength: 36 memo: description: A memo or note for this deposit cash-back line. example: Cash back from deposit type: string amount: description: >- The cash-back amount taken out of the deposit and recorded to this deposit cash-back line's account, represented as a decimal string. Decimal string format: exactly 2 decimal places when cents are included and up to 13 digits before the decimal point (for example, "123.45"). example: '1000.00' type: string required: - accountId additionalProperties: false currencyId: description: >- 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 type: string maxLength: 36 exchangeRate: description: >- 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 type: number externalId: type: string format: uuid description: >- 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: description: >- 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. minItems: 1 type: array items: type: object properties: paymentTransactionId: description: >- The ID of an existing undeposited payment to include in this deposit line. Use the `paymentTransactionId` from a payments-to-deposit result, or the `id` from the original receive-payment response. If the source payment has multiple depositable lines and you omit `paymentTransactionLineId`, QuickBooks Desktop deposits only the first line. example: 123ABC-1234567890 type: string maxLength: 36 paymentTransactionLineId: type: string maxLength: 36 description: >- The line ID for the specific undeposited payment line to include in this deposit line. Use the `paymentTransactionLineId` from a payments-to-deposit result. If the source payment has multiple depositable lines, provide this field with `paymentTransactionId` to choose the exact line. example: 456DEF-1234567890 overrideMemo: description: >- The memo to use for this deposit line, overriding the memo from the existing payment line. Maximum length: 4095 characters. example: Batch settlement deposit type: string maxLength: 4095 overrideCheckNumber: description: >- The check number to use for this deposit line, overriding the check number from the existing payment line. Maximum length: 11 characters. example: '1234567890' type: string maxLength: 11 overrideClassId: description: >- The class to use for this deposit line, overriding the class from the existing payment line. example: 80000001-1234567890 type: string maxLength: 36 entityId: description: >- The customer, vendor, employee, or person on QuickBooks's "Other Names" list associated with this manual deposit line. example: 80000001-1234567890 type: string maxLength: 36 accountId: description: >- For a manual deposit line, the account that the funds are transferred from into the deposit's destination account. To deposit an existing payment instead, use `paymentTransactionId` and, when needed, `paymentTransactionLineId`. example: 80000001-1234567890 type: string maxLength: 36 memo: description: A memo or note for this deposit line. example: Payment batched into settlement deposit type: string checkNumber: description: >- The check number of a check received for this deposit line. example: '1234567890' type: string paymentMethodId: description: >- The deposit line's payment method (e.g., cash, check, credit card). example: 80000001-1234567890 type: string maxLength: 36 classId: description: >- The deposit line's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default. example: 80000001-1234567890 type: string maxLength: 36 amount: description: >- For a manual deposit line, the amount transferred from the line's account into the deposit's destination account, represented as a decimal string. Decimal string format: exactly 2 decimal places when cents are included and up to 13 digits before the decimal point (for example, "123.45"). example: '1000.00' type: string additionalProperties: false required: - transactionDate - depositToAccountId additionalProperties: false responses: '200': description: Returns the newly created deposit. headers: Conductor-Request-Id: required: true description: The unique identifier for this API request. schema: type: string description: The unique identifier for this API request. example: req_1234567abcdefg content: application/json: schema: $ref: '#/components/schemas/qbd_deposit' security: - BearerAuth: [] x-codeSamples: - lang: JavaScript source: |- 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); - lang: Python source: |- import os from datetime import date from conductor import Conductor conductor = Conductor( api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted ) deposit = conductor.qbd.deposits.create( deposit_to_account_id="80000001-1234567890", transaction_date=date.fromisoformat("2024-10-01"), conductor_end_user_id="end_usr_1234567abcdefg", ) print(deposit.id) components: schemas: qbd_deposit: type: object properties: id: type: string description: >- The unique identifier assigned by QuickBooks to this deposit. This ID is unique across all transaction types. example: 123ABC-1234567890 objectType: description: The type of object. This value is always `"qbd_deposit"`. example: qbd_deposit type: string const: qbd_deposit createdAt: type: string description: >- 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: type: string description: >- 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: type: string description: >- 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: type: string format: date description: The date of this deposit, in ISO 8601 format (YYYY-MM-DD). example: '2024-10-01' depositToAccount: anyOf: - type: object properties: id: anyOf: - type: string - type: 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: anyOf: - type: string - type: 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false - type: 'null' description: The account where the funds for this deposit have been deposited. example: id: 80000001-1234567890 fullName: Checking memo: anyOf: - type: string - type: 'null' description: A memo or note for this deposit. example: Batch settlement deposit totalAmount: anyOf: - type: string - type: 'null' description: >- The total monetary amount deposited into this deposit's destination account, represented as a decimal string. example: '1000.00' currency: anyOf: - type: object properties: id: anyOf: - type: string - type: 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: anyOf: - type: string - type: 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false - type: 'null' description: >- 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: anyOf: - type: number - type: 'null' description: >- 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: anyOf: - type: string - type: 'null' description: >- 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: anyOf: - $ref: '#/components/schemas/qbd_deposit_cash_back_line' - type: 'null' description: >- Cash back taken out of this deposit and recorded to another account, such as Petty Cash. externalId: anyOf: - type: string description: >- 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 - type: 'null' lines: type: array items: $ref: '#/components/schemas/qbd_deposit_line' description: >- 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: type: array items: $ref: '#/components/schemas/qbd_custom_field' description: >- The custom fields for the deposit object, added as user-defined data extensions, not included in the standard QuickBooks object. required: - id - objectType - createdAt - updatedAt - revisionNumber - transactionDate - depositToAccount - memo - totalAmount - currency - exchangeRate - totalAmountInHomeCurrency - cashBack - externalId - lines - customFields additionalProperties: false title: The Deposit object x-conductor-object-type: transaction summary: >- A deposit records funds moved into a QuickBooks Desktop bank or other asset account. It is commonly used to group customer payments from Undeposited Funds into the bank deposit that appears on the bank statement, and it can also include manual deposit lines and cash back. qbd_deposit_cash_back_line: type: object properties: id: type: string description: >- The unique identifier assigned by QuickBooks to this deposit cash-back line. This ID is unique across all transaction line types. example: 456DEF-1234567890 objectType: description: >- The type of object. This value is always `"qbd_deposit_cash_back_line"`. example: qbd_deposit_cash_back_line type: string const: qbd_deposit_cash_back_line account: type: object properties: id: anyOf: - type: string - type: 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: anyOf: - type: string - type: 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false description: >- The account where this deposit cash-back line's cash-back amount is recorded, such as Petty Cash. This amount reduces the total credited to the deposit's destination account. example: id: 80000001-1234567890 fullName: Petty Cash memo: anyOf: - type: string - type: 'null' description: A memo or note for this deposit cash-back line. example: Cash back from deposit amount: anyOf: - type: string - type: 'null' description: >- The cash-back amount taken out of the deposit and recorded to this deposit cash-back line's account, represented as a decimal string. example: '1000.00' required: - id - objectType - account - memo - amount additionalProperties: false title: The Deposit Cash-Back Line object x-conductor-object-type: nested qbd_deposit_line: type: object properties: transactionType: anyOf: - type: string enum: - ar_refund_credit_card - bill - bill_payment_check - bill_payment_credit_card - build_assembly - charge - check - credit_card_charge - credit_card_credit - credit_memo - deposit - estimate - inventory_adjustment - invoice - item_receipt - journal_entry - liability_adjustment - paycheck - payroll_liability_check - purchase_order - receive_payment - sales_order - sales_receipt - sales_tax_payment_check - transfer - vendor_credit - ytd_adjustment - type: 'null' description: The type of transaction for this deposit line. example: invoice paymentTransactionId: anyOf: - type: string maxLength: 36 description: >- For payment-based deposit lines, the ID of the source payment included in this deposit line. For manual deposit lines, this is null. example: 123ABC-1234567890 - type: 'null' id: type: string description: >- The unique identifier assigned by QuickBooks to this deposit line. This ID is unique across all transaction line types. example: 456DEF-1234567890 objectType: description: The type of object. This value is always `"qbd_deposit_line"`. example: qbd_deposit_line type: string const: qbd_deposit_line paymentTransactionLineId: anyOf: - type: string maxLength: 36 description: >- For payment-based deposit lines, the line ID of the specific source payment line included in this deposit line. For manual deposit lines, this is null. example: 456DEF-1234567890 - type: 'null' entity: anyOf: - type: object properties: id: anyOf: - type: string - type: 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: anyOf: - type: string - type: 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false - type: 'null' description: >- The customer, vendor, employee, or person on QuickBooks's "Other Names" list associated with this deposit line. example: id: 80000001-1234567890 fullName: Acme Corporation account: anyOf: - type: object properties: id: anyOf: - type: string - type: 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: anyOf: - type: string - type: 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false - type: 'null' description: >- The account associated with this deposit line. For manual deposit lines, this is the account the funds were transferred from into the deposit's destination account. example: id: 80000001-1234567890 fullName: Undeposited Funds memo: anyOf: - type: string - type: 'null' description: A memo or note for this deposit line. example: Payment batched into settlement deposit checkNumber: anyOf: - type: string - type: 'null' description: The check number of a check received for this deposit line. example: '1234567890' paymentMethod: anyOf: - type: object properties: id: anyOf: - type: string - type: 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: anyOf: - type: string - type: 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false - type: 'null' description: The deposit line's payment method (e.g., cash, check, credit card). example: id: 80000001-1234567890 fullName: Credit Card class: anyOf: - type: object properties: id: anyOf: - type: string - type: 'null' description: >- The unique identifier assigned by QuickBooks to this object. This ID is unique across all objects of the same type, but not across different QuickBooks object types. example: 80000001-1234567890 fullName: anyOf: - type: string - type: 'null' description: >- The fully-qualified unique name for this object, formed by combining the names of its parent objects with its own `name`, separated by colons. Not case-sensitive. example: Parent:Child:Grandchild required: - id - fullName additionalProperties: false - type: 'null' description: >- The deposit line's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default. example: id: 80000001-1234567890 fullName: Retail Sales amount: anyOf: - type: string - type: 'null' description: >- The amount this deposit line contributes to the deposit's destination account, represented as a decimal string. example: '1000.00' required: - transactionType - paymentTransactionId - id - objectType - paymentTransactionLineId - entity - account - memo - checkNumber - paymentMethod - class - amount additionalProperties: false title: The Deposit Line object x-conductor-object-type: nested qbd_custom_field: type: object properties: ownerId: type: string description: >- The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an `ownerId` of "0") for all objects. example: '0' name: type: string description: >- The name of the custom field, unique for the specified `ownerId`. For public custom fields, this name is visible as a label in the QuickBooks UI. example: Customer Rating type: type: string enum: - amount_type - date_time_type - integer_type - percent_type - price_type - quantity_type - string_1024_type - string_255_type description: The data type of this custom field. example: string_1024_type value: type: string description: >- The value of this custom field. The maximum length depends on the field's data type. example: Premium required: - ownerId - name - type - value additionalProperties: false title: The Custom Field object x-conductor-object-type: nested securitySchemes: BearerAuth: type: http scheme: bearer description: >- Your Conductor secret key using Bearer auth (e.g., `"Authorization: Bearer {{YOUR_SECRET_KEY}}"`). ````