quickbooks-api/src/types/interfaces/txn-tax-detail.ts

A modular TypeScript SDK for seamless integration with Intuit QuickBooks APIs. Provides robust authentication handling and future-ready foundation for accounting, payments, and commerce operations.

// Imports
import { ReferenceType, TaxLine } from '../types';

/**
 * TxnTaxDetail
 *
 * @description The tax detail for the transaction
 */
export interface TxnTaxDetail {
	/**
	 * @description Query the TaxCode name list resource to determine the appropriate TaxCode object.
	 * - Use TaxCode.Id for TaxCodeRef.value
	 * - Use TaxCode.Name for TaxCodeRef.name
	 * - Ignored if sales tax is disabled (Preferences.TaxPrefs.UsingSalesTax = false)
	 * - For sales transactions: Replaced by automated sales tax engine if PartnerTaxEnabled = true
	 */
	TxnTaxCodeRef?: ReferenceType;

	/**
	 * @description Total tax calculated for the transaction, excluding any manually inserted tax lines
	 */
	TotalTax?: number;

	/**
	 * @see TaxLine for child attributes
	 */
	TaxLine?: Array<TaxLine>;
}