Skip to content

QuickBooks: Create a recurring transaction — request body — body Journal Entry

Create a recurring transaction: request body, field body / JournalEntry. Complete fields and constraints for contract 2026-10-20.

API reference · Contract 2026-10-20

SDK schema: Create a recurring transaction — request body — body Journal Entry

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
AdjustmentJSONOptionalIndicates whether this transaction is a journal entry adjustment.
Adjustment (anyOf 1)booleanAlternative
Adjustment (anyOf 2)stringAlternativeOne of: true, false
CurrencyRefModelOptionalExpand Create a bill — request body — body 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
DocNumberstringOptionalReference 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
ExchangeRateJSONOptionalThe 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)numberAlternative
ExchangeRate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?$
GlobalTaxCalculationstringOptionalMethod in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive . Not applicable to US companies; required for non-US companies.
Conditionally required
HomeTotalAmtJSONOptionalThe 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)numberAlternative
HomeTotalAmt (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?$
IdstringOptionalUnique identifier for this object.
Read only: true
LinearrayOptionalIndividual 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[]JSONEach item
Line[] (anyOf 1)ModelAlternativeExpand Create a journalentry — request body — body Line item
Line[] (anyOf 2)ModelAlternativeExpand Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num
MetaDataModelOptionalExpand 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.
PrivateNotestringOptionalUser entered, organization-private note about the transaction.
RecurDataRefModelOptionalExpand Create a purchase order — request body — body Ship To
A reference to the Recurring Transaction. It captures what recurring transaction template the JournalEntry was created from.
Read only: true
SyncTokenstringOptionalVersion 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
TaxRateRefModelOptionalExpand Create a purchase order — request body — body Ship To
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.
TotalAmtJSONOptionalThe 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)numberAlternative
TotalAmt (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?$
TxnDatestringOptionalThe 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.
TxnTaxDetailModelOptionalExpand Create a bill — request body — body 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.
RecurringInfoModelRequired within parentExpand Create a recurring transaction — request body — body Bill Recurring Info

Referenced models: Read a bill — response body — Bill Meta Data, Create a bill — request body — body Currency Ref, Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num, Create a journalentry — request body — body Line item, Create a recurring transaction — request body — body Bill Recurring Info, Create a purchase order — request body — body Ship To, Create a bill — request body — body Txn Tax Detail

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.