quickbooks-api/src/types/interfaces/custom-field.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 { CustomFieldType } from '../types';

/**
 * CustomField
 *
 * @description Custom field for the invoice
 */
export interface CustomField {
	/**
	 * Unique identifier of the CustomFieldDefinition that corresponds to this CustomField
	 * @readonly
	 */
	DefinitionId: string;

	/**
	 * The value for the StringType custom field
	 */
	StringValue?: string;

	/**
	 * Name of the custom field
	 * @readonly
	 */
	Name?: string;

	/**
	 * Data type of custom field
	 * @readonly
	 * @description Only one type is currently supported: StringType
	 */
	Type?: CustomFieldType;
}