QuickBooks: Read a journalentry — response body — Journal Entry
Read a journalentry: response body, field JournalEntry. Complete fields and constraints for contract 2026-10-20.
API reference · Contract 2026-10-20
SDK schema: Read a journalentry — response body — Journal Entry
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
Adjustment | JSON | Optional | Indicates whether this transaction is a journal entry adjustment. |
Adjustment (anyOf 1) | boolean | Alternative | |
Adjustment (anyOf 2) | string | Alternative | Known values: true, false |
CurrencyRef | Model | Optional | Expand Read a bill — response body — Bill Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company Conditionally required |
DocNumber | string | Optional | Reference number for the transaction. Throws an error when duplicate DocNumber is sent in the request and if Preferences:OtherPrefs:NameValue.Name = WarnDuplicateJournalNumber is true. Recommended best practice: check the setting of Preferences:OtherPrefs:NameValue.Name = WarnDuplicateJournalNumber before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Sort order is ASC by default. If null value is sent in the request null will be saved. If there is a need to support assigning a docNumber when null, it can be achieved through include param, include=allowautodocnum |
ExchangeRate | JSON | Optional | The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string |
ExchangeRate (anyOf 1) | JSON | Alternative | |
ExchangeRate (anyOf 1) (anyOf 1) | number | Alternative | |
ExchangeRate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
ExchangeRate (anyOf 2) | string | Alternative | |
GlobalTaxCalculation | string | Optional | Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive . Not applicable to US companies; required for non-US companies. Conditionally required |
HomeTotalAmt | JSON | Optional | The value of this field will always be set to zero. Applicable if multicurrency is enabled for the company. Decimal string Read only: true |
HomeTotalAmt (anyOf 1) | JSON | Alternative | |
HomeTotalAmt (anyOf 1) (anyOf 1) | number | Alternative | |
HomeTotalAmt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
HomeTotalAmt (anyOf 2) | string | Alternative | |
Id | string | Optional | Unique identifier for this object. Read only: true |
Line | array | Optional | Individual line items of a transaction. There must be at least one pair of Journal Entry Line elements, representing a debit and a credit, called distribution lines. Valid Line types include: JournalEntryLine and DescriptionOnlyLine |
Line[] | JSON | Each item | |
Line[] (anyOf 1) | Model | Alternative | Expand Read a journalentry — response body — Journal Entry Line item Amount, Custom Extensions, Description, Detail Type, Id, Journal Entry Line Detail, Line Num, Project Ref |
Line[] (anyOf 2) | Model | Alternative | Expand Read an invoice — response body — Invoice Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num |
MetaData | Model | Optional | Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications. |
PrivateNote | string | Optional | User entered, organization-private note about the transaction. |
RecurDataRef | Model | Optional | Expand Read an item — response body — Item Class Ref A reference to the Recurring Transaction. It captures what recurring transaction template the JournalEntry was created from. Read only: true |
SyncToken | string | Optional | Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true |
TaxRateRef | Model | Optional | Expand Read an item — response body — Item Class Ref Reference to the Tax Adjustment Rate Ids for this item. Query the TaxRate list resource to determine the appropriate TaxRate object for this reference. Use TaxRate.Id and TaxRate.Name from that object for TaxRateRef.value and TaxRateRef.name, respectively. |
TotalAmt | JSON | Optional | The value of this field will always be set to zero. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true |
TotalAmt (anyOf 1) | JSON | Alternative | |
TotalAmt (anyOf 1) (anyOf 1) | number | Alternative | |
TotalAmt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
TotalAmt (anyOf 2) | string | Alternative | |
TxnDate | string | Optional | The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default. |
TxnTaxDetail | Model | Optional | Expand Read a bill — response body — Bill Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored. |
Referenced models: Read a bill — response body — Bill Currency Ref, Read an invoice — response body — Invoice Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num, Read a journalentry — response body — Journal Entry Line item Amount, Custom Extensions, Description, Detail Type, Id, Journal Entry Line Detail, Line Num, Project Ref, Read a bill — response body — Bill Meta Data, Read an item — response body — Item Class Ref, Read a bill — response body — Bill Txn Tax Detail