Custom Transaction Body and Sublist Fields

When you work with custom transactions, the available fields vary depending on the transaction type, the features enabled in your account, and other factors. As a best practice, view the entry form for the transaction instance in the UI to see which fields are available. Alternatively, you can open the transaction type for editing.

The following factors affect field availability:

Depending on the custom transaction type’s configuration, the class, department, and location fields may or may not be available. Similarly, these fields can be configured to appear on either the transaction body or Lines sublist. For details on these configuration choices, see Custom Transaction Type Classification Fields.
The transaction type may or may not be configured to use the Status field. You can interact with the Status field only if statuses exist, and only if the Show Status Field option has been selected for the custom transaction type. When the field is available, you can import a status by referencing the status’s ID. You can view the ID value on the transaction type’s Statuses sublist. Note that the ID value is always a letter value between A and Z. Map the ID to the recordRef’s internal ID field. For an example, see Example of Adding an Instance of a Journal Custom Transaction Type.
Different custom transaction types can be configured to use different custom fields. For details on custom field usage, see Custom Fields in Custom Transaction Types.
A custom transaction type can have any of three list styles. The list style has an impact on whether the Lines sublist is available and how you use the sublist. For more details, see How List Styles Affect Your Integration.
The Lines sublist is keyed. You can use Line number as the key. Note that this behavior differs from CSV Import, where you can also use Account as a key, if every line has a unique account value. In SOAP web services, you can use only the Line number as the key.
The accountingBookDetailList sublist is usable only when the Multi-Book Accounting feature is enabled, and only when more than one active accounting book exists. This sublist is keyed. The key is the accountingBook value.
The subsidiary field is available only for OneWorld accounts.

Note:

For full details about all fields exposed as part of the CustomTransaction complex type, refer to the custom transaction reference page in the SOAP Schema Browser. For information about using the SOAP Schema Browser, see SOAP Schema Browser.

Related Topics