Update a journal entry - Conductor Docs

QuickBooks Desktop API

General

Accounts
Classes
Customers
Date-Driven Terms
Employees
Inventory Sites
Payroll Wage Items
Sales Representatives
Sales-Tax Codes
Standard Terms
Vendors

Transactions

Bill Check Payments
Bill Credit Card Payments
Bills
Checks
Credit Card Charges
Credit Card Credits
Credit Memos
Estimates
Inventory Adjustments
Invoices
Journal Entries
Purchase Orders
Receive-Payments
Sales Orders
Sales Receipts
Time Tracking Activities
Transfers
Vendor Credits

Items

Discount Items
Inventory Assembly Items
Inventory Items
Non-Inventory Items
Sales-Tax Items
Service Items
Subtotal Items

POST

quickbooks-desktop

journal-entries

{id}

import Conductor from 'conductor-node';

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

async function main() {
  const journalEntry = await client.qbd.journalEntries.update('123ABC-1234567890', {
    revisionNumber: '1721172183',
    conductorEndUserId: 'end_usr_1234567abcdefg',
  });

  console.log(journalEntry.id);
}

main();

{
  "id": "123ABC-1234567890",
  "objectType": "qbd_journal_entry",
  "createdAt": "2021-10-01T17:34:56.000Z",
  "updatedAt": "2021-10-01T20:45:30.000Z",
  "revisionNumber": "1721172183",
  "transactionDate": "2021-10-01T00:00:00.000Z",
  "refNumber": "JE-1234",
  "isAdjustment": false,
  "isHomeCurrencyAdjustment": false,
  "areAmountsEnteredInHomeCurrency": false,
  "currency": {
    "id": "80000001-1234567890",
    "fullName": "USD"
  },
  "exchangeRate": 1.2345,
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "debitLines": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_journal_debit_line",
      "account": {
        "id": "80000001-1234567890",
        "fullName": "Checking"
      },
      "amount": "1000.00",
      "memo": "Monthly utility bill settlement",
      "entity": {
        "id": "80000001-1234567890",
        "fullName": "Acme Corporation"
      },
      "class": {
        "id": "80000001-1234567890",
        "fullName": "Facilities & Utilities"
      },
      "salesTaxItem": {
        "id": "80000001-1234567890",
        "fullName": "State Sales Tax"
      },
      "billingStatus": "billable"
    }
  ],
  "creditLines": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_journal_credit_line",
      "account": {
        "id": "80000001-1234567890",
        "fullName": "Accounts-Payable"
      },
      "amount": "1000.00",
      "memo": "Allocated funds for office lease payment",
      "entity": {
        "id": "80000001-1234567890",
        "fullName": "Acme Corporation"
      },
      "class": {
        "id": "80000001-1234567890",
        "fullName": "Administrative"
      },
      "salesTaxItem": {
        "id": "80000001-1234567890",
        "fullName": "State Sales Tax"
      },
      "billingStatus": "billable"
    }
  ],
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}

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 EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Path Parameters

string

required

The QuickBooks-assigned unique identifier of the journal entry to update.

Body

application/json

revisionNumber

string

required

The current QuickBooks-assigned revision number of the journal entry object you are updating, which you can get by fetching the object first. Provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

transactionDate

string

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

refNumber

string

The case-sensitive user-defined reference number for this journal entry, 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.

isAdjustment

boolean

Indicates whether this journal entry is an adjustment entry. When true, QuickBooks retains the original entry information to maintain an audit trail of the adjustments.

areAmountsEnteredInHomeCurrency

boolean

Indicates whether the amounts in this journal entry were entered in the company's home currency rather than a foreign currency. When true, amounts are in the home currency regardless of the currency field.

currencyId

string

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

exchangeRate

number

The market exchange rate between this journal entry'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).

lines

object[]

The journal entry's credit and debit lines.

IMPORTANT: When updating journal entries, you must include ALL existing journal lines (both credit and debit) in your update request, even if you only want to modify a single line. QuickBooks will automatically delete any existing lines that are not included in the update request, which is why all lines must be provided in a single array when updating.

Response

200 - application/json

Returns the updated journal entry.

string

required

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

objectType

string

required

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

Allowed value: "qbd_journal_entry"

createdAt

string

required

The date and time when this journal entry was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

updatedAt

string

required

The date and time when this journal entry was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

revisionNumber

string

required

The current QuickBooks-assigned revision number of this journal entry 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.

transactionDate

string

required

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

refNumber

string | null

required

isAdjustment

boolean | null

required

Indicates whether this journal entry is an adjustment entry. When true, QuickBooks retains the original entry information to maintain an audit trail of the adjustments.

isHomeCurrencyAdjustment

boolean | null

required

Indicates whether this journal entry is an adjustment made in the company's home currency for a transaction that was originally recorded in a foreign currency.

areAmountsEnteredInHomeCurrency

boolean | null

required

currency

object | null

required

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

exchangeRate

number | null

required

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.

debitLines

object[]

required

