Journal Entry Body and Sublist Fields

Be aware that the way you interact with certain fields varies depending on whether the journal entry is book specific. For more information, see the following sections:

Body Fields
Sublist Fields

Note:

For a full list of available fields, refer to the journal entry reference page in the SOAP Schema Browser. For information on using the SOAP Schema Browser, see SOAP Schema Browser.

Body Fields

The following table describes several key fields on the journal entry record. The way you use these fields varies depending on whether the journal entry is book specific. The guidance in this table assumes that you are adding a new journal entry record.

Field	Label in UI	If you want to create a regular journal entry (not book specific)	If you want to create a book specific journal entry
accountingBook	Accounting Book	Do not use this field. Using this field automatically makes the journal entry book specific.	Name the accounting book that this journal entry is for.
currency	Currency	Valid values include any currency defined for your account at Lists > Accounting > Currencies.	Do not set a value for this field. The system automatically chooses the correct value. This choice is based on the combination of two values on the body of the book specific journal entry record: accountingBook subsidiary The currency value is defined on the Currencies sublist of the accounting book record.
exchangeRate	Exchange Rate	This field reflects the exchange rate between: The value in the journal entry’s currency field. The base currency for the subsidiary named in the journal entry’s subsidiary field. You can leave this field empty to let the system fill in the value, or you can specify an exchange rate.	This value is always 1.0. If you try to set a value for this field, your input is ignored. This is because the currency for the entry must be the default used for this combination of accounting book and subsidiary. It cannot be a different currency that requires conversion.
isBookSpecific	This field is hidden in the UI.	Omit a value for this field. The system will automatically assign this field the correct value. (The correct value in this case is false.)	If you are actively setting a value for the accountingBook field, you can omit a value for isBookSpecific. The system will automatically assign this field the correct value. (The correct value in this case is true.) As an alternative, you can set isBookSpecific to true and omit a value for accounting book. This approach creates a book specific journal entry for the primary accounting book.
memo	Memo	This field is available only with the 2015.2 WSDL and later. By contrast, the Memo field from the Lines sublist is available in all supported WSDLs.
subsidiary	Subsidiary	Choose one of your account’s subsidiaries (listed at Setup > Company > Subsidiaries).	Valid values for subsidiary are determined by the value of the accountingBook field. You can choose only subsidiaries that are listed on the Currencies subtab of the selected accounting book record.

Field

Label in UI

If you want to create a regular journal entry (not book specific)

If you want to create a book specific journal entry

accountingBook

Accounting Book

Do not use this field. Using this field automatically makes the journal entry book specific.

Name the accounting book that this journal entry is for.

currency

Currency

Valid values include any currency defined for your account at Lists > Accounting > Currencies.

Do not set a value for this field. The system automatically chooses the correct value. This choice is based on the combination of two values on the body of the book specific journal entry record:

accountingBook
subsidiary

The currency value is defined on the Currencies sublist of the accounting book record.

exchangeRate

Exchange Rate

This field reflects the exchange rate between:

The value in the journal entry’s currency field.
The base currency for the subsidiary named in the journal entry’s subsidiary field.

You can leave this field empty to let the system fill in the value, or you can specify an exchange rate.

This value is always 1.0. If you try to set a value for this field, your input is ignored. This is because the currency for the entry must be the default used for this combination of accounting book and subsidiary. It cannot be a different currency that requires conversion.

isBookSpecific

This field is hidden in the UI.

Omit a value for this field. The system will automatically assign this field the correct value. (The correct value in this case is false.)

If you are actively setting a value for the accountingBook field, you can omit a value for isBookSpecific. The system will automatically assign this field the correct value. (The correct value in this case is true.)

As an alternative, you can set isBookSpecific to true and omit a value for accounting book. This approach creates a book specific journal entry for the primary accounting book.

memo

Memo

This field is available only with the 2015.2 WSDL and later. By contrast, the Memo field from the Lines sublist is available in all supported WSDLs.

subsidiary

Subsidiary

Choose one of your account’s subsidiaries (listed at Setup > Company > Subsidiaries).

Valid values for subsidiary are determined by the value of the accountingBook field. You can choose only subsidiaries that are listed on the Currencies subtab of the selected accounting book record.

Sublist Fields

The line sublist is the main sublist on the record. It is used to record credits and debits. Every journal entry must have at least two lines in the line sublist: one credit and one debit. The total value of credits must equal the total value of debits.

Note:

As of the 2016.1 WSDL, another sublist, the accountingBookDetailList, is also exposed to SOAP web services. This sublist is relevant only if you use the Multi-Book Accounting feature. For details on this sublist, see the SOAP Schema Browser’s accountingBookDetailList reference page.

Revenue Recognition Fields

Several fields on the line sublist are used only when the Revenue Recognition feature is enabled. Further, these fields are used only for journal entries that are not book specific.

These fields include the following:

endDate
residual
schedule
startDate

Maximum Number of Lines

You must have at least two line items to submit a journal entry transaction. The maximum number of lines per journal entry is 1,000 when using synchronous SOAP web services processing. With asynchronous SOAP web services processing, the limit is 10,000 lines. If your import includes journal entries with more than 1,000 lines, CSV import can also serve as an alternative. For journal entry transactions submitted through CSV import, the limit is 10,000 lines per transaction.

Body Fields

Sublist Fields

Revenue Recognition Fields

Maximum Number of Lines

Related Topics