Skip to main content

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.

​
paymentTransactionId
string
required

The ID of the received payment that is available to deposit. Pass this value as paymentTransactionId when creating a deposit line.

Example:

"123ABC-1234567890"

​
paymentTransactionLineId
string | null
required

The ID of the specific received-payment line that is available to deposit. If this value is not null, pass it as paymentTransactionLineId with paymentTransactionId when creating a deposit line.

Example:

"456DEF-1234567890"

​
transactionType
enum<string>
required

The type of transaction for this payment to deposit.

Available options:
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
Example:

"invoice"

​
customer
object
required

The customer or customer-job associated with this payment to deposit.

Example:
{
  "id": "80000001-1234567890",
  "fullName": "Acme Corporation"
}
​
transactionDate
string<date>
required

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

Example:

"2024-10-01"

​
refNumber
string | null
required

The case-sensitive user-defined reference number for this payment to deposit, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user.

Example:

"PAYMENT-1234"

​
amount
string
required

The monetary amount of this received payment that is currently available to deposit, represented as a decimal string.

Example:

"1000.00"

​
currency
object
required

The payment to 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 payment to 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

​
amountInHomeCurrency
string | null
required

The monetary amount of this payment to deposit converted to the home currency of the QuickBooks company file. Represented as a decimal string.

Example:

"1234.56"