The journal entry's debit lines.

debitLines.id

string

required

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

debitLines.objectType

string

required

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

Allowed value: "qbd_journal_debit_line"

debitLines.account

object | null

required

The account to which this journal debit line is being debited. This will decrease the balance of this account.

debitLines.amount

string | null

required

The monetary amount of this journal debit line, represented as a decimal string.

debitLines.memo

string | null

required

A memo or note for this journal debit line.

debitLines.entity

object | null

required

The customer, vendor, employee, or other entity associated with this journal debit line.

IMPORTANT: If the journal debit line's account is an Accounts Receivable (A/R) account, this field must refer to a customer. If the journal debit line's account is an Accounts Payable (A/P) account, this field must refer to a vendor. If these requirements are not met, QuickBooks Desktop will not record the transaction.

debitLines.class

object | null

required

The journal debit 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. If a class is specified for the entire parent transaction, it is automatically applied to all journal debit lines unless overridden here, at the transaction line level.

debitLines.salesTaxItem

object | null

required

The sales-tax item used to calculate the actual tax amount for this journal debit line's transactions by applying a specific tax rate collected for a single tax agency. Unlike salesTaxCode, which only indicates general taxability, this field drives the actual tax calculation and reporting.

debitLines.billingStatus

enum<string> | null

required

The billing status of this journal debit line.

Available options:

billable,

has_been_billed,

not_billable

creditLines

object[]

required

The journal entry's credit lines.

creditLines.id

string

required

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

creditLines.objectType

string

required

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

Allowed value: "qbd_journal_credit_line"

creditLines.account

object

required

The account to which this journal credit line is being credited. This will increase the balance of this account.

creditLines.amount

string | null

required

The monetary amount of this journal credit line, represented as a decimal string.

creditLines.memo

string | null

required

A memo or note for this journal credit line.

creditLines.entity

object | null

required

The customer, vendor, employee, or other entity associated with this journal credit line.

IMPORTANT: If the journal credit line's account is an Accounts Receivable (A/R) account, this field must refer to a customer. If the journal credit line's account is an Accounts Payable (A/P) account, this field must refer to a vendor. If these requirements are not met, QuickBooks Desktop will not record the transaction.

creditLines.class

object | null

required

The journal credit 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. If a class is specified for the entire parent transaction, it is automatically applied to all journal credit lines unless overridden here, at the transaction line level.

creditLines.salesTaxItem

object | null

required

The sales-tax item used to calculate the actual tax amount for this journal credit line's transactions by applying a specific tax rate collected for a single tax agency. Unlike salesTaxCode, which only indicates general taxability, this field drives the actual tax calculation and reporting.

creditLines.billingStatus

enum<string> | null

required

The billing status of this journal credit line.

Available options:

billable,

has_been_billed,

not_billable

customFields

object[]

required

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

Create a journal entry Retrieve a journal entry

import Conductor from 'conductor-node';

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

async function main() {
  const journalEntry = await client.qbd.journalEntries.update('123ABC-1234567890', {
    revisionNumber: '1721172183',
    conductorEndUserId: 'end_usr_1234567abcdefg',
  });

  console.log(journalEntry.id);
}

main();

{
  "id": "123ABC-1234567890",
  "objectType": "qbd_journal_entry",
  "createdAt": "2021-10-01T17:34:56.000Z",
  "updatedAt": "2021-10-01T20:45:30.000Z",
  "revisionNumber": "1721172183",
  "transactionDate": "2021-10-01T00:00:00.000Z",
  "refNumber": "JE-1234",
  "isAdjustment": false,
  "isHomeCurrencyAdjustment": false,
  "areAmountsEnteredInHomeCurrency": false,
  "currency": {
    "id": "80000001-1234567890",
    "fullName": "USD"
  },
  "exchangeRate": 1.2345,
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "debitLines": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_journal_debit_line",
      "account": {
        "id": "80000001-1234567890",
        "fullName": "Checking"
      },
      "amount": "1000.00",
      "memo": "Monthly utility bill settlement",
      "entity": {
        "id": "80000001-1234567890",
        "fullName": "Acme Corporation"
      },
      "class": {
        "id": "80000001-1234567890",
        "fullName": "Facilities & Utilities"
      },
      "salesTaxItem": {
        "id": "80000001-1234567890",
        "fullName": "State Sales Tax"
      },
      "billingStatus": "billable"
    }
  ],
  "creditLines": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_journal_credit_line",
      "account": {
        "id": "80000001-1234567890",
        "fullName": "Accounts-Payable"
      },
      "amount": "1000.00",
      "memo": "Allocated funds for office lease payment",
      "entity": {
        "id": "80000001-1234567890",
        "fullName": "Acme Corporation"
      },
      "class": {
        "id": "80000001-1234567890",
        "fullName": "Administrative"
      },
      "salesTaxItem": {
        "id": "80000001-1234567890",
        "fullName": "State Sales Tax"
      },
      "billingStatus": "billable"
    }
  ],
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}