Oracle NetSuite Connector Objects (SuiteQL Schema)

Objects Supported 

NameDescription
accountThe Account table stores financial account details, including general ledger accounts used for recording transactions.
AccountContextSearchThe AccountContextSearch table facilitates account searches within specific contexts, aiding in financial reporting and reconciliation.
accountingbookThe AccountingBook table defines different sets of books used for financial reporting, supporting multiple accounting standards and compliance requirements.
accountingcontextThe AccountingContext table manages contextual settings for financial transactions, enabling reporting consistency across various accounting frameworks.
accountingperiodThe AccountingPeriod table defines fiscal periods used for financial reporting, including start and end dates, and period statuses.
accountingperiodfiscalcalendarsThe AccountingPeriodFiscalCalendars table establishes relationships between accounting periods and fiscal calendars to ensure accurate period-based reporting.
accountLocalizationThe AccountLocalization table stores localized financial account settings, ensuring compliance with regional accounting regulations.
AccountSubsidiaryMapThe AccountSubsidiaryMap table maps financial accounts to specific subsidiaries, allowing for accurate financial tracking within multi-entity organizations.
accountTypeThe AccountType table categorizes accounts based on financial classification, such as assets, liabilities, income, and expenses.
activityA table that captures user and system-generated activities in NetSuite, including task assignments, calls, events, and follow-ups. This table supports audit trails, calendar integration, and activity-based workflows across customer relationship management (CRM) and project management modules.
addressThe Address table stores address details for entities such as customers, vendors, employees, and subsidiaries, supporting mailing and billing operations.
addressTypeThe AddressType table defines different address classifications, such as shipping, billing, and residential, for proper usage in transactions and communications.
AdmissibilityPackageTypeThe AdmissibilityPackageType table categorizes package types for customs and regulatory compliance in international shipping and trade.
advintercompanyjournalentryThe AdvInterCompanyJournalEntry table manages advanced intercompany journal entries, facilitating financial adjustments between subsidiaries.
aggregateItemLocationThe AggregateItemLocation table consolidates item availability data across multiple locations to support inventory planning and fulfillment processes.
alignOrHideThe AlignOrHide table stores UI configuration settings related to alignment and visibility of fields in forms and reports.
allocationDetailThe AllocationDetail table contains detailed records of financial allocations, specifying amounts and distribution methods across accounts.
allocationDetailJournalMapThe AllocationDetailJournalMap table links allocation details to journal entries, ensuring accurate financial tracking and reporting.
AllocationMethodThe AllocationMethod table defines different methods used for financial allocations, such as fixed percentages or dynamic calculations.
allocationscheduleThe AllocationSchedule table manages predefined schedules for financial allocations, ensuring consistent cost distribution over time.
allocationScheduleAllocationDetailThe AllocationScheduleAllocationDetail table links allocation schedules to their corresponding detailed allocation records.
allocationScheduleAllocationDetailGeneralDetailDestinationThe AllocationScheduleAllocationDetailGeneralDetailDestination table defines the destination accounts for financial allocations within scheduled transactions.
allocationScheduleAllocationDetailGeneralDetailSourceThe AllocationScheduleAllocationDetailGeneralDetailSource table defines the source accounts for financial allocations within scheduled transactions.
allocationScheduleAllocationDetailJournalMapThe AllocationScheduleAllocationDetailJournalMap table maps allocation schedule details to journal entries for proper financial reconciliation.
AllocationScheduleDestinationThe AllocationScheduleDestination table specifies the destination financial entities or accounts for scheduled allocations.
AllocationScheduleSourceThe AllocationScheduleSource table defines the originating financial accounts or cost centers for scheduled allocations.
amortizationscheduleThe AmortizationSchedule table outlines the periodic allocation of expenses related to prepaid assets, ensuring accurate financial reporting.
amortizationtemplateThe AmortizationTemplate table stores predefined amortization rules and templates used for expense recognition over time.
AmortizationTypeThe AmortizationType table categorizes different amortization methods, such as straight-line or declining balance, for financial planning and reporting.
ApplicabilityModeTypeThe ApplicabilityModeType table defines various applicability modes used in system processes, determining how specific rules or configurations apply to transactions.
ApplicabilityReasonTypeThe ApplicabilityReasonType table categorizes different reasons for applicability settings, ensuring clarity in compliance and business logic.
ApplicabilityStatusTypeThe ApplicabilityStatusType table tracks the status of applicability settings, indicating whether a particular rule or condition is active, inactive, or pending.
applyDiscountToThe ApplyDiscountTo table specifies the targets of discount applications, such as specific items, orders, or customer groups.
ApprovalStatusThe ApprovalStatus table maintains records of approval states for transactions, indicating whether they are pending, approved, or rejected.
assemblybuildThe AssemblyBuild table stores records of assembly builds, tracking the conversion of components into finished goods through the production process.
assemblyitemThe AssemblyItem table contains information about assembly items, which are manufactured products composed of multiple components.
assemblyitembomA table that stores Bill of Materials (BOM) configurations specifically for assembly items in NetSuite. This includes component relationships, quantity requirements, and structure definitions essential for manufacturing and inventory planning processes.
assemblyItemCorrelateditemThe AssemblyItemCorrelatedItem table maintains relationships between related assembly items, aiding in recommendations and alternate selections.
assemblyItemItemAccountingBookDetailThe AssemblyItemItemAccountingBookDetail table stores financial details of assembly items across different accounting books, ensuring compliance with multiple financial reporting standards.
assemblyItemItemQuantityPricingDiscountThe AssemblyItemItemQuantityPricingDiscount table tracks volume-based discount structures for assembly items, defining how pricing changes with quantity breaks.
assemblyItemItemQuantityPricingLevelThe AssemblyItemItemQuantityPricingLevel table stores pricing levels based on quantity tiers, ensuring accurate discount application for bulk purchases.
assemblyItemItemVendorThe AssemblyItemItemVendor table manages vendor relationships for assembly items, recording preferred suppliers, cost structures, and sourcing details.
assemblyItemLocationsThe AssemblyItemLocations table tracks the availability of assembly items across different inventory locations, aiding in logistics and stock planning.
assemblyItemMemberThe AssemblyItemMember table defines the individual components that make up an assembly item, specifying quantities and roles within the finished product.
assemblyItemPresentationItemThe AssemblyItemPresentationItem table manages presentation-related configurations for assembly items, such as catalog display and marketing attributes.
assemblyItemPriceThe AssemblyItemPrice table stores price data for assembly items, including standard pricing, currency-specific rates, and promotional discounts.
assemblyItemQuantityThe AssemblyItemQuantity table maintains records of stock levels for assembly items, ensuring accurate inventory tracking and replenishment planning.
assemblyItemSiteCategoryThe AssemblyItemSiteCategory table categorizes assembly items for e-commerce and internal classification, optimizing searchability and organization.
assemblyItemSubsidiaryMapThe AssemblyItemSubsidiaryMap table links assembly items to specific subsidiaries, supporting multi-entity financial tracking and reporting.
assemblyItemTranslationThe AssemblyItemTranslation table stores localized descriptions and attributes for assembly items, enabling multilingual support in global operations.
assemblyunbuildThe AssemblyUnbuild table tracks the process of disassembling finished goods back into their component parts, used in reverse logistics or returns.
ATPMethodTypeThe ATPMethodType table defines available-to-promise (ATP) calculation methods, determining how inventory commitments are assessed based on supply and demand.
AttendeeThe Attendee table records participants in events, meetings, and training sessions, tracking attendance and engagement details.
audienceDepartmentMapThe AudienceDepartmentMap table links specific user audiences to departments, controlling access to resources and reports based on organizational structure.
audienceDepartmentMapClientThe AudienceDepartmentMapClient table assigns client-side applications to department-based audiences, managing visibility and permissions.
audienceDepartmentMapMassUpdateThe AudienceDepartmentMapMassUpdate table enables bulk updates of audience-to-department mappings, streamlining administrative changes.
audienceDepartmentMapPortletThe AudienceDepartmentMapPortlet table manages access to portlets (dashboard widgets) based on department-specific audience assignments.
audienceDepartmentMapRestletThe AudienceDepartmentMapRestlet table defines department-based access controls for RESTlet scripts, ensuring secure API interactions.
audienceDepartmentMapSuiteletThe AudienceDepartmentMapSuitelet table governs access to Suitelet applications based on department-specific audience configurations.
audienceDepartmentMapUserEventThe AudienceDepartmentMapUserEvent table links user events to specific departments, ensuring that event-driven actions are restricted to designated organizational units.
audienceDepartmentMapWorkflowThe AudienceDepartmentMapWorkflow table associates workflows with specific departments, controlling access and execution based on departmental structures.
audienceEmployeeMapThe AudienceEmployeeMap table defines relationships between employees and designated system audiences, determining visibility and access control.
audienceEmployeeMapClientThe AudienceEmployeeMapClient table assigns employee-based audience settings for client-side applications, managing personalized user experiences.
audienceEmployeeMapMassUpdateThe AudienceEmployeeMapMassUpdate table enables bulk updates to employee-audience associations, streamlining administrative tasks.
audienceEmployeeMapPortletThe AudienceEmployeeMapPortlet table controls employee-based access to specific dashboard portlets, managing visibility and customization.
audienceEmployeeMapRestletThe AudienceEmployeeMapRestlet table governs API access for employees interacting with RESTlet scripts, ensuring appropriate permissions.
audienceEmployeeMapSuiteletThe AudienceEmployeeMapSuitelet table manages employee-based permissions for Suitelet applications, defining access rules.
audienceEmployeeMapUserEventThe AudienceEmployeeMapUserEvent table regulates user event triggers based on employee audience assignments, enforcing access controls.
audienceEmployeeMapWorkflowThe AudienceEmployeeMapWorkflow table assigns workflows to employee-specific audiences, ensuring role-based process automation.
audienceGroupMapThe AudienceGroupMap table maintains mappings between user groups and audience settings, facilitating group-based access management.
audienceGroupMapClientThe AudienceGroupMapClient table controls group-based access to client-side applications, ensuring personalized and role-based interactions.
audienceGroupMapMassUpdateThe AudienceGroupMapMassUpdate table supports batch updates to group-audience assignments, streamlining administration.
audienceGroupMapPortletThe AudienceGroupMapPortlet table determines group-based visibility for dashboard portlets, managing UI customization.
audienceGroupMapRestletThe AudienceGroupMapRestlet table assigns RESTlet script access based on group-audience mappings, securing API interactions.
audienceGroupMapSuiteletThe AudienceGroupMapSuitelet table defines group-based permissions for Suitelet applications, ensuring appropriate access levels.
audienceGroupMapUserEventThe AudienceGroupMapUserEvent table links user events to specific user groups, regulating event-driven actions.
audienceGroupMapWorkflowThe AudienceGroupMapWorkflow table maps workflows to user groups, enabling role-based workflow execution.
audiencePartnerMapThe AudiencePartnerMap table maintains mappings between partners and audience configurations, controlling partner-level access.
audiencePartnerMapClientThe AudiencePartnerMapClient table manages partner-specific access to client-side applications, personalizing interactions.
audiencePartnerMapMassUpdateThe AudiencePartnerMapMassUpdate table enables mass updates to partner-audience mappings, simplifying administrative tasks.
audiencePartnerMapPortletThe AudiencePartnerMapPortlet table controls partner access to dashboard portlets, ensuring appropriate UI configurations.
audiencePartnerMapRestletThe AudiencePartnerMapRestlet table defines partner-specific access rules for RESTlet API interactions, securing partner data exchanges.
audiencePartnerMapSuiteletThe AudiencePartnerMapSuitelet table assigns Suitelet permissions to partners, regulating access to customized applications.
audiencePartnerMapUserEventThe AudiencePartnerMapUserEvent table links user events to partners, ensuring event-triggered actions follow partner-based access rules.
audiencePartnerMapWorkflowThe AudiencePartnerMapWorkflow table regulates workflow assignments based on partner-specific audience settings.
audienceRoleMapThe AudienceRoleMap table maintains mappings between system roles and audience configurations, ensuring role-based access control.
audienceRoleMapClientThe AudienceRoleMapClient table assigns client-side application access based on user roles, managing UI interactions.
audienceRoleMapMassUpdateThe AudienceRoleMapMassUpdate table allows for bulk updates to role-based audience assignments, improving administrative efficiency.
audienceRoleMapPortletThe AudienceRoleMapPortlet table controls role-based access to dashboard portlets, ensuring appropriate UI visibility.
audienceRoleMapRestletThe AudienceRoleMapRestlet table defines role-specific access permissions for RESTlet scripts, securing API interactions.
audienceRoleMapSuiteletThe AudienceRoleMapSuitelet table governs access to Suitelet applications based on assigned user roles.
audienceRoleMapUserEventThe AudienceRoleMapUserEvent table links user events to roles, enabling event-driven actions based on assigned permissions.
audienceRoleMapWorkflowThe AudienceRoleMapWorkflow table manages workflow execution based on system roles, ensuring process automation aligns with permissions.
audienceSubsidiaryMapThe AudienceSubsidiaryMap table defines mappings between subsidiaries and audience configurations, regulating subsidiary-level access.
audienceSubsidiaryMapClientThe AudienceSubsidiaryMapClient table assigns client-side application access based on subsidiary-level audience settings.
audienceSubsidiaryMapMassUpdateThe AudienceSubsidiaryMapMassUpdate table facilitates mass updates to subsidiary-based audience mappings.
audienceSubsidiaryMapPortletThe AudienceSubsidiaryMapPortlet table controls subsidiary-based access to dashboard portlets, managing UI customization.
audienceSubsidiaryMapRestletThe AudienceSubsidiaryMapRestlet table governs subsidiary-based access rules for RESTlet API interactions.
audienceSubsidiaryMapSuiteletThe AudienceSubsidiaryMapSuitelet table assigns Suitelet application permissions based on subsidiary-level audience settings.
audienceSubsidiaryMapUserEventThe AudienceSubsidiaryMapUserEvent table links user events to subsidiaries, ensuring event-driven actions align with subsidiary-based access rules.
audienceSubsidiaryMapWorkflowThe AudienceSubsidiaryMapWorkflow table maps workflow execution to subsidiary-level audience configurations.
AuthenticateDeviceInputThe AuthenticateDeviceInput table stores authentication request data for device verification processes, ensuring secure user logins.
AuthenticateDeviceResultThe AuthenticateDeviceResult table records the outcomes of device authentication attempts, including success or failure details.
AuthenticationFieldThe AuthenticationField table defines security-related data fields used in authentication processes, ensuring standardized credential validation.
automatedclearinghouseThe AutomatedClearingHouse table manages electronic funds transfer (EFT) transactions, facilitating ACH payments and settlements.
balancetrxbysegmentsStores balance transaction data segmented by specific financial criteria such as department, location, and class.
billingaccountRepresents customer billing accounts, tracking payments, invoices, and account balances.
billingclassDefines different billing classifications used for grouping and managing billing transactions.
billingClassPriceCostStores pricing and cost information associated with different billing classes.
BillingMilestoneTracks key milestones for billing events, such as installment due dates or progress-based payments.
billingratecardContains details about predefined billing rates for services, resources, or products.
BillingRateCardPriceMultiForSearchProvides multi-level search functionality for pricing data within billing rate cards.
BillingRateCardVersionMaintains different versions of billing rate cards to support rate updates and historical pricing.
billingrevenueeventLogs revenue recognition events related to billing transactions, ensuring compliance with revenue accounting standards.
billingscheduleDefines billing schedules for customers, contracts, or projects, outlining invoice generation timelines.
billingScheduleMilestoneStores milestone-based billing schedules that trigger invoices upon reaching predefined conditions.
billingScheduleRecurrenceManages recurring billing schedules for subscriptions, leases, and installment payments.
billingScheduleRecurrencePatternDefines the recurrence patterns for billing schedules, such as monthly, quarterly, or annually.
BillingScheduleTypeCategorizes billing schedules based on frequency, milestone triggers, or contractual obligations.
billOfDistributionStores distribution plans for inventory or resources, outlining how goods are allocated across locations.
billOfDistributionDistributionSourceTracks the sources from which distributed inventory or resources originate.
BillVarianceStatusCaptures variances in billing amounts due to changes in contract terms, pricing adjustments, or errors.
binRepresents physical storage locations within a warehouse or inventory management system.
bintransferLogs the movement of inventory items between different storage bins within a warehouse.
binworksheetUsed to track and manage bin-level inventory adjustments and cycle counting.
blanketpurchaseorderStores details of blanket purchase orders, allowing businesses to pre-authorize multiple purchases with a vendor over time.
blanketPurchaseOrderExpenseMachineTracks expense allocation and categorization for blanket purchase orders.
bomMaintains Bill of Materials (BOM) information, detailing component requirements for manufacturing processes.
bomAssemblyLinks bill of materials (BOM) records to assembly processes, defining the materials required for product assembly.
bomrevisionStores historical and current revisions of the bill of materials (BOM), supporting engineering change management.
bomrevisioncomponentTracks specific component changes across different bill of materials (BOM) revisions.
bonusRecords employee or sales representative bonuses based on performance metrics or predefined criteria.
bonustypeDefines different types of bonuses, such as commission-based, milestone-based, or annual bonuses.
budgetcategoryClassifies budget entries into categories for better financial planning and expense tracking.
budgetexchangerateManages exchange rates applied to budget calculations in multi-currency environments.
budgetimportFacilitates the import of budget data from external sources into NetSuite.
budgetlegacyStores historical budget records from legacy financial systems or prior fiscal years.
budgetsContains overall budget data for departments, projects, or business units.
budgetsMachineAutomates the budget allocation process based on predefined rules or machine-learning insights.
bulkownershiptransferManages the mass transfer of ownership for assets, accounts, or transactions.
bundleinstallationscriptLogs scripts used for deploying software bundles and system configurations in NetSuite.
BusinessEventHandlerCaptures business event triggers and associated actions, such as automated workflows or notifications.
BusinessEventHandlerFeedDetailTypeDefines the structure and data format of event feeds generated by business event handlers.
BusinessEventHandlerFeedStatusMonitors the processing status of business event feeds, tracking success or failure.
BusinessEventTypeCategorizes different types of business events, such as sales transactions, inventory updates, or customer interactions.
buttonDefines UI buttons used within NetSuite scripts and custom applications.
CalculateDiscountTypeThis table defines the different types of discount calculations used within NetSuite. It outlines how discounts are applied to transactions, including conditions and rules.
calendareventStores details about events scheduled in the calendar, such as meeting times, event types, and associated tasks or reminders for users.
campaignTracks information related to marketing campaigns, including the campaign's name, target audience, start and end dates, and overall goals.
campaigneventContains data related to specific events that are part of a larger campaign, such as webinars, promotional events, or marketing meetings.
campaignEventResponseStores the responses received from recipients who participated in a campaign event, such as registrations, feedback, or other interactive actions.
campaignresponseHolds detailed records of all responses from participants in a campaign, tracking their engagement with the event or campaign content.
campaignResponseHistoryEntryTracks historical changes to campaign responses, allowing users to see how interactions with campaigns evolve over time.
campaigntemplateDefines templates for creating campaigns in NetSuite, ensuring consistency in campaign design and content by providing a standard structure.
CardholderAuthBillAddressContains billing address details associated with cardholder authentication during a transaction, ensuring the correct address is linked to the payment.
cardholderauthenticationRecords the authentication details for credit card transactions, including the status of the verification process and results of authentication checks.
CardholderAuthenticationEventLogs events related to the cardholder authentication process, tracking each step of the verification and authorization procedure for payments.
CardholderAuthenticationEventListHolds a list of events triggered during cardholder authentication, providing a detailed transaction history for security audits.
CardholderAuthenticationStatusStores the current status of cardholder authentication for transactions, allowing for tracking of successful or failed verifications.
CardholderAuthShipAddressContains shipping address details related to cardholder authentication, ensuring that the address used during payment is correctly verified.
CartSortOrderDefines the sorting order for items in the shopping cart, helping to manage product display and arrangement for customer transactions.
cashrefundTracks cash refunds issued to customers, including the amount, reason for the refund, and associated transaction details.
cashRefundBillingAddressContains billing address details for cash refunds, ensuring that the refund is processed to the correct customer account.
cashRefundPartnerStores information about the partner associated with a cash refund, often used in commission or partnership-based systems.
cashRefundSalesTeamRecords the sales team responsible for a cash refund transaction, ensuring proper attribution for sales performance.
cashRefundShippingAddressContains shipping address information for cash refunds, ensuring accurate delivery and processing of refund-related shipments.
cashRefundTranPromotionTracks promotions applied to cash refund transactions, ensuring that refunds are aligned with marketing or discount offers.
cashsaleStores records for cash sales transactions, including item details, prices, and associated payment methods.
cashSaleBillingAddressContains billing address details for cash sales, ensuring proper invoicing and account tracking for customers.
cashSaleGiftCertRedemptionTracks the redemption of gift certificates during cash sales, ensuring the value of the certificate is properly applied to the transaction.
cashSaleItemShippingAddressStores shipping address information for individual items in a cash sale, useful for managing multi-shipment sales.
cashSalePartnerRecords the partner involved in a cash sale, often used for commission tracking or partnership-related sales.
cashSaleSalesTeamContains information about the sales team responsible for a particular cash sale, aiding in performance tracking.
cashSaleShippingAddressTracks the shipping address for cash sales, ensuring that the correct address is used for delivery.
cashSaleTrackingNumberMapMaps tracking numbers to cash sale transactions, allowing users to track the delivery of products sold.
cashSaleTranPromotionStores information about promotions applied to cash sale transactions, ensuring the correct discount or offer is applied during checkout.
category1099miscTracks categories for 1099-MISC reporting in compliance with tax regulations, categorizing payments to vendors and contractors.
CcBccRecipientStores the recipients of carbon copied (CCed) and blind carbon copied (BCCed) emails for communications sent through the system, allowing for tracking of all email recipients.
CenterTypeDefines the types of centers (for example, warehouse, office) within the system, supporting inventory and resource management.
ChallengeShopperInputStores the input data related to challenge shoppers, often used for security or verification purposes in transactions.
ChallengeShopperResultRecords the results of challenge shopper interactions, used for fraud prevention and ensuring compliance with security protocols.
ChallengeWindowSizeTracks the window size used for challenge shopper verifications, ensuring proper parameters are applied during authentication.
chargeContains information about charges, including transaction details, amounts, and applicable fees for customer transactions.
ChargebillingmodetypeDefines the billing modes for charges, allowing for different payment terms, such as one-time payments or recurring billing.
chargeruleStores rules governing how charges are applied, including conditions for discounts, taxes, and charge modifications.
ChargeRunRecords details of charge runs, which group and apply charges based on predefined criteria, such as date ranges or billing cycles.
ChargestagetypeDefines the different types of charge stages, such as pending, completed, or failed, allowing for tracking of charge statuses.
chargeTypeContains information about the different types of charges, helping classify and manage how charges are processed in the system.
chargeTypeTranslationsStores translations for charge types, enabling multi-language support for international transactions.
ChargeuseDefines the uses for different charges, ensuring charges are applied appropriately based on the type of transaction or service.
checkTracks details of checks issued in payments, including amounts, payee information, and related bank accounts.
CheckExpenseMachineStores information on checks related to expense machines, used for automating payments in specific business processes.
checkPayeeAddressContains the payee address information for checks, ensuring accurate delivery and handling of physical payments.
classificationDefines the classification system used for categorizing different records within the platform, such as customer types or item categories.
clientscriptStores client-side script details used for customizing user interfaces and interactions within NetSuite.
cmscontentTracks content related to the Content Management System (CMS) in NetSuite, allowing for dynamic content management across websites.
cmscontenttypeDefines the different types of content managed within the Content Management System (CMS), supporting categorization and organization of digital assets.
cmspageStores information about Content Management System (CMS) pages, such as their layout, content, and associated metadata, used for website management.
commercecategoryOrganizes items into categories for easier navigation and search within the NetSuite Commerce platform.
CommissionPaymentTypeDefines the types of commission payments, such as percentage-based or flat-rate, for sales team members.
CompanyAddressbookStores address information for companies, helping manage billing, shipping, and contact details for business accounts.
CompanyAddressbookEntityAddressLinks company address book entries to entities, enabling precise tracking of locations associated with a company.
CompanyBulkMergeFacilitates bulk merging of company records in NetSuite, helping to consolidate duplicate entries for better data management.
CompanyCampaignsLinks companies to specific campaigns, helping track campaign performance and engagement by company.
CompanyCompanyContactStores contact information for companies, allowing for efficient management of company-specific contacts and relationships.
competitorStores competitor information, including industry, strengths, weaknesses, and competitive positioning.
CompetitorOpportunityTracks opportunities where competitors are involved, helping assess the competitive landscape and identify strategic gaps.
consolidatedexchangerateStores consolidated exchange rate information for multiple currencies, helping facilitate global financial reporting.
ConsolidatedRateTypeDefines the different types of consolidated exchange rates used for various accounting purposes in global operations.
contactStores contact details for individuals, including names, roles, communication preferences, and associated accounts.
ContactAddressbookHolds contact address information for individuals, ensuring accurate billing and shipping details for each contact.
ContactAddressbookEntityAddressLinks contact address book entries to entities, ensuring precise address handling for each contact.
ContactBulkMergeFacilitates bulk merging of contact records in NetSuite, helping to clean up and consolidate duplicate contact information.
contactcategoryStores categories for organizing contacts, such as leads, customers, and partners, for better data management.
ContactContactCampaignsLinks contacts to specific campaigns, tracking their involvement and engagement with marketing activities.
ContactContactTypeMapMaps contacts to different types of relationships or roles within campaigns or sales, such as decision-makers or influencers.
contactroleDefines the roles contacts play within accounts or projects, such as primary contact, decision-maker, or support.
ContactSubscriptionMessageHistoryTracks the history of subscription messages sent to contacts, helping monitor engagement and communication history.
ContactSubscriptionsStores information about contact subscriptions, tracking preferences and the frequency of communications for each individual.
ContactSubsidiaryRelationshipTracks relationships between contacts and subsidiaries, allowing for proper segmentation and targeting in multi-subsidiary setups.
controlTowerSourceTypeDefines the different source types for control towers within NetSuite, used to classify and manage source data flows in complex business processes.
costcategoryStores categories for tracking and managing costs within the system, helping organizations classify and analyze expenses.
CostCategoryTypeDefines the various types of cost categories, such as fixed costs or variable costs, for more accurate cost tracking and reporting.
CostEstimateTypeContains information about different types of cost estimates used in NetSuite, including labor, material, and overhead estimates for projects.
CostingMethodTypeDefines the different costing methods, such as standard cost or actual cost, used for valuing inventory and determining the cost of goods sold.
couponcodeTracks coupon codes used in promotional campaigns, including details like discount value, validity period, and eligible products or services.
CreditCardChargeStores data related to credit card charges, including transaction amounts, processing status, and payment methods used for customer purchases.
CreditCardChargeExpenseMachineLinks credit card charges to expense machines, enabling automated allocation and management of payment transactions in business processes.
CreditCardRefundContains records of credit card refunds issued to customers, including amounts refunded, refund status, and associated transaction details.
CreditCardRefundExpenseMachineTracks credit card refund transactions linked to expense machines, enabling proper handling and reporting of returned payments.
CreditholdoverridetypeDefines different types of credit hold overrides, allowing businesses to manage exceptions to credit hold policies based on specific criteria.
creditmemoStores credit memo records, which are issued to customers when an amount is credited back to their account, often due to returns or billing errors.
creditMemoBillingAddressContains the billing address associated with credit memos, ensuring that the credit is applied to the correct customer account.
creditMemoItemShippingAddressStores the shipping address associated with items listed in a credit memo, used for returns or exchanges in physical transactions.
creditMemoPartnerLinks credit memos to specific partners, helping track commission or partnership-based credits issued to customers.
creditMemoSalesTeamStores information about the sales team associated with a credit memo, often used for commission tracking or sales performance evaluation.
creditMemoShipGroupOrganizes items from credit memos into shipping groups, allowing for easier management and processing of return shipments.
creditMemoShippingAddressContains the shipping address information for credit memos, used to direct returned goods or refunds to the correct location.
creditMemoTranPromotionTracks promotions applied to credit memo transactions, ensuring that discounts or special offers are properly applied during the refund process.
CrmTemplateTypeDefines different types of Customer Relationship Management (CRM) templates used within NetSuite for consistent and efficient Customer Relationship Management.
currencyStores information about the different currencies supported in NetSuite, including currency symbols, names, and exchange rate details.
currencyrateTracks exchange rates between different currencies, enabling accurate conversion for international transactions and financial reporting.
CurrencyRateTypeDefines different types of currency rates used within NetSuite, such as spot rates, historical rates, or forecast rates.
CurrencySymbolPlacementStores information about the placement of currency symbols in NetSuite, supporting global financial reporting with region-specific formats.
customerTracks detailed customer information, including contact details, account status, and transaction history for billing and Customer Relationship Management.
customerAddressbookHolds address records associated with customers, supporting accurate billing and shipping address management for transactions.
customerAddressbookEntityAddressLinks customer address book entries to specific entities, allowing for more granular tracking and management of customer addresses.
customerBulkMergeFacilitates the bulk merging of customer records, consolidating duplicate entries for more efficient data management and reporting.
customerCampaignsLinks customers to specific campaigns, helping track engagement and performance of marketing efforts targeted at individual customers.
customercategoryCategorizes customers based on various criteria, such as industry, size, or region, for easier segmentation and marketing.
customerCompanyContactLinks customers to specific company contacts, allowing for better organization of communication and relationship management.
customerContactRoleDefines the roles that contacts play within customer organizations, such as decision-maker, influencer, or support contact.
customerCurrencyBalanceTracks currency balances for customers, ensuring accurate reporting of outstanding amounts in different currencies.
customerdepositStores details of customer deposits, which are prepayments made by customers for future goods or services.
customerEftAcctHolds information about customer EFT (Electronic Funds Transfer) accounts, enabling seamless payments and transactions.
CustomerGroupPricingDefines pricing rules for customer groups, allowing businesses to apply special pricing based on customer classification or membership.
customerItemPricingTracks item-level pricing for customers, ensuring that products are sold at the correct price according to customer-specific agreements.
customermessageStores messages sent to customers, including notifications, alerts, and communications related to their account or transactions.
CustomerPartnerLinks customers to their associated partners, enabling better management of partnership relationships and sales performance.
customerpaymentRecords customer payments, including payment method, amount, and related transaction details, supporting accurate account management.
customerpaymentauthorizationTracks authorization details for customer payments, ensuring that payments are processed correctly and securely.
customerrefundRecords customer refunds, including refund amounts and reasons, to ensure proper accounting for returned goods or overpayments.
customerRefundPayeeAddressContains the payee address information for customer refunds, ensuring that refunds are sent to the correct address.
customerSalesTeamStores information about the sales team responsible for managing customer accounts, used for commission tracking and sales performance.
CustomerSegmentCustomerLinks customers to specific market segments, enabling targeted marketing and personalized sales strategies.
customerstatusTracks the status of customer accounts, such as active, inactive, or on hold, for better account management and reporting.
customerSubscriptionMessageHistoryStores historical records of messages sent to customers regarding their subscriptions, tracking communication efforts.
customerSubscriptionsTracks customer subscriptions, including subscription type, duration, and status, enabling efficient subscription management.
customersubsidiaryrelationshipManages the relationships between customers and subsidiaries, supporting multi-subsidiary operations and reporting.
CustomFieldDefines custom fields that can be added to records across NetSuite, allowing for personalized data capture and reporting.
CustomField2An extension of the CustomField table, offering additional custom fields for users to track unique data on records.
customInstallmentPercentTracks custom installment percentages for transactions, enabling flexible payment plans and installment management.
customlistStores custom lists created by users to categorize and organize records, such as specific item types or customer classifications.
customPluginTypesActionStores configurations for custom plugin actions, used to extend NetSuite functionality with customized processes and interactions.
customPluginTypesBundleInstallationDefines the installation settings for custom plugins within NetSuite bundles, ensuring proper deployment of custom features.
customPluginTypesMapReduceContains settings for Map/Reduce scripts used in custom plugins, enabling large-scale data processing within NetSuite.
customPluginTypesPortletStores configurations for custom portlets, allowing users to extend the NetSuite interface with custom widgets and tools.
customPluginTypesRestletDefines configurations for Restlet-based plugins, enabling external systems to interact with NetSuite via REST APIs.
customPluginTypesScheduledContains details for custom scheduled scripts, allowing users to automate processes and tasks on a recurring basis.
customPluginTypesSuiteletDefines Suitelet-based custom plugins, enabling the creation of custom pages and user interfaces within NetSuite.
customPluginTypesUserEventStores configurations for User Event scripts in custom plugins, enabling users to trigger specific actions based on record events.
custompurchaseTracks custom purchase records, including item details, suppliers, and purchase terms, tailored to specific business processes.
customrecordtypeDefines custom record types created by users, allowing for the storage of unique data not covered by standard NetSuite records.
customsaleStores custom sale records, enabling businesses to track non-standard sales transactions, including unique pricing or terms.
customsegmentDefines custom segments used to categorize data within NetSuite, such as sales regions, departments, or product types.
CustomTransactionTypeStores custom transaction types, allowing businesses to track and categorize transactions that don't fit into standard NetSuite categories.
DayOfWeekA table that stores information related to the days of the week, used for tracking and organizing time-based data such as scheduling or time reporting.
deletedrecordThis table tracks records that have been deleted, often used for auditing and recovery purposes to maintain a history of removed data.
departmentA table that contains details about the departments within an organization, used for categorizing and organizing personnel, expenses, and tasks.
departmentSubsidiaryMapThis table maps departments to subsidiaries, allowing for proper organizational structure and reporting across different company units.
deploymentsActionStores actions taken during deployments, used for tracking progress, execution steps, and managing the deployment lifecycle.
deploymentsBundleInstallationTracks bundle installations during deployments, helping to manage software packages and configuration updates in the system.
deploymentsClientContains data on clients associated with deployments, used for client-specific tracking and management of deployment activities.
deploymentsMapReduceTracks the MapReduce jobs related to deployments, used for processing large amounts of data in a distributed fashion within the deployment process.
deploymentsMassUpdateContains information on mass updates performed during deployments, used for tracking bulk data changes across systems.
deploymentsPortletStores data about portlets used during deployments, aiding in the configuration and management of dynamic content in user interfaces.
deploymentsRestletTracks Restlet endpoints used during deployments, allowing for integration between systems through RESTful APIs.
deploymentsScheduledContains data about scheduled deployments, used for planning and automating the timing of deployment tasks.
deploymentsScriptTracks scripts involved in deployments, used for automating processes and customizing system behavior during deployment events.
deploymentsSuiteletStores details about Suitelets used during deployments, which are custom UI pages built for specific business needs.
deploymentsUserEventContains information on user events triggered during deployments, enabling event-driven processes and custom user interaction during deployments.
depositThe deposit table tracks funds deposited into the system, used for managing cash flow and financial transactions.
depositapplicationTracks deposit applications, used to apply deposits against customer invoices or other accounts in the system.
descriptionitemContains items used in the system's product catalog or other descriptions, aiding in categorizing and managing inventory and services.
descriptionItemSubsidiaryMapMaps description items to subsidiaries, helping manage product availability and sales by subsidiary across multiple locations.
descriptionItemTranslationStores translations of description items for multi-lingual support, enabling businesses to present product information in various languages.
discountitemTracks discount items, used to apply specific discounts to products, services, or orders based on defined criteria.
discountItemSubsidiaryMapMaps discount items to subsidiaries, allowing businesses to apply different discount structures based on subsidiary or regional settings.
discountItemTranslationStores translations for discount items, enabling multi-lingual support for pricing and discounts in global markets.
distributionCategoryThe distribution category table classifies products or services for better inventory management and sales reporting.
distributionNetworkTracks distribution networks, used to manage the logistics and supply chain for delivering goods or services to customers.
distributionNetworkDistributionCategoryMaps distribution networks to distribution categories, facilitating efficient resource allocation and delivery management.
distributionnetworksubsidiaryMaps distribution networks to subsidiaries, helping manage regional supply chains and logistics.
downloaditemContains information on items available for download, typically used for tracking downloadable products or resources.
downloadItemCorrelateditemTracks items correlated with downloadable items, used for product bundles or related downloads.
downloadItemItemAccountingBookDetailStores detailed accounting data for downloadable items, used to manage financial tracking and reporting.
downloadItemItemQuantityPricingDiscountContains discount information related to downloadable items based on quantity purchased, helping manage pricing strategies.
downloadItemItemQuantityPricingLevelStores pricing levels for downloadable items based on quantity, used to set tiered pricing strategies.
downloadItemPresentationItemTracks presentation data for downloadable items, typically used to manage how items are displayed or presented in sales or marketing materials.
downloadItemPriceContains pricing details for downloadable items, enabling dynamic pricing and promotional offers.
downloadItemQuantityTracks the quantity of downloadable items available, helping manage inventory and stock levels.
downloadItemSiteCategoryMaps downloadable items to website categories, helping organize and display them on online platforms.
downloadItemSubsidiaryMapMaps downloadable items to subsidiaries, enabling location-specific offerings and pricing strategies.
downloadItemTranslationStores translations of downloadable item information for multi-lingual e-commerce and marketing.
EffectivityBasedOnTypeDefines the rules and criteria for product effectiveness, helping manage product availability based on conditions like time, location, or quantity.
EmailPreferenceTypeStores various email preference types, enabling customers to manage communication preferences with the business.
emailtemplateContains email templates used in system-generated communications, facilitating consistent messaging across different processes.
employeeTracks employee records, storing personal and professional details for HR, payroll, and management purposes.
employeeAccruedTimeStores data related to accrued time for employees, such as vacation or sick leave, to manage employee benefits.
employeeAddressbookContains employee address book entries, enabling communication and contact management for employees.
employeeAddressbookEntityAddressLinks employee address book entries to specific entity addresses, ensuring proper contact information is stored and accessible.
employeeBulkMergeHandles bulk merging of employee records, typically used for mass updates or corrections across employee databases.
employeeCampaignsTracks employee participation in campaigns or programs, enabling HR or marketing teams to manage internal initiatives.
employeechangerequestStores records of employee change requests, including role changes, benefit updates, or other HR-related modifications.
employeechangerequesttypeDefines the types of employee change requests, such as address updates, promotions, or compensation changes.
employeeCompanyContributionTracks contributions made by the company on behalf of employees, such as retirement or health benefits.
employeeDeductionStores information about employee deductions, such as taxes, insurance, or retirement contributions.
employeeEarningRecords employee earnings, including salary, bonuses, or commissions, used for payroll and tax purposes.
employeeEmergencyContactContains emergency contact information for employees, critical for HR and safety procedures.
employeeEmpPermsManages employee permissions, determining access levels to systems and resources based on role or department.
EmployeeExpenseReportCurrenciesTracks the currencies used in employee expense reports, allowing for multi-currency reporting and reimbursement.
employeeexpensesourcetypeDefines the types of sources from which employee expenses originate, such as travel, meals, or supplies.
EmployeeFilingStatusStores the filing status of employees for tax purposes, used in payroll calculations and benefits administration.
employeeHCMPositionTracks employee positions within the Human Capital Management (HCM) system, helping HR manage job titles and responsibilities.
employeeHrEducationContains records of employee educational backgrounds, used for HR and career development planning.
employeeListPresItemPresCategoryMaps employee list items to presentation categories, used for organizing and displaying employee-related information.
employeeListSiteCategoryTagSubstitutionMaps employee list items to site categories and tags, enabling dynamic content customization on employee-related webpages.
employeeListSiteCategoryTranslationEmployeeListStores translations of employee list items for multi-lingual websites or global employee directories.
employeerolesDefines employee roles within the organization, used to assign job responsibilities and manage access controls.
employeerolesforsearchHelps categorize employee roles for use in search functions, enabling more efficient querying of employee data based on role.
employeestatusStores the status of employees, such as 'Active', 'On Leave', or 'Inactive', to track employment conditions.
employeeSubscriptionMessageHistoryTracks messages sent to employees regarding subscriptions or benefits, helping HR manage employee communications.
employeeSubscriptionsContains records of employee subscriptions to various benefits, services, or company programs.
EmployeeSubsidiaryRelationshipMaps employees to subsidiaries, allowing for management of employee data across multiple company locations.
employeeTaxOptionsTracks the tax options chosen by employees, including exemptions, allowances, and deductions, used for payroll processing.
employeetypeDefines the types of employees, such as 'Full-Time', 'Part-Time', 'Contract', used for HR and payroll classifications.
entityContains information on entities such as customers, suppliers, or other business relationships in the system.
entityaccountmappingMaps entities to specific accounts, ensuring proper financial tracking and reporting across business relationships.
EntityAddressStores addresses related to entities, ensuring that customer, supplier, or other business location information is available for transactions.
entityAddressbookManages address book entries for entities, enabling streamlined communication and service delivery.
entityBulkMergeFacilitates the bulk merging of entity records, often used to clean up or consolidate data across entities.
entitygroupContains information on entity groups, used for organizing entities into specific categories for reporting or business purposes.
entityGroupBulkMergeHandles the bulk merging of entity groups, typically used for consolidating or updating group memberships.
entityGroupCampaignsTracks campaigns associated with entity groups, used to manage targeted marketing or outreach efforts.
entityGroupMemberMaps entities to group memberships, used to track and manage entities participating in specific groups.
entityGroupTypeDefines the types of entity groups, such as 'Customer Group', 'Supplier Group', or 'Employee Group', used for classification.
entityListTypeDefines the different types of entity lists, helping to organize and categorize entities for better management.
entityRateStores entity-specific rate information, used for tracking pricing or fee structures based on entity characteristics.
EntityStageDefines the various stages of an entity's lifecycle, such as 'Lead', 'Prospect', or 'Customer', used in sales and CRM processes.
EntityStatusTracks the current status of entities, such as 'Active', 'Inactive', or 'Prospective', used for reporting and management.
EntitySubsidiaryRelationshipMaps entities to subsidiaries, helping to manage operations and transactions across multiple company units.
estimateStores estimates for customer transactions, used for forecasting revenue and tracking pricing before final sale.
estimateBillingAddressTracks billing address details for customer estimates, ensuring accurate invoicing and payment collection.
estimateItemShippingAddressStores shipping address information for items included in estimates, ensuring proper delivery details are captured.
estimatePartnerAssociates partners with estimates, used for tracking collaborative efforts and revenue sharing on deals.
estimateSalesTeamStores information on the sales team associated with an estimate, used for commission tracking and performance analysis.
estimateShipGroupTracks shipping groups associated with estimates, used for managing multiple shipping locations or methods in a single deal.
estimateShippingAddressStores shipping address details for estimates, ensuring that products are sent to the correct location for fulfillment.
estimateTranPromotionTracks promotional discounts or offers applied to estimates, helping to manage pricing strategies and customer incentives.
EventDowimDefines event data related to Dowim events, used to track event occurrences and associated metrics.
EventFrequencyTracks event frequencies, used to manage recurring events, such as sales campaigns, scheduled meetings, or promotions.
EventPriorityStores the priority level of events, used for scheduling and determining the importance of various events in the system.
EventTypeDefines the types of events, such as 'Webinar', 'Conference', or 'Meeting', used for organizing and managing event details.
excludeLocationRegionItemTracks items excluded from certain location regions, used for managing inventory availability across geographic areas.
executionContextDefines the context in which a transaction or process is executed, helping to track and manage system behavior during operations.
expenseamortizationeventStores data on expense amortization events, used for managing and recording the spreading of expense costs over time.
expensecategoryTracks categories of expenses, used for organizing and classifying financial data across business operations.
ExpenseCategoryRateStores the rates associated with each expense category, helping to apply standard rates to expenses within defined categories.
ExpenseCategoryTranslationStores translations of expense category names, enabling multi-lingual support and international accounting.
expenseItemSubsidiaryMapMaps expense items to subsidiaries, helping to manage and report on expenses across different company units.
expenseItemTranslationStores translations of expense item descriptions, enabling businesses to manage expenses in multiple languages.
expenseMachineTracks machine-related expenses, typically used for manufacturing or operational equipment costs.
expenseplanDefines the structure of an expense plan, used to manage budgeting, forecasting, and cost tracking for business operations.
expensereportTracks employee expense reports, used for submission, approval, and reimbursement of employee-incurred expenses.
expensereportpolicyStores policies governing employee expense reporting, ensuring compliance with company guidelines and regulations.
fairvaluepriceStores fair value pricing data used in financial reporting and compliance calculations.
FairValueRangePolicyDefines policies for acceptable fair value pricing ranges based on financial regulations.
FaxTemplateManages predefined fax templates used for business communications and document transmission.
fileTracks files stored in the NetSuite file cabinet, including metadata and permissions.
FileHitsRecords file access and download statistics to monitor usage and compliance.
financialinstitutionStores details of financial institutions, including banks and payment providers.
FirstRunTimeSelectTracks the first execution of specific processes for system monitoring and auditing.
fixedamountprojectrevenueruleManages fixed-amount revenue recognition rules for project-based billing.
folderStores hierarchical folder structures used in the NetSuite file cabinet for organizing documents.
FolderTypeCategorizes different types of folders used for file organization within the system.
ForecastStores sales and revenue forecasts to support business planning and projections.
ForecastTypeDefines different forecast types used in sales and financial planning.
formatprofileManages data formatting profiles used for import/export operations and reporting.
FrequencyTypeCategorizes different frequency intervals for recurring processes, such as reporting schedules.
FulfillmentChoiceTracks available fulfillment methods for processing sales orders and shipments.
FulfillmentExceptionTypeDefines different types of fulfillment exceptions, such as delays or inventory shortages.
fulfillmentrequestStores customer fulfillment requests and tracks order processing status.
FulfillmentRequestTypeCategorizes different types of fulfillment requests, such as standard, expedited, or backorder.
FXRATEUPDATEZONEManages foreign exchange rate updates for different geographical regions.
gatewayNotificationStores notifications related to payment gateway transactions and processing statuses.
gatewayTokenFamilyGroups related payment gateway tokens used for transaction security and recurring payments.
generalAllocationScheduleTracks schedules for general ledger allocations based on predefined rules.
generalAllocationScheduleJournalCreatedByAllocationLinks general ledger allocation schedules to corresponding journal entries.
GeneralDetailDestinationStores allocation destination details for financial transactions and reporting.
GeneralDetailSourceTracks the source of allocated financial data within general ledger processes.
generalizedItemManages generic inventory items that can be used across multiple product categories.
GeneralScheduleDestinationDefines financial allocation destinations for scheduled transactions.
GeneralScheduleSourceIdentifies the sources of scheduled general ledger allocations.
generaltokenStores generic authentication and security tokens used for various system operations.
generalTokenPaymentOperationMapMaps payment operations to general tokens for secure processing of transactions.
genericCampaignEventResponseStores responses from campaign events, tracking engagement and interactions.
genericCampaignItemManages campaign items used in marketing campaigns, including emails and promotional offers.
genericresourceTracks generic resources such as unassigned personnel or shared assets for project planning.
GenericResourceSubsidiaryRelationshipLinks generic resources to subsidiaries, managing multi-entity resource allocation.
giftcertificateStores issued gift certificates, including balances, expiration dates, and usage history.
giftcertificateitemManages gift certificate items that can be sold or redeemed within transactions.
GiftCertificateItemAuthorizationCodesTracks authorization codes associated with gift certificate items for secure transactions.
giftCertificateItemCorrelateditemAssociates gift certificate items with related products or services.
giftCertificateItemPresentationItemManages the visual presentation of gift certificate items in online and printed catalogs.
giftCertificateItemPriceStores pricing details of gift certificate items, including discounts and promotional rates.
giftCertificateItemQuantityTracks the available quantity of gift certificate items for sales and fulfillment.
giftCertificateItemSiteCategoryAssociates gift certificate items with specific e-commerce site categories.
giftCertificateItemSubsidiaryMapMaps gift certificate items to subsidiaries for financial and inventory tracking.
giftCertificateItemTranslationStores translated names and descriptions for gift certificate items in multiple languages.
glnumberingsequenceTracks general ledger numbering sequences for financial reporting and compliance.
globalaccountmappingManages global account mappings used in multi-entity financial consolidations.
globalinventoryrelationshipTracks relationships between global inventory locations for supply chain management.
goalStores performance goals for employees, teams, and departments within the organization.
HcmterminationcategoryCategorizes employee termination reasons for human capital management reporting.
importedemployeeexpenseContains details of employee expenses that have been imported into the system for reconciliation and processing.
inboundshipmentTracks inbound shipments, including shipment details, carrier information, and expected delivery dates.
InboundShipmentItemLists individual items associated with inbound shipments, including quantities, costs, and item details.
InboundShipmentLandedCostStores landed cost details for inbound shipments, including freight, duties, and additional expenses.
IncoTermDefines International Commercial Terms (Incoterms) used in trade agreements to determine responsibilities between buyers and sellers.
IncoTermTypeCategorizes different types of Incoterms to standardize trade agreements and shipping conditions.
intercompallocationscheduleMaintains schedules for intercompany allocations, detailing the distribution of costs and revenues between subsidiaries.
IntercompanyAllocationScheduleAllocationDetailContains detailed records of allocation transactions related to intercompany allocation schedules.
IntercompanyAllocationScheduleAllocationDetailGeneralDetailDestinationSpecifies the destination details of intercompany allocation transactions, indicating how costs or revenues are allocated.
IntercompanyAllocationScheduleAllocationDetailGeneralDetailSourceSpecifies the source details of intercompany allocation transactions, tracking where costs or revenues originate.
IntercompanyDestinationContains details of destination subsidiaries or entities that receive intercompany transactions, facilitating financial consolidation and reconciliation within NetSuite.
intercompanyjournalentryStores journal entries for intercompany transactions, facilitating accurate financial reporting between subsidiaries.
IntercompanySourceTracks source subsidiaries or entities initiating intercompany transactions, improving compliance and transparency in NetSuite.
intercompanytransferorderRecords intercompany transfer orders, tracking the movement of inventory between subsidiaries.
intercompanyTransferOrderLinkedTrackingNumberMapMaps tracking numbers to intercompany transfer orders for improved shipment tracking and reconciliation.
intercompanyTransferOrderShippingAddressStores shipping address details for intercompany transfer orders, ensuring accurate delivery information.
intercompanyTransferOrderTrackingNumberMapLinks tracking numbers to specific intercompany transfer orders for shipment monitoring.
inventoryadjustmentRecords adjustments made to inventory quantities due to discrepancies, losses, or other modifications.
inventoryAssignmentTracks inventory assignments across different locations or transactions to ensure accurate stock tracking.
InventoryBalanceStores real-time inventory balances for items across different locations, warehouses, or subsidiaries.
inventorycostrevaluationManages cost revaluations for inventory items, adjusting item costs based on market fluctuations or financial requirements.
InventoryCostTemplateDefines cost templates used for inventory cost calculations and standard costing methods.
InventoryCostTemplateCostDetailStores detailed cost components within an inventory cost template, including material, labor, and overhead costs.
inventorycountTracks inventory counts, including cycle counts and full physical inventory counts, to maintain stock accuracy.
inventorydetailStores additional details related to inventory items, including serial numbers, lot numbers, and expiration dates.
inventoryitemRepresents inventory items stored in the system, including item attributes, pricing, and stock levels.
inventoryItemCorrelateditemLinks related inventory items for upselling, cross-selling, or recommended product pairings.
inventoryItemItemAccountingBookDetailMaintains accounting book details for inventory items, supporting multi-book accounting practices.
inventoryItemItemQuantityPricingDiscountTracks quantity-based pricing and discount structures applied to inventory items.
inventoryItemItemQuantityPricingLevelManages quantity-based pricing levels for inventory items, allowing businesses to define different pricing strategies based on the quantities of items purchased.
inventoryItemItemVendorManages the association between inventory items and their approved vendors, including supplier details and purchasing terms.
inventoryItemLocationsTracks inventory levels and location-specific attributes, enabling multi-location inventory management and stock visibility.
inventoryItemPresentationItemLinks inventory items to presentation configurations, such as merchandising categories, promotional groupings, or visual display settings.
inventoryItemPriceMaintains comprehensive pricing data for inventory items, including base pricing, customer-specific pricing, and multi-currency support.
inventoryItemQuantityLogs real-time inventory stock levels, adjustments, and transaction-based quantity changes for accurate inventory tracking.
inventoryItemSiteCategoryMaps inventory items to e-commerce site categories, controlling their online classification, discoverability, and filtering options.
inventoryItemSubsidiaryMapMaintains the relationship between inventory items and their respective subsidiaries, enabling proper stock management and financial reporting.
inventoryItemTranslationContains translated names and descriptions for inventory items to support multi-language e-commerce, reporting, and international business operations.
inventorynumberTracks unique inventory numbers assigned to specific stock items, enabling businesses to maintain accurate records and reporting.
InventoryNumberLocationMonitors the physical locations of specific inventory items across multiple warehouses, stores, or fulfillment centers.
inventorystatusDefines inventory statuses such as 'available,' 'backordered,' or 'in transit,' providing insight into stock availability.
inventorystatuschangeCaptures changes in inventory status, including timestamps and reasons for updates, supporting stock movement analysis.
inventorytransferRecords and manages the movement of inventory between different locations, subsidiaries, or storage facilities.
invoiceHolds invoice details, including billing status, customer information, transaction amounts, payment terms, and links to sales orders and payments.
invoiceBillingAddressLinks invoices to the corresponding customer billing addresses, ensuring accurate financial record-keeping.
invoiceGiftCertRedemptionTracks gift certificate redemptions applied to invoices, recording the amount deducted and remaining balance.
invoicegroupRepresents a collection of invoices processed together for streamlined billing, payment, or financial reporting.
InvoiceItemShippingAddressAssociates specific invoice line items with their designated shipping addresses, supporting order fulfillment tracking.
invoiceLinkedTrackingNumberMapConnects invoices with shipment tracking numbers, facilitating real-time monitoring of delivery status.
invoicePartnerStores details of partners linked to invoices, such as affiliates, resellers, or commission recipients for sales transactions.
invoiceSalesTeamStores details of sales representatives assigned to invoices, including their roles, contribution percentages, and associated transactions.
invoiceShipGroupGroups invoice shipments to facilitate batch processing, logistics tracking, and efficient fulfillment.
invoiceShippingAddressStores and manages shipping addresses linked to invoices, ensuring accurate delivery details for fulfillment.
invoiceTrackingNumberMapAssociates invoices with their respective shipment tracking numbers for real-time order monitoring.
invoiceTranPromotionRecords promotional discounts or offers applied to specific invoice transactions for financial tracking and reporting.
InvtCommitRepresents inventory quantities allocated to sales orders, preventing overcommitment and ensuring stock availability.
InvtItemPriceHistoryTracks historical price adjustments for inventory items, supporting pricing analysis and audit requirements.
IPRestrictionsDefines and enforces IP-based access restrictions to enhance system security and control user access.
issueStores information about reported issues, including details on bugs, enhancements, or other reported problems.
issueproductLinks reported issues to the relevant products, tracking which products are affected by specific issues.
issueproductversionTracks the relationship between reported issues and specific versions of a product, helping with version-based issue resolution.
IssueVersionRelationDefines relationships between different issue versions, capturing dependencies and version-based issue tracking.
itemHolds details about inventory and non-inventory items, including products, materials, and services available in NetSuite.
itemAccountingBookDetailStores accounting book-specific financial details related to items, ensuring proper financial reporting across multiple books.
itemaccountmappingMaps items to their respective general ledger accounts, helping with financial tracking and reconciliation.
itemBaseSubsidiaryMapManages item availability and assignment across multiple subsidiaries within an organization.
itemBinQuantityStores quantity details of items within specific bins, facilitating accurate inventory management.
itemcollectionDefines collections or groups of items, often used for bundling or categorization in sales and reporting.
ItemCollectionCustomerSegmentMapLinks item collections to specific customer segments, supporting targeted marketing and pricing strategies.
itemcollectionitemmapAssociates individual items with predefined item collections for streamlined organization and retrieval.
ItemCollectionItemSimpleMapProvides a simplified mapping of items to item collections for performance optimization in queries and reporting.
itemCorrelatedItemStores relationships between correlated items, such as frequently bought-together or recommended products.
itemdemandplanHolds demand planning data for items, assisting with forecasting and inventory replenishment strategies.
ItemDemandPlanDemandplandetailContains detailed demand planning data, breaking down item demand projections at a granular level.
ItemDemandSourceTracks sources of demand for items, such as sales orders, forecasts, and transfer orders.
itemfulfillmentStores records of item fulfillment transactions, detailing how and when items are shipped to customers.
ItemFulfillmentPackageContains details on packages associated with fulfillment transactions, including dimensions, weights, and tracking numbers.
ItemFulfillmentPackageFedexTracks shipping details for FedEx packages related to item fulfillment.
ItemFulfillmentPackageUpsTracks shipping details for UPS packages related to item fulfillment.
ItemFulfillmentPackageUspsTracks shipping details for USPS packages related to item fulfillment.
itemFulfillmentReturnAddressStores return address details for fulfilled orders, ensuring proper handling of returns.
itemFulfillmentShippingAddressStores shipping addresses used for fulfillment, ensuring correct delivery of items.
itemgroupDefines item groups, which bundle multiple items for simplified pricing, sales, and reporting.
itemGroupMemberLists individual items that belong to an item group, maintaining group composition details.
itemGroupSubsidiaryMapManages subsidiary-specific item group mappings, allowing for region-based product configurations.
itemGroupTranslationStores translated names and descriptions for item groups, supporting multilingual NetSuite implementations.
itemlocationconfigurationHolds configuration settings related to how items are managed across different locations within an organization.
itemMemberStores information about item memberships, defining relationships between items within a group or category.
ItemPeriodicLotSizeTypeContains data related to periodic lot size types, which determine the lot sizing methodology used in inventory planning.
itemPresentationItemRepresents items that are used for presentation purposes in various NetSuite interfaces or reports.
itemPriceMaintains pricing information for different items, including standard and custom price levels.
itempricingContains detailed item-level pricing rules, including discount structures, quantity-based pricing, and special conditions applied to customer sales scenarios.
ItemPricingDiscountStores details on promotional and volume-based discounts applied to items, supporting dynamic pricing strategies.
itemprocessfamilyGroups manufacturing or operational processes related to specific items, aiding production workflow optimization.
itemprocessgroupDefines logical collections of process families to facilitate efficient production planning and execution.
itemQuantityMaintains real-time inventory quantity data across multiple locations to support stock management and reporting.
itemQuantityPricingDiscountManages pricing discounts based on quantity-based tier structures to optimize bulk purchasing incentives.
itemQuantityPricingLevelDefines structured pricing levels associated with different quantity thresholds for items, enabling tiered pricing models.
itemreceiptRecords the receipt of inventory items, capturing details such as purchase order fulfillment and supplier shipments.
itemrevisionTracks version changes of inventory items, including specification updates and product lifecycle management.
ItemSegmentIncludingSyntheticInclsynthitemSupports item categorization, including synthetic items, to enhance segmentation and reporting for inventory analysis.
ItemSegmentItemAssociates items with their corresponding segments for classification, business intelligence, and reporting purposes.
ItemSegmentTypeDefines different item segment types used to categorize and analyze inventory based on business needs.
itemSiteCategoryOrganizes items into site-specific categories for inventory control, e-commerce, and fulfillment operations.
ItemSourceTracks the origin of items, whether sourced from vendors, internal manufacturing, or other supply chain channels.
itemSubsidiaryMapLinks items to specific subsidiaries in multi-entity NetSuite environments to support localized inventory and reporting.
ItemSubtypeProvides a finer level of item classification by defining subtypes within broader inventory categories.
ItemSupplyLotSizingTypeDetermines how supply lot sizes are calculated to support demand planning and procurement strategies.
itemsupplyplanStores planned supply orders to ensure balanced inventory levels and minimize stock shortages or overages.
ItemSupplyPlanOrderMaintains records of supply plan orders generated by NetSuite’s demand planning and replenishment processes.
ItemSupplyPlanPlanningmessageHolds planning messages related to supply forecasting, order recommendations, and inventory adjustments.
ItemSupplyTypeClassifies different supply sources, such as vendor-supplied, internally manufactured, or drop-shipped items.
itemTranslationStores multilingual translations of item names and descriptions to support international business operations.
itemTypeDefines item classifications such as inventory, service, assembly, or non-inventory for proper categorization and processing.
ItemUnitManages units of measure for inventory tracking, sales transactions, and procurement consistency.
itemVendorTracks vendor relationships with items, including preferred suppliers, negotiated pricing, and sourcing details.
jobStores information about jobs, including their status, related entities, and project details.
jobAddressbookContains contact information related to jobs, linking them to associated entities.
jobAddressbookEntityAddressMaps job-related addresses to corresponding entities for accurate record-keeping.
jobBulkMergeHandles bulk merging of job records to ensure data consistency and integrity.
jobCompanyContactLinks jobs to relevant company contacts for streamlined communication and tracking.
JobRequisitionPostingTypeDefines different types of job requisition postings within the system.
JobRequisitionStatusTracks the current status of job requisitions, such as open, filled, or closed.
jobResourceJobResourceMapManages relationships between job resources, linking them to specific tasks.
JobResourceRoleDefines roles assigned to job resources, specifying responsibilities and permissions.
jobResourcesLists all resources allocated to jobs, including personnel and equipment.
jobstatusRecords the status of various jobs, enabling tracking of progress and updates.
jobtypeClassifies different types of jobs based on predefined criteria for reporting and analysis.
journalentryStores financial journal entries, tracking debits and credits for accounting purposes.
kititemRepresents kit items, which are collections of individual inventory components sold together.
kitItemCorrelateditemManages relationships between correlated items within a kit for bundled pricing.
kitItemItemAccountingBookDetailStores accounting details related to kit items across different books.
kitItemItemQuantityPricingDiscountTracks quantity-based discounts applied to kit items.
kitItemItemQuantityPricingLevelDefines pricing levels for kit items based on quantity thresholds.
kitItemMemberLists the individual components that make up a kit item.
kitItemPresentationItemManages how kit items are presented in catalogs and online listings.
kitItemPriceStores price details of kit items, including base and promotional pricing.
kitItemQuantityTracks available quantities of kit items across different locations.
kitItemSiteCategoryLinks kit items to e-commerce site categories for better organization.
kitItemSubsidiaryMapMaps kit items to relevant subsidiaries for financial and inventory tracking.
kitItemTranslationStores translated names and descriptions for kit items in multiple languages.
knowledgeBaseSiteCategoryTranslationHandles translation of knowledge base categories for multilingual support.
laborbasedprojectrevenueruleDefines revenue recognition rules for labor-based project billing.
LagTypeSpecifies different types of scheduling lags in project management.
landedcostTracks additional costs such as shipping, duties, and taxes for imported goods.
LandedCostShipmentItemMapMaps shipment items to landed cost records for accurate cost allocation.
leadStores potential customer information, helping in sales tracking and lead conversion.
librariesActionStores information about predefined actions used in scripting and workflow automation.
librariesAdvancedRevRecManages configurations and rules for advanced revenue recognition.
librariesBundleInstallationTracks the installation and management of SuiteApp bundles.
librariesClientContains client-side script libraries for enhancing user interface interactions.
librariesConsolRateAdjustorStores configurations for currency consolidation rate adjustments.
librariesCustomGlLinesManages custom general ledger line adjustments for financial transactions.
librariesEmailCaptureLogs captured emails for automated processing and storage.
librariesMassUpdateFacilitates batch processing and automated updates for records.
librariesPaymentGatewayContains configurations and integration details for payment gateways.
librariesPlugInTypeDefines the types of plugins that can be used in SuiteScript development.
librariesPlugInTypeImplMaps plugin types to their corresponding implementations.
librariesPortletManages custom dashboard portlets used for displaying dynamic content.
librariesPromotionsStores configurations and rules for promotional discounts and campaigns.
librariesRestletContains configurations for RESTlet-based web service integrations.
librariesScheduledManages scheduled scripts that execute at predefined times.
librariesShippingPartnersStores shipping partner details for carrier integrations.
librariesSuiteletContains script configurations for Suitelets that provide custom UI functionality.
librariesTaxCalculationManages tax calculation rules and configurations.
librariesTestPluginContains test cases and configurations for plugin validation.
librariesUserEventTracks custom event-driven scripts that run on record operations.
librariesWebAppManages configurations for web applications built within NetSuite.
LinkedTrackingNumberMapStores mapping data between different tracking numbers for shipments.
LocalizedTemplateContains templates used for multilingual content in NetSuite.
locAssignConfBackorderRulesItemDefines rules for backorder assignments and fulfillment.
locationStores details about business locations, including warehouses and offices.
LocationMainAddressContains primary address information for business locations.
LocationReturnAddressManages return address details for different business locations.
locationSubsidiaryMapMaps locations to subsidiaries for operational and financial tracking.
LocationTypeCategorizes different location types, such as warehouses and stores.
LoginAuditRecords login attempts and authentication details for security tracking.
lotnumberedassemblyitemTracks assembly items that use lot numbers for inventory management, ensuring traceability and compliance.
lotnumberedinventoryitemStores details of inventory items tracked by lot numbers, facilitating quality control and batch tracking.
MailTemplateManages predefined email templates used for automated communications and marketing campaigns.
manufacturingComponentStores details of components used in manufacturing processes, linking raw materials to finished goods.
manufacturingcosttemplateDefines cost structures for manufacturing, including labor, overhead, and materials.
ManufacturingCostTemplateCostDetailRecords detailed breakdowns of costs within manufacturing cost templates.
manufacturingoperationtaskTracks individual manufacturing tasks, including assigned workers, machines, and production timelines.
ManufacturingOperationTaskCostDetailStores cost details related to specific manufacturing operation tasks.
manufacturingOperationTaskPredecessorManages dependencies between manufacturing tasks to ensure accurate production sequencing.
manufacturingroutingDefines the workflow and sequence of operations for manufacturing a product.
ManufacturingRoutingComponentLinks components to manufacturing routings, specifying materials needed at each step.
ManufacturingRoutingLocationMapAssociates manufacturing routings with specific production facilities or work centers.
ManufacturingRoutingRoutingStepStores step-by-step instructions for each stage in a manufacturing routing.
manufacturingTransactionLogs transactions related to manufacturing, such as work orders and production completions.
mapreducescriptManages scripts that use the map/reduce framework for processing large datasets in NetSuite.
markupitemStores information on markup items used to apply pricing adjustments to sales transactions.
markupItemSubsidiaryMapAssociates markup items with specific subsidiaries to support multi-entity financial reporting.
markupItemTranslationStores translated names and descriptions for markup items in multiple languages.
massupdatescriptHandles automated bulk updates of records across the system, improving efficiency and accuracy.
MediaItemFolderOrganizes media assets such as images, documents, and videos within the file cabinet.
MediaTypeCategorizes different types of media files used in NetSuite, such as images, audio, or PDFs.
memdocStores memorized transaction records, often used for non-financial transactions.
MemDocCustomRecurrenceManages custom recurrence schedules for memorized transactions.
memDocTransactionTemplateDefines templates for recurring memorized transactions.
MemDocTransactionTemplateAccountingLineStores accounting line details for financial transactions using memorized transaction templates.
memDocTransactionTemplateLineRecords individual line items within a memorized transaction transaction template.
memDocTransactionTemplatePartnerLinks partners to memorized transaction transactions for financial and business tracking.
memDocTransactionTemplateSalesTeamAssociates sales team members with specific memorized transaction transactions.
memDocTransactionTemplateTranPromotionTracks promotional details tied to memorized transaction transactions.
merchandisehierarchylevelDefines hierarchical levels in a merchandise classification system, structuring product categories.
merchandisehierarchynodeRepresents individual nodes within a merchandise hierarchy, grouping similar products together.
merchandisehierarchyversionTracks different versions of merchandise hierarchies, allowing historical comparisons and updates.
messageStores communication records such as emails, system notifications, and customer messages.
MessageFileAssociates attachments with messages, storing files linked to emails or internal notes.
MessageTypeClassifies different types of messages, such as customer communications, system alerts, and internal notifications.
methodsStores predefined methods for various system operations and calculations.
mfgplannedtimeTracks planned manufacturing times for work orders, ensuring accurate production scheduling.
MfgProjectAddressbookManages contact details linked to manufacturing projects, including suppliers and contractors.
MfgProjectAddressbookEntityAddressAssociates manufacturing project addresses with corresponding business entities.
MfgProjectBulkMergeFacilitates bulk merging of manufacturing project records to maintain data consistency.
MfgProjectCompanyContactLinks manufacturing projects to relevant company contacts for coordination and reporting.
MfgProjectJobResourcesTracks resources allocated to manufacturing jobs, such as personnel and machinery.
MfgProjectJobResourcesJobResourceJobResourceMapMaps job resources across multiple manufacturing projects for efficient resource allocation.
mitPurposeStores details related to MIT (Material Issue Transactions) and their purpose in inventory management.
MonthsOfYearDefines the months of the year for use in scheduling, reporting, and financial processes.
NegativeNumberFormatStores the format for handling negative numbers in transactions or accounting entries.
NextTransactionLineLinkLinks the next line of a transaction to the current one, ensuring proper line item sequencing.
NextTransactionLinkThe NextTransactionLink table.
nexusContains information about the tax nexus, used for determining tax jurisdiction based on location.
noninventoryitemStores data for non-inventory items, which are products not tracked for quantity in stock.
nonInventoryItemCorrelateditemLinks non-inventory items with correlated products for cross-selling or bundling.
nonInventoryItemItemAccountingBookDetailStores accounting details for non-inventory items, used for financial reporting.
nonInventoryItemItemQuantityPricingDiscountDefines quantity-based discount pricing for non-inventory items.
nonInventoryItemItemQuantityPricingLevelDefines different pricing levels based on quantities for non-inventory items.
nonInventoryItemItemVendorStores vendor-specific pricing and details for non-inventory items.
nonInventoryItemPresentationItemAssociates non-inventory items with presentation items, typically for marketing purposes.
nonInventoryItemPriceStores pricing details for non-inventory items.
nonInventoryItemQuantityTracks the available quantity of non-inventory items, though not typically tracked for inventory.
nonInventoryItemSiteCategoryLinks non-inventory items with specific site categories for better online store organization.
nonInventoryItemSubsidiaryMapMaps non-inventory items to subsidiaries for multi-subsidiary management.
nonInventoryItemTranslationStores translations for non-inventory item names and descriptions in different languages.
nonInventoryPurchaseItemItemAccountingBookDetailContains accounting details for non-inventory purchase items, used in financial reports.
nonInventoryPurchaseItemItemVendorStores vendor information for non-inventory purchase items.
nonInventoryPurchaseItemSubsidiaryMapMaps non-inventory purchase items to subsidiaries, enabling multi-subsidiary operations.
nonInventoryPurchaseItemTranslationStores translations for non-inventory purchase items for international operations.
nonInventoryResaleItemCorrelateditemLinks non-inventory resale items with correlated items, used for cross-selling or bundling.
nonInventoryResaleItemItemAccountingBookDetailContains accounting details for non-inventory resale items used in financial reporting.
nonInventoryResaleItemItemQuantityPricingDiscountDefines quantity-based discount pricing for non-inventory resale items.
nonInventoryResaleItemItemQuantityPricingLevelDefines pricing levels for non-inventory resale items based on quantities.
nonInventoryResaleItemItemVendorStores vendor-specific pricing and details for non-inventory resale items.
nonInventoryResaleItemPresentationItemAssociates non-inventory resale items with presentation items for marketing purposes.
nonInventoryResaleItemPriceStores pricing information for non-inventory resale items.
nonInventoryResaleItemQuantityTracks available quantity of non-inventory resale items.
nonInventoryResaleItemSiteCategoryLinks non-inventory resale items with site categories to facilitate easier browsing in online stores.
nonInventoryResaleItemSubsidiaryMapMaps non-inventory resale items to subsidiaries for multi-subsidiary support.
nonInventoryResaleItemTranslationStores translations for non-inventory resale items, enabling global sales.
nonInventorySaleItemCorrelateditemLinks non-inventory sale items to related products, often used for bundling or promotions.
nonInventorySaleItemItemAccountingBookDetailStores accounting data for non-inventory sale items, supporting financial reports.
nonInventorySaleItemItemQuantityPricingDiscountDefines quantity discounts for non-inventory sale items.
nonInventorySaleItemItemQuantityPricingLevelStores pricing levels for non-inventory sale items based on quantity purchased.
nonInventorySaleItemPresentationItemAssociates non-inventory sale items with presentation items for marketing and promotional purposes.
nonInventorySaleItemPriceStores pricing data for non-inventory sale items.
nonInventorySaleItemQuantityTracks the quantity of non-inventory sale items available for purchase.
nonInventorySaleItemSiteCategoryLinks non-inventory sale items with specific site categories for better online store categorization.
nonInventorySaleItemSubsidiaryMapMaps non-inventory sale items to subsidiaries, supporting multi-subsidiary management.
nonInventorySaleItemTranslationStores translated versions of non-inventory sale item names and descriptions for international markets.
noteStores notes related to transactions, entities, or other records in the system.
NoteDirectionTypeDefines the direction of notes (for example, inbound, outbound) in relation to a transaction or entity.
notetypeCategorizes notes by type, enabling easier management and retrieval of notes.
NumberFormatStores formatting rules for numbers, ensuring consistency across the system.
NumberingSequenceSubsidMapMaps numbering sequences to subsidiaries for multi-subsidiary operations.
OAuthTokenStores OAuth tokens used for secure API authentication.
onlineFormTemplateStores templates for online forms, used in customer data collection and submissions.
onlineLeadFormEventTracks events related to online lead forms, such as submissions and interactions.
onlineLeadFormFieldDefines fields used in online lead forms for capturing customer information.
opportunityStores information about sales opportunities, including potential revenue and deal details.
opportunityBillingAddressStores the billing address associated with an opportunity.
OpportunityCompetitorTracks competitors associated with specific sales opportunities.
opportunityPartnerStores partner information linked to sales opportunities.
opportunitySalesTeamStores details of the sales team members associated with an opportunity.
opportunityShippingAddressStores the shipping address associated with an opportunity.
orderFrequencyTypeDefines the frequency of orders (for example, weekly, monthly) for sales or procurement purposes.
orderreservationStores details of order reservations made for customers, helping manage stock allocation.
orderscheduleDefines the scheduling rules for order fulfillment and delivery.
ordertypeDefines the types of orders (for example, standard, rush) within the system.
otherchargeitemStores non-inventory charge items applied to transactions, such as fees or shipping costs.
otherChargeItemItemAccountingBookDetailContains accounting details for other charge items applied to transactions.
otherChargeItemItemQuantityPricingDiscountDefines discounts applied to other charge items based on quantity.
otherChargeItemItemQuantityPricingLevelStores pricing levels for other charge items based on the quantity purchased.
otherChargeItemItemVendorLinks other charge items to specific vendors, useful for purchase order tracking.
otherChargeItemPriceStores the price of non-inventory charge items applied to transactions.
otherChargeItemQuantityTracks the quantity of other charge items in transactions.
otherChargeItemSubsidiaryMapMaps other charge items to subsidiaries for multi-subsidiary operations.
otherChargeItemTranslationStores translations for other charge items, enabling global business operations.
otherChargePurchaseItemItemAccountingBookDetailContains accounting details for other charge purchase items.
otherChargePurchaseItemItemVendorStores vendor-specific information for other charge purchase items.
otherChargePurchaseItemSubsidiaryMapMaps other charge purchase items to subsidiaries for multi-subsidiary support.
otherChargePurchaseItemTranslationStores translations for other charge purchase items for international operations.
otherChargeResaleItemItemAccountingBookDetailStores accounting details for other charge resale items used in transactions.
otherChargeResaleItemItemQuantityPricingDiscountDefines discounts for other charge resale items based on quantity.
otherChargeResaleItemItemQuantityPricingLevelStores quantity pricing levels for other charge resale items.
otherChargeResaleItemItemVendorLinks other charge resale items to specific vendors.
otherChargeResaleItemPriceStores pricing data for other charge resale items.
otherChargeResaleItemQuantityTracks the quantity of other charge resale items in transactions.
otherChargeResaleItemSubsidiaryMapMaps other charge resale items to subsidiaries for multi-subsidiary management.
otherChargeResaleItemTranslationStores translations for other charge resale items, allowing for global sales.
otherChargeSaleItemItemAccountingBookDetailContains accounting details for other charge sale items.
otherChargeSaleItemItemQuantityPricingDiscountDefines discounts applied to other charge sale items based on quantity.
otherChargeSaleItemItemQuantityPricingLevelStores pricing levels for other charge sale items based on quantity.
otherChargeSaleItemPriceStores the pricing information for other charge sale items.
otherChargeSaleItemQuantityTracks the quantity of other charge sale items in transactions.
otherChargeSaleItemSubsidiaryMapMaps other charge sale items to subsidiaries for multi-subsidiary support.
otherChargeSaleItemTranslationStores translations for other charge sale items for international markets.
othernameStores data for other names associated with entities, often used for aliases or secondary names.
otherNameAddressbookStores address book entries for other names associated with entities.
otherNameAddressbookEntityAddressLinks other name address book entries to specific entity addresses.
otherNameBulkMergeSupports bulk merging of other name records for cleanup or integration.
otherNameCampaignsTracks campaign associations related to other names.
othernamecategoryStores categorization information for other names in the system.
otherNameCompanyContactLinks other names to company contact records for easier lookup.
otherNameSubscriptionMessageHistoryTracks subscription message history related to other names in the system.
otherNameSubscriptionsStores subscription details for other names, including status and dates.
OtherNameSubsidiaryRelationshipTracks the relationship between other names and subsidiaries.
outboundRequestTracks outbound requests made from the system, including request details.
overallQuantityPricingTypeDefines the overall pricing strategy based on quantities purchased.
overheadTypeCategorizes different types of overhead costs for financial analysis and reporting.
parametersActionThe table that stores the parameters for actions executed in SuiteQL scripts, used for configuration and customization.
parametersBundleInstallationThe table storing parameters related to bundle installations in SuiteQL, used to manage the installation of bundles in the system.
parametersClientThe table that stores client-specific parameters in SuiteQL scripts, used for configuring client-related data and transactions.
parametersMapReduceThe table holding parameters for MapReduce jobs in SuiteQL, enabling custom MapReduce processes to be configured and executed.
parametersMassUpdateThe table that stores parameters for mass update processes, allowing bulk updates of records in SuiteQL scripts.
parametersPortletThe table storing parameters for portlet configurations, used to control the display and behavior of portlets in the SuiteQL environment.
parametersRestletThe table holding parameters for Restlet services in SuiteQL, used to manage web service calls and data handling in SuiteQL scripts.
parametersScheduledThe table that stores parameters for scheduled script executions, enabling automation and task scheduling in SuiteQL.
parametersScriptThe table storing parameters for SuiteScripts, enabling customization and configuration of scripts within the SuiteQL environment.
parametersSuiteletThe table that stores Suitelet parameters, used for configuring user interfaces and custom forms within SuiteQL.
parametersUserEventThe table storing parameters for user event scripts, enabling customization and logic to be applied based on user interactions in SuiteQL.
partnerThe table that stores partner-related information, used to track business partners, their statuses, and relationships in the system.
PartnerAddressbookThe table storing partner address book entries, including multiple addresses for each partner.
PartnerAddressbookEntityAddressThe table linking partner address book entries to entity addresses, used to manage partner-specific addresses.
PartnerBulkMergeThe table for managing bulk merge operations related to partners, streamlining partner data consolidation and updates.
PartnerCampaignsThe table that tracks partner campaign participation, linking partners to marketing campaigns they are involved with.
partnercategoryThe table storing categories for partners, used to classify partners based on types, regions, or other characteristics.
partnerCategoryMapThe table that maps partners to their respective categories, enabling efficient classification and reporting.
PartnerCompanyContactThe table storing contact information for partner companies, used to track key personnel and communication points.
partnerContactRoleThe table defining the roles of contacts within partner companies, facilitating role-based communication and responsibilities.
PartnerSubscriptionMessageHistoryThe table that tracks the history of subscription messages sent to partners, used for communications and subscription management.
PartnerSubscriptionsThe table storing subscription data for partners, enabling management of partner subscriptions and related services.
PartnerSubsidiaryRelationshipThe table storing relationships between partners and subsidiaries, used for tracking the organizational structure of partner networks.
PartnerSystemThe table managing the systems associated with partners, used to track integrations, data sharing, and system connections.
paycheckThe table storing paycheck records, used for tracking employee payments, deductions, and pay periods.
paycheckjournalThe table storing journal entries related to paychecks, used for accounting and reconciliation of payroll transactions.
payItemTypeThe table that defines different types of pay items, used to categorize and manage various payroll components such as wages, bonuses, or commissions.
paymentcardThe table storing payment card details, used for processing and managing payments through credit or debit cards.
paymentCardBinThe table storing information about payment card BIN (Bank Identification Number), used for identifying the financial institution associated with a card.
paymentCardBrandThe table tracking different card brands (such as Visa, MasterCard, or American Express), used for managing payment card preferences.
paymentCardPaymentOperationMapThe table linking payment card types with payment operations, used for managing card-specific transaction processing rules.
paymentcardtokenThe table storing tokenized payment card data, enabling secure processing without storing sensitive card details.
paymentCardTokenPaymentOperationMapThe table mapping tokenized payment card data to payment operations, ensuring secure transaction processing with tokenized card information.
paymenteventThe table storing details of payment events, used to track the status and results of payment transactions.
paymentHandlingModeThe table storing different payment handling modes, used to define how payment transactions are processed or handled.
paymentInitiatorThe table that tracks the initiator of payment transactions, used for identifying the source or authorization of payments.
paymentInstrumentListPaymentOperationMapThe table that links payment instruments to specific payment operations, used for managing payment processing logic.
paymentInstrumentPaymentOperationMapThe table mapping different payment instruments to their corresponding payment operations for seamless transaction processing.
paymentInstrumentStateTypeThe table defining the various states associated with payment instruments (such as active, expired, or pending) for managing their lifecycle.
paymentInstrumentTypeThe table defining the types of payment instruments (such as credit cards, ACH, or PayPal) to classify and manage payment methods.
paymentitemThe table storing payment item details, used to track different types of payment items in the system for billing and accounting purposes.
paymentItemSubsidiaryMapThe table mapping payment items to subsidiaries, enabling subsidiary-specific management of payment items in multi-subsidiary organizations.
paymentItemTranslationThe paymentItemTranslation table.
paymentmethodThe table storing payment methods (such as credit card, bank transfer, or cash), used for processing payments in the system.
paymentMethodVisualThe table storing visual representations of payment methods, used to display payment options in user interfaces or customer-facing systems.
paymentOperationThe table storing payment operations (such as authorization, capture, or refund), used for processing transactions and managing payment workflows.
paymentResultPreviewThe table previewing the results of payment operations, used to simulate and verify payment transaction outcomes before final submission.
paymentStatusThe table storing payment status information (such as pending, completed, or failed), used for tracking the progress and results of payment transactions.
paymentStatusReasonThe table defining the reasons for payment statuses (such as insufficient funds, authorization failed, or fraud), to explain transaction outcomes.
payrollbatchThe table managing payroll batches, used to group and track payroll processing activities for employees.
payrollitemThe table storing payroll item details, used to categorize and manage the different types of compensation or deductions within payroll records.
payrollItemEmployeeTaxOptionsThe table storing tax options for payroll items, enabling customization of tax treatments for different payroll components.
pctcompleteprojectrevenueruleThe table storing rules for recognizing project revenue based on percentage completion, used for revenue recognition in project-based accounting.
PdfTemplateThe table storing PDF templates, used to define the layout and structure of printable documents within the system.
periodendjournalThe table storing period-end journal entries, used for recording financial transactions at the close of a financial period.
permissionLevelThe table defining permission levels for users or roles, used to manage access control and security within the system.
PermissionTypeThe table defining different types of permissions (such as read, write, or delete), used for fine-grained access control in the system.
phonecallThe table storing phone call records, used to track customer service interactions, sales calls, and other telecommunication events.
PickActionInventoryDetailThe table storing inventory details for pick actions, used in warehouse management to track the items picked for fulfillment.
pickstrategyThe table defining pick strategies, used in warehouse management to optimize the process of selecting items for order fulfillment.
picktaskThe table storing details about tasks related to picking inventory items, used in warehouse and fulfillment operations.
plannedorderThe table storing planned orders, used for tracking future orders and production requirements in the supply chain.
plannedRevenueTypeDefines the types of planned revenue streams, used in financial forecasting and revenue recognition planning.
plannedStandardCostStores predefined standard costs for items and services, used in cost accounting and budgeting.
plannedStandardCostComponentsBreaks down planned standard costs into individual components, providing detailed cost analysis for budgeting.
planningitemcategoryCategorizes planning items based on their use in supply chain and inventory management.
planningitemgroupGroups planning items together for batch processing in production and procurement planning.
planningrulegroupStores predefined planning rules that govern inventory replenishment, production, and purchasing strategies.
planningviewProvides a structured view of supply chain planning data, used for demand forecasting and capacity planning.
platformExtensionPluginLibrariesAdvancedRevRecManages advanced revenue recognition plugin libraries, enabling enhanced financial reporting capabilities.
portletStores configuration data for portlets, which are customizable UI elements in NetSuite dashboards.
predictedRiskTrainEvalHistoryTracks the training and evaluation history of predictive risk models used for financial and operational analysis.
presentationItemTypeDefines different types of presentation items, used for displaying structured content within NetSuite.
PreviousTransactionLineLinkLinks related transaction lines together, enabling historical transaction tracking and reporting.
PreviousTransactionLinkTracks the relationship between past transactions, allowing for audit trails and historical data analysis.
pricebookStores structured price books that define different pricing levels for products and services.
pricelevelManages different pricing levels assigned to customers, such as retail, wholesale, or custom pricing tiers.
PriceModelTypeDefines pricing models used for dynamic pricing calculations based on market conditions or customer segments.
priceplanTracks predefined pricing plans, used for subscription-based billing or long-term pricing strategies.
priceUsingTypeSpecifies different pricing methods, such as cost-plus, discount-based, or volume-based pricing.
pricingStores real-time pricing data, used for sales transactions and automated pricing adjustments.
pricinggroupOrganizes items into pricing groups, allowing for bulk pricing changes and promotions.
ProjectBudgetAmountStores allocated budget amounts for projects, allowing financial tracking and budget adherence analysis.
projectexpensetypeDefines types of project expenses (such as travel, materials, or consulting fees), used for project cost tracking.
projecticchargerequestManages intercompany charge requests related to projects, used in multi-entity project accounting.
ProjectSubsidiaryRelationshipTracks relationships between projects and subsidiaries, enabling cross-company project management.
projecttaskStores individual project tasks, used for task tracking, resource allocation, and scheduling.
projectTaskAssigneeLinks project tasks to assigned resources, tracking responsibility and workload distribution.
projectTaskConstraintTypeDefines constraint types for project tasks, such as fixed dates or dependencies on other tasks.
projectTaskPredecessorTracks predecessor relationships between project tasks, used for scheduling and dependency management.
projecttemplateStores reusable project templates, enabling standardized project setup and workflow automation.
projectTemplateJobResourceManages job resources linked to project templates, allowing pre-assigned resources in template-based projects.
ProjectTemplateSubsidiaryRelationshipDefines relationships between project templates and subsidiaries, ensuring consistency across business units.
ProjectTimeApprovalTypeSpecifies different approval types for project time entries, used in timesheet review workflows.
promocodediscounttypeDefines types of discount structures associated with promotional codes, such as percentage-based or fixed amount discounts.
promotioncodeStores promotional codes used for discounts and marketing campaigns in sales transactions.
promotionCodeCampaignsLinks promotional codes to marketing campaigns, enabling tracking of discount effectiveness.
promotionCodeCouponInstancesTracks individual coupon instances generated from promotional codes, used for unique or limited-use offers.
promotionCodeCurrencyMaps promotional codes to specific currencies, allowing multi-currency promotions.
promotionCodeItemsLinks promotional codes to specific items, restricting discounts to selected products or services.
promotioncodelocationmapDefines which locations a promotional code is valid for, used for regional promotions and offers.
promotionCodePartnerMapAssociates promotional codes with specific business partners, used for affiliate or partner-driven promotions.
promotionCodeWebsiteMapLinks promotional codes to specific websites or e-commerce platforms for online sales.
prospectStores data about prospective customers, used for lead tracking and sales pipeline management.
publishedSavedSearchManages saved searches that have been published for use by multiple users in NetSuite.
publishedSavedSearchPresItemPresCategoryLinks published saved searches to presentation items and categories for structured content retrieval.
publishedSavedSearchSiteCategoryTagSubstitutionManages tag-based substitutions in published saved searches, enabling dynamic search filtering.
publishedSavedSearchSiteCategoryTranslationPublishedSavedSearchTracks translations for published saved searches in different site categories, supporting multilingual content.
purchasecontractStores purchase contract details, used for long-term vendor agreements and procurement planning.
purchaseorderManages purchase orders, tracking vendor transactions and procurement workflows.
purchaseOrderBillingAddressStores billing addresses associated with purchase orders, ensuring accurate financial documentation.
purchaseOrderExpenseMachineTracks machine-related expenses tied to purchase orders, used for capital expenditure tracking.
purchaseOrderShippingAddressStores shipping addresses for purchase orders, ensuring proper delivery logistics.
purchaseOrderTrackingNumberMapMaps tracking numbers to purchase orders, enabling shipment tracking and delivery confirmation.
purchaserequisitionManages purchase requisitions, enabling internal requests for goods and services before purchase orders are issued.
purchaseRequisitionTrackingNumberMapLinks tracking numbers to purchase requisitions, enabling monitoring of requested goods in transit.
quantityPricingScheduleContains details about quantity-based pricing structures, including pricing tiers and applicable discounts for bulk purchases.
quantityPricingScheduleLevelEditStores data related to the modification and adjustment of quantity pricing levels, allowing for customization of pricing schedules.
quantityPricingScheduleLevelSpreadsheetRepresents the tabular view of quantity pricing levels, facilitating bulk edits and analysis in spreadsheet-like formats.
QuotaTracks sales quotas assigned to sales representatives or teams, used for performance evaluation and goal setting.
reallocateitemMaintains records of inventory reallocations, detailing item movements between locations for optimized stock distribution.
receiveinboundshipmentLogs the receipt of inbound shipments, capturing shipment details, received quantities, and supplier information.
RecentRecordStores a list of recently accessed records by users for quick reference and navigation within the system.
redeemedAtTransactionTracks reward redemptions and applied promotions at the transaction level for customer loyalty programs and discounts.
reforecastMethodDefines methods for reforecasting revenue, expenses, or sales projections based on updated business conditions.
reportingSectionCategorizes various reporting elements, allowing structured organization of financial, operational, and compliance reports.
requestForQuoteItemItemPricingDetails item-level pricing within a Request For Quote (RFQ), including base pricing, volume discounts, and special offers.
requestForQuoteItemItemPricingDiscountStores specific discount details associated with Request for Quote (RFQ) item pricing, including percentage and fixed-amount reductions.
resourceallocationManages the allocation of resources such as personnel, equipment, and budget to various projects or tasks.
resourceAllocationTypeDefines the types of resource allocations, including full-time, part-time, and temporary assignments within projects.
resourceGroupOrganizes resources into logical groups, enabling better management and assignment of personnel and assets.
resourceGroupMembersLinks individual resources to specific resource groups, defining team structures and functional units.
restletHolds metadata and configurations for REST-based API scripts, facilitating integration with external applications.
returnauthorizationRecords customer return authorizations, capturing details of returned items, approval status, and refund processing.
returnAuthorizationBillingAddressMaintains billing address information associated with return authorizations for accurate customer account tracking.
returnAuthorizationPartnerLinks business partners involved in return authorizations, including vendors and logistics providers.
returnAuthorizationSalesTeamTracks the sales team members associated with a return authorization, useful for performance analysis and commission calculations.
returnAuthorizationShippingAddressStores shipping address details relevant to return authorizations, ensuring accurate logistics and restocking processes.
returnAuthorizationTranPromotionCaptures promotion details linked to return authorizations, tracking applied discounts and incentives.
RevenueArrangementManages revenue recognition arrangements, defining how revenue is allocated across multiple accounting periods.
revenuecommitmentRecords revenue commitments, outlining contractual obligations for future revenue recognition based on service or product delivery.
revenueCommitmentBillingAddressStores billing addresses associated with revenue commitments to maintain financial accuracy.
revenueCommitmentPartnerTracks partner entities involved in revenue commitments, such as resellers, distributors, or service providers.
revenuecommitmentreversalHandles reversals of revenue commitments, ensuring correct revenue adjustments and compliance with accounting standards.
revenueCommitmentReversalBillingAddressRecords billing addresses linked to revenue commitment reversals for financial auditing purposes.
revenueCommitmentReversalPartnerMaintains partner details related to revenue commitment reversals, ensuring accurate contract modifications.
revenueCommitmentReversalSalesTeamTracks sales representatives linked to revenue commitment reversals, enabling sales compensation adjustments.
revenueCommitmentReversalShippingAddressStores shipping addresses relevant to revenue commitment reversals for logistical corrections.
revenueCommitmentReversalTrackingNumberMapMaps tracking numbers to revenue commitment reversals for improved order reconciliation and traceability.
revenueCommitmentSalesTeamAssociates sales teams with revenue commitments, helping track sales-driven revenue recognition.
revenueCommitmentShippingAddressStores shipping address details linked to revenue commitments, ensuring delivery accuracy.
revenueCommitmentTrackingNumberMapMaintains tracking number associations with revenue commitments, enabling order fulfillment tracking.
revenueContractSalesTeamLinks sales teams to revenue contracts, ensuring accountability for contract-based revenue.
RevenueElementDefines individual revenue elements within revenue arrangements, specifying how revenue is distributed.
revenueElementSourceTypeCategorizes sources of revenue elements, distinguishing between products, services, and other income streams.
RevenuePlanManages structured revenue plans, outlining expected revenue recognition timelines and allocation rules.
revenuePlanSourceTracks the origin of revenue plans, linking them to sales transactions, contracts, or forecasts.
revenuePlanStatusDefines the status of revenue plans, such as pending, active, completed, or canceled.
revenuePlanTypeSpecifies different types of revenue plans, such as milestone-based, subscription-based, or percentage-of-completion.
revRecAmountSourceTypeDefines the source of revenue recognition amounts, such as fixed fees, variable charges, or cost-plus calculations.
revRecChangeImpactTypeTracks the impact of changes on revenue recognition schedules, ensuring compliance with accounting adjustments.
revRecDateSourceTypeDetermines the basis for revenue recognition dates, such as contract start date or delivery date.
revRecEventPRevRuleManages event-based revenue recognition rules, defining when revenue should be recognized upon specific triggers.
revRecEventTranLineStores transaction line details associated with revenue recognition events, enabling detailed financial tracking.
revRecRecurrenceTypeDefines different recurrence patterns for revenue recognition, including monthly, quarterly, and annual schedules.
revrecscheduleManages the scheduling of revenue recognition, ensuring compliance with financial reporting standards.
revrectemplateStores predefined templates for revenue recognition, streamlining the setup of standard revenue schedules.
roleDefines user roles within the system, specifying access levels and permissions.
rolepermissionsManages permissions assigned to specific roles, controlling data access and system functionality.
rolerestrictionsTracks restrictions associated with user roles, limiting access to specific records or actions.
saleschannelContains information about the various sales channels used, such as online, in-store, or third-party platforms.
salesInvoicedTracks sales that have been invoiced, providing insights into completed billing transactions.
salesorderStores details of sales orders, including order status, customer, and line items.
salesOrderBillingAddressContains billing address information linked to individual sales orders.
salesOrderedTracks items that have been ordered but not yet invoiced or fulfilled.
salesOrderGiftCertRedemptionRecords gift certificate redemptions associated with specific sales orders.
salesOrderItemShippingAddressStores shipping addresses assigned to individual items within a sales order.
salesOrderLinkedTrackingNumberMapMaps tracking numbers to sales orders for shipment tracking purposes.
salesOrderPartnerAssociates partners, such as resellers or affiliates, with specific sales orders.
salesOrderSalesTeamTracks sales team members and their roles associated with a specific sales order.
salesOrderShipGroupOrganizes line items into shipping groups within a sales order for grouped fulfillment.
salesOrderShippingAddressContains shipping address information linked to each sales order.
salesOrderTranPromotionCaptures promotional discounts or offers applied to sales transactions.
salesroleDefines roles assigned to sales representatives, used in sales tracking and reporting.
salestaxitemHolds tax item definitions used to calculate applicable sales taxes on transactions.
scheduledscriptStores metadata for scheduled scripts, which execute server-side logic at defined intervals.
scheduledscriptinstanceTracks individual instances of scheduled scripts, including execution time and status.
schedulingMethodLists available scheduling methods for job or resource allocation.
scriptButtonDefines custom script buttons available in the user interface.
scriptdeploymentTracks deployment details for scripts across different environments or records.
scriptEventTypeLists event types (for example, create, edit, delete) that can trigger script execution.
scriptExecutionContextMapMaps execution contexts (for example, user event, scheduled, client) to associated scripts.
scriptExecutionContextMapClientSpecifies client-side contexts in which scripts are executed.
scriptExecutionContextMapUserEventDetails the user event contexts that trigger script execution.
scriptFieldTypeDefines data types for scriptable fields used in SuiteScript or custom records.
scriptLocalizationContextMapMaps localization contexts to scripts for internationalization support.
scriptLocalizationContextMapClientDefines localization mappings for scripts running on the client side.
scriptMethodsLists available scripting methods that can be used within SuiteScript.
scriptNoteTypeDefines types of script-related notes used for documentation or tracking.
scriptPortletTypeSpecifies the portlet types used in dashboard script deployments.
scriptStatusTracks the current status of deployed scripts.
scriptTypeLists the SuiteScripts types.
scriptVersionStores versioning information for scripts to manage updates and deployments.
searchCampaignContains information on search campaigns used in marketing and lead generation.
searchCampaignItemStores items linked to specific search campaigns, aiding campaign performance tracking.
sentEmailTracks emails that have been sent from within the system, including metadata and status.
sentemailrecipientLists recipients associated with each sent email record.
serializedassemblyitemContains records for serialized assembly items, including component and serial tracking data.
serializedinventoryitemStores details of serialized inventory items, allowing for tracking by serial number throughout the product lifecycle.
serviceitemDefines general service items used for billing non-physical services.
serviceItemBillingRateSpecifies billing rates associated with service items, used for project and time-based billing.
serviceItemCorrelateditemTracks related or frequently purchased service items, useful for upselling and product suggestions.
serviceItemItemAccountingBookDetailCaptures accounting book-specific financial data for service items, including alternate book treatments.
serviceItemItemQuantityPricingDiscountHolds quantity-based pricing discounts for service items, enabling tiered pricing models.
serviceItemItemQuantityPricingLevelDefines pricing levels for service items based on quantity thresholds.
serviceItemItemVendorLists vendors associated with service items, supporting vendor-managed services.
serviceItemPresentationItemStores presentation details of service items used for online or printed catalogs.
serviceItemPriceTracks pricing information for service items, including currency, customer group, and price level.
serviceItemQuantityStores inventory quantity settings related to service items when applicable.
serviceItemSiteCategoryMaps service items to web store site categories for easier browsing and navigation.
serviceItemSubsidiaryMapAssociates service items with subsidiaries in multi-subsidiary environments.
serviceItemTaskTemplateLinks task templates to service items, supporting project-based service delivery workflows.
serviceItemTranslationProvides translated descriptions and names of service items for multilingual sites or international use.
servicePurchaseItemItemAccountingBookDetailStores accounting book-specific details for service purchase items.
servicePurchaseItemItemVendorLists vendors tied to specific service purchase items.
servicePurchaseItemSubsidiaryMapMaps service purchase items to specific subsidiaries.
servicePurchaseItemTranslationContains translated values for service purchase items across supported languages.
serviceResaleItemBillingRateCaptures billing rates specific to resale service items for invoicing purposes.
serviceResaleItemCorrelateditemLists correlated items frequently resold together with the main service item.
serviceResaleItemItemAccountingBookDetailHolds financial reporting details per accounting book for resale service items.
serviceResaleItemItemQuantityPricingDiscountStores discount schedules for resale service items based on quantity purchased.
serviceResaleItemItemQuantityPricingLevelDefines quantity pricing levels used for resale service items.
serviceResaleItemItemVendorLists vendors associated with resale service items for sourcing or resale tracking.
serviceResaleItemPresentationItemStores presentation information for resale service items in web stores or catalogs.
serviceResaleItemPriceMaintains pricing information for resale service items by customer segment or pricing level.
serviceResaleItemQuantityTracks inventory-related quantities for resale service items.
serviceResaleItemSiteCategoryLinks resale service items to site categories for web store placement.
serviceResaleItemSubsidiaryMapMaps resale service items to subsidiaries for use in multi-entity environments.
serviceResaleItemTaskTemplateAssociates task templates with resale service items for use in project-based selling.
serviceResaleItemTranslationHolds translated descriptions and names for resale service items.
serviceSaleItemCorrelateditemLists items frequently sold together with a given service sale item to support cross-selling strategies.
serviceSaleItemItemAccountingBookDetailStores accounting book-specific data for service sale items to support multi-book accounting.
serviceSaleItemItemQuantityPricingDiscountContains quantity-based discount tiers for service sale items, enabling volume-based pricing.
serviceSaleItemItemQuantityPricingLevelDefines pricing levels for service sale items based on the quantity purchased.
serviceSaleItemPresentationItemCaptures presentation details for service sale items in digital or printed catalogs.
serviceSaleItemPriceStores pricing records for service sale items, including pricing levels, currencies, and customer groups.
serviceSaleItemQuantityTracks inventory quantity attributes for service sale items when applicable.
serviceSaleItemSiteCategoryAssociates service sale items with specific categories on the web store for navigation and organization.
serviceSaleItemSubsidiaryMapMaps service sale items to one or more subsidiaries for use in multi-subsidiary setups.
serviceSaleItemTaskTemplateLinks reusable task templates to service sale items for project or service delivery workflows.
serviceSaleItemTranslationContains translated fields for service sale items to support multilingual implementations.
ShipGroupStores shipping group data, grouping line items with shared shipping preferences or addresses in transactions.
shipitemStores information about items that are eligible for shipping, including their attributes, classifications, and associated costs.
ShipItemFreeShippingItemContains entries defining which items qualify for free shipping promotions and under what conditions.
ShipItemHandlingRateSpecifies the handling rates applied to various items during shipment, often used for surcharge calculations.
ShipItemShippingRateOutlines the shipping rates applicable to specific items based on carrier agreements and item characteristics.
ShipItemTranslationStores localized descriptions and details for ship items, supporting multi-language capabilities in shipping documents.
ShipmentPackageHolds details about individual shipment packages, including dimensions, weight, and tracking information.
ShipperPackageTypeCodeDefines standardized codes representing different package types used by various shipping carriers.
shippingMethodRuleRelationMaps specific shipping methods to business rules that determine their applicability and restrictions.
ShippingPackageMaintains details about different types of packages used for shipping, including predefined sizes and weights.
shoppingcartTracks active shopping carts for users, including item lists, quantities, and preliminary order information.
ShoppingCartLineRecords individual items within shopping carts, detailing product IDs, quantities, prices, and associated metadata.
siteAudienceDefines various audience segments for targeting content or functionalities within the platform.
siteAudienceCustomerStores customer-specific audience data for personalized marketing and content delivery.
siteAudienceDepartmentIdentifies department-specific audience categories for internal and external content targeting.
siteAudienceEmployeeCategorizes employees into specific audience groups for internal communications and access control.
siteAudienceGroupLists defined audience groups, often used for targeted marketing or restricted access content.
siteAudiencePartnerContains audience definitions related to business partners, ensuring appropriate visibility and permissions.
siteAudienceRoleAssociates audience definitions with specific user roles within the platform.
siteAudienceSubsidiaryMaps audience segments to specific subsidiaries, enabling tailored experiences based on business divisions.
siteAudienceVendorCaptures vendor-specific audience groups for targeted communication or restricted access purposes.
sitecategoryDefines categories for organizing site content, enhancing user navigation and searchability.
siteCategoryPresItemPresCategoryLinks presentation items to their respective categories for structured content display.
siteCategoryTagSubstitutionProvides rules for substituting tags within category-based content displays.
siteCategoryTranslationSupports multi-language content by storing translated versions of category names and descriptions.
siteCategoryTypeDefines various types of categories used for classification and presentation of site content.
sitethemeStores information about various themes applied to site templates, including their design and layout details.
softDescriptorContains customizable descriptors used for transaction descriptions displayed on customer statements.
soldOnTransactionLogs details about items sold as part of transactions, including quantities, prices, and applied discounts.
solutionMaintains entries related to customer support solutions, including knowledge base articles and troubleshooting guides.
solutionSolutionMapMaps solutions to related topics or categories for easier access and reference.
solutiontopicmapLinks solutions to specific topics, enhancing searchability and organization of help documents.
specialAccountTypeDefines various account types with unique handling rules within financial transactions.
standardcostdefaulttypeSpecifies default cost types for standard costing calculations.
standardCostVersionTracks versions of standard cost calculations applied to various items over time.
standardCostVersionLocationMapLinks standard cost versions to specific locations for accurate costing.
statisticaljournalentryRecords statistical entries that are not directly tied to financial transactions but are used for analysis.
statisticalScheduleDetailProvides detailed breakdowns of statistical entries used for internal reporting.
stockBehaviorTypeDefines various stock behaviors such as stock-outs, replenishments, and adjustments.
storepickupfulfillmentTracks orders fulfilled via in-store pickup, including order status and readiness.
storeTabOrganizes tabs or sections displayed in online stores, enhancing user navigation and content presentation.
storeTabPresItemMaps presentation items to store tabs for better visibility and user experience.
storeTabSiteCategoryTranslationStoreTabHandles translated names of store tabs for multi-language compatibility.
storeTabTagSubstitutionDefines rules for replacing tags with appropriate substitutes within store tabs.
storeTabTypeDefines different types of store tabs for various presentation purposes.
sublistStores metadata about sublists used in various interfaces, defining their structure and content.
subscriptionStores active subscriptions, including plan details, renewal dates, and associated accounts.
subscriptionchangeorderLogs requests to modify existing subscriptions, such as upgrades, downgrades, or cancellations.
subscriptionChangeOrderNewLineLogs new line items added as part of subscription change orders.
subscriptionlineStores details about individual subscription lines, including services, products, and associated costs.
subscriptionLineStatusTracks the status of individual subscription lines, including active, canceled, or pending.
subscriptionMessageTypeDefines various message types associated with subscription communications and alerts.
subscriptionplanDefines available subscription plans, including pricing, terms, and included features.
subscriptionPlanSubsidiaryMapLinks subscription plans to specific subsidiaries for localized offerings.
subscriptiontermDefines the various terms available for subscriptions, such as monthly, yearly, or custom durations.
subscriptiontermunitMaps subscription terms to units of time for accurate billing and scheduling.
subsidiaryLists the various subsidiaries under an organization, including their details and associated financial data.
SubsidiaryMainAddressStores the primary addresses for each subsidiary within the organization.
SubsidiaryReturnAddressLogs return addresses associated with subsidiaries for order processing.
subsidiarysettingsManages various settings and configurations specific to each subsidiary.
SubsidiaryShippingAddressHolds shipping addresses for each subsidiary, used in logistics and distribution.
subsidiaryTaxRegistrationTracks tax registration details for subsidiaries, including applicable jurisdictions.
SUBSIDIARYTRANSLATIONStores localized translations of subsidiary names and descriptions for multilingual support.
subtotalitemRecords subtotal items used in transactions to organize and present grouped costs.
subtotalItemSubsidiaryMapLinks subtotal items to subsidiaries for accounting and reporting purposes.
subtotalItemTranslationSupports translations of subtotal item names for multi-language compatibility.
suiteletContains metadata about Suitelets, which are server-side scripts used to build custom UI pages and backend logic in NetSuite.
SuiteScriptDetailLogs details related to SuiteScript executions, including script IDs, deployment types, and associated records.
supplychainsnapshotProvides snapshots of supply chain data for reporting, analysis, and forecasting.
supplyChainSnapshotDetailsContains detailed breakdowns of supply chain snapshots, including items, quantities, and demand status.
supplychainsnapshotsimulationStores simulated supply chain scenarios to evaluate planning strategies.
supplychangeorderTracks changes made to supply orders, including modifications, cancellations, or amendments.
supplyplandefinitionDefines supply plans outlining production, procurement, and distribution strategies.
SupplyReplenishmentTypeCategorizes various replenishment methods, such as make-to-order or make-to-stock.
supportcaseLogs customer support cases, including issue descriptions, statuses, resolutions, and assigned agents.
supportCaseEscalateHistTracks the history of escalated support cases, including timestamps and responsible parties.
supportCaseEscalateToMapDefines mappings for support case escalation rules and their respective destinations.
supportCaseMediaItemMapLinks support cases to associated media items, such as attachments or screenshots.
supportCaseSolutionMapMaps resolved cases to their relevant solutions for knowledge base reference.
SystemEmailTemplateContains predefined email templates used for automated system notifications and communications.
SystemNoteLogs general system notes, including changes made to records by users or automated processes.
SystemNote2Serves as an extended logging mechanism for tracking changes made to records, providing detailed audit trails.
systemNoteContextTypeCategorizes system notes by their context, such as creation, modification, or deletion.
SystemNoteFieldLists the fields within records that are being tracked for changes and their corresponding metadata.
tagStores structured data related to tags, supporting various business operations.
taskStores information related to task management, including assignments, statuses, and relationships with other entities.
TaskCompanyMapMaps tasks to companies, facilitating task tracking and management.
TaskContactMapMaintains relationships between tasks and associated contacts, enabling efficient collaboration and follow-ups.
TaskEventFileStores files related to tasks and events, ensuring proper documentation and accessibility.
taxacctContains tax-related financial data, including tax codes, rates, and accounting classifications.
taxgroupOrganizes tax codes into groups for streamlined tax application in transactions.
taxItemTaxGroupLinks tax items to tax groups, ensuring correct tax application in financial transactions.
taxOverrideMethodDefines various methods for overriding default tax calculations in specific cases.
taxperiodTracks tax reporting periods, aiding in tax filing and compliance requirements.
taxtypeCategorizes different types of taxes applied to transactions, such as VAT, sales tax, or service tax.
termDefines financial terms, such as payment terms and conditions for transactions.
TerminationregrettedLogs regretted employee terminations, tracking reasons and impacts on the organization.
testCellStores test-related data, often used for quality control or development purposes.
ThreeDSECommerceIndicatorManages indicators for 3D Secure authentication in online transactions.
ThreeDSTranStatusRecords transaction authentication statuses for 3D Secure (3DS) verification.
ThreeDSTranStatusReasonProvides detailed reasons for 3D Secure transaction authentication statuses.
ThreeDSVersionTracks different versions of the 3D Secure authentication protocol used in transactions.
timebillRecords time billing data, tracking billable hours for projects and services.
timeentryTracks employee time logs, including work hours, approvals, and related data.
timeLineApprovalStatusTracks time-related approval statuses, indicating whether a timeline is approved, pending, or rejected.
TimelineTypeDefines different types of timelines used for scheduling, planning, and tracking activities.
timeOffAccrualFrequencyTracks time-off accrual frequencies, specifying how often employees accumulate leave time.
timeOffAccrualTypeDefines accrual types for time off, such as vacation, sick leave, and personal days.
timeoffrequestStores records of employee time-off requests, including approval status and requested dates.
timeOffRequestDetailsMachineProcesses detailed time-off request data, including policy validations and automated calculations.
timesheetRecords employee work hours, tracking regular, overtime, and project-based time logs.
TimeZoneStores time zone information used for scheduling and localization of timestamps.
topicManages discussion topics, categorizing and organizing information for collaboration and knowledge sharing.
topicPublishHandles publishing of discussion topics, controlling visibility and access permissions.
topicSolutionMapMaps topics to solutions, linking discussion threads with corresponding answers or resources.
TrackingNumberStores tracking numbers for shipments, linking them to orders and logistics records.
TrackingNumberMapMaps tracking numbers to specific shipments, ensuring accurate delivery monitoring.
tranPromotionTracks promotions applied to transactions, including discounts and special offers.
transactionStores financial transaction records, linking them to customers, vendors, and accounts.
TransactionAccountingLineRecords accounting line items for transactions, detailing debits and credits for bookkeeping.
TransactionAccountingLineCostComponentTracks cost components within transaction accounting lines, breaking down cost structures.
transactionAddressbookManages address book entries linked to transactions, including billing and shipping details.
transactionAddressMappingMaps transaction records to specific address entries, ensuring accurate delivery and invoicing.
transactionAddressMappingAddressLinks address records to mapped transaction addresses for consistency in order processing.
transactionBillingHolds records of billing details associated with financial transactions, including payment terms and due amounts.
transactionBillingAddressStores billing address information linked to transaction records for invoicing purposes.
transactionBillingAddressbookManages billing address book entries used in financial transactions.
transactionBillingAddressbookEntityAddressLinks entity addresses to billing address book records, ensuring accurate invoicing.
transactionCompetitorTracks competitor involvement in transactions, providing insights into competitive pricing and bidding.
transactionLineStores individual line items within a financial transaction, detailing products, quantities, and pricing.
transactionLineAddressMappingMaps transaction lines to specific address records, ensuring correct shipping and billing details.
transactionLineAddressMappingLineAddressLinks line items in transactions to detailed address mapping records.
TransactionNumberingAuditLogMaintains a log of transaction numbering changes for audit and compliance tracking.
transactionPartnerStores details about business partners involved in transactions, such as vendors or resellers.
transactionPayeeAddressbookManages address book entries for payees in financial transactions.
transactionPayeeAddressbookEntityAddressAssociates payee addresses with specific entities in financial transactions.
transactionReturnAddressbookStores return address records linked to transactions, facilitating product returns and refunds.
transactionReturnAddressbookEntityAddressMaps entity addresses to return address book entries for consistent handling of returns.
transactionSalesTeamTracks sales team members associated with transactions, including commission structures and assignments.
TransactionShipmentStores shipment details linked to transactions, tracking delivery status and logistics.
transactionShippingAddressRecords shipping address details linked to transactions for order fulfillment.
transactionShippingAddressbookManages shipping address book records used in transactions.
transactionShippingAddressbookEntityAddressLinks entity addresses to shipping address book entries for consistency in deliveries.
transactionStatusTracks the status of financial transactions, including pending, approved, and completed stages.
transferorderStores records of transfer orders, facilitating the movement of inventory between locations.
transferOrderLinkedTrackingNumberMapMaps tracking numbers to specific transfer orders for shipment tracking.
transferOrderShippingAddressStores shipping address details associated with transfer orders for delivery accuracy.
transferOrderTrackingNumberMapLinks tracking numbers to transfer orders, ensuring accurate logistics management.
UnbilledReceivableGroupingGroups unbilled receivables, helping in financial reporting and invoice generation.
undeliveredEmailTracks undelivered emails, capturing failed email communications and bounce reasons.
unitstypeDefines unit types used in measurements for inventory and transaction processing.
unitsTypeUomStores Unit of Measure (UOM) definitions linked to unit types for product categorization.
unlockedtimeperiodTracks financial time periods that are unlocked for modifications in accounting systems.
upsellItemManages upsell items linked to products, suggesting additional purchases during sales transactions.
usageRecords usage data, tracking consumption-based billing or system interactions.
UserAuthorizationConsentStores records of user authorization and consent agreements for data privacy compliance.
usereventscriptTracks user event scripts executed within the system, monitoring workflow automation.
UserOAuthTokenManages OAuth tokens used for user authentication and secure API access.
usrsavedsearchStores user-saved search queries, allowing quick retrieval of frequently used searches.
usrsavedsearchexecTracks execution details of user-saved searches, providing audit and performance insights.
validatePostbackStatusContains records tracking the status of postback validations in NetSuite, ensuring data integrity in external communications.
vendorStores detailed information about vendors, including company details, contact information, and relationships within NetSuite.
vendorAchAcctMaintains vendor ACH (Automated Clearing House) account details for electronic payments, streamlining financial transactions.
vendorAddressbookHolds vendor address book entries, including primary and secondary addresses, for streamlined vendor communication.
vendorAddressbookEntityAddressLinks vendor address book entries to specific entities, ensuring accurate address association and reporting.
vendorbillRecords vendor bills issued for goods and services, tracking payment status, due dates, and financial impact.
vendorBillBillingAddressStores billing addresses linked to vendor bills, ensuring correct invoicing and payment processing.
vendorBillExpenseMachineTracks expenses related to vendor bills, categorizing costs for financial analysis and reporting.
VendorBillInstallmentManages installment payment details for vendor bills, allowing structured payment plans.
vendorBulkMergeHandles bulk merging of vendor records, preventing duplicate entries and maintaining data integrity.
vendorCampaignsStores vendor-specific marketing campaigns and interactions to track engagement and business relationships.
vendorcategoryCategorizes vendors into predefined groups, aiding in reporting and procurement analysis.
vendorCompanyContactLinks vendors to specific company contacts, facilitating business communication and relationship management.
vendorcreditTracks credits issued to vendors, including refunds, discounts, and other credit transactions.
vendorCreditBillingAddressStores billing addresses associated with vendor credits for accurate financial tracking.
vendorCreditExpenseMachineManages expense details linked to vendor credits, ensuring correct financial allocations.
vendorCurrencyBalanceTracks the balance of vendor accounts in different currencies, assisting in international transactions.
vendorpaymentRecords vendor payments, including payment methods, amounts, and transaction details.
vendorPaymentPayeeAddressStores addresses associated with vendor payments, ensuring accurate financial transactions.
vendorprepaymentManages prepayments made to vendors before invoicing, assisting in financial planning.
vendorprepaymentapplicationTracks the application of vendor prepayments to invoices, ensuring proper allocation of funds.
vendorRateStores vendor-specific rate details for services or goods, aiding in pricing negotiations.
vendorRequestForQuoteItemItemPricingTracks item pricing details linked to vendor requests for quotes, supporting procurement processes.
vendorRequestForQuoteItemItemPricingDiscountRecords discount details associated with vendor request for quote items, aiding in cost analysis.
vendorreturnauthorizationTracks vendor return authorizations, ensuring proper processing of returned goods.
vendorReturnAuthorizationBillingAddressStores billing address details for vendor return authorizations, assisting in financial reconciliation.
vendorReturnAuthorizationExpenseMachineManages expenses associated with vendor return authorizations, ensuring correct cost tracking.
vendorRolesForSearchStores vendor roles for search functionality, assisting in access management and permissions.
vendorSubscriptionMessageHistoryThis table stores the history of messages related to vendor subscriptions, including timestamps, status, and message content.
vendorSubscriptionsContains information about vendor subscriptions, tracking vendor participation in different subscription-based services.
vendorsubsidiaryrelationshipDefines the relationship between vendors and subsidiaries, enabling multi-subsidiary vendor management in NetSuite.
verificationMatchCodeStores verification match codes used in authentication or data validation processes within NetSuite.
vsoeDeferralTypeMaintains records of VSOE (Vendor-Specific Objective Evidence) deferral types used in revenue recognition processes.
vsoeDiscountTypeTracks different types of VSOE discounts, which help determine revenue allocations for bundled software arrangements.
vsoeSopGroupTypeDefines VSOE SOP (Statement of Position) group types, categorizing accounting rules applied to software contracts.
waveRepresents a collection or batch of orders processed together in logistics and fulfillment workflows.
wbsStores work breakdown structure (WBS) elements, which help in project management by defining task hierarchies.
WbsAmountContains financial amounts associated with specific WBS elements, supporting cost tracking in project accounting.
WbsLineDetails individual lines within a WBS structure, providing granular data for project management and costing.
websiteHolds data related to website configurations, including settings, domain mappings, and metadata.
webSiteFieldsetRecordTypeDefines the types of fieldsets used within website records, structuring web-related data in NetSuite.
winlossreasonCaptures reasons for winning or losing deals, assisting in sales performance analysis and forecasting.
workCalendarManages company work calendars, specifying working days, hours, and scheduling rules.
workCalendarHolidayStores records of holidays within work calendars, ensuring accurate scheduling and time-off calculations.
workflowactionscriptContains workflow action scripts that automate processes and execute custom logic within NetSuite workflows.
workorderRepresents work orders issued for production or maintenance processes, tracking materials and labor usage.
workordercloseStores information about closed work orders, including completion details and final statuses.
workordercompletionTracks completed work orders, logging production outputs and associated costs.
workorderissueRecords issues encountered in work orders, aiding in troubleshooting and process improvement.
workOrderPartnerLinks work orders to specific partners, facilitating collaboration and resource management
workOrderSalesTeamAssociates work orders with sales teams, allowing revenue tracking and commission calculations.
workplaceDefines workplace locations within NetSuite, used for employee assignments and logistical planning.
WorkplaceMainAddressStores main address details for workplaces, supporting facility management and reporting.
zoneRepresents different zones within a warehouse or business location, aiding in inventory and space management.

account 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe system-generated identifier for the account record (Id). This Id is used internally for database indexing, relationship mapping, and uniquely distinguishing accounts within NetSuite.
accountsearchdisplaynameStringFalseNoThe display name of the account, which appears in search results and lists for easier identification. This name can differ from the official account name to improve usability.
accountsearchdisplaynamecopyStringFalseNoA duplicate of the account's primary name, often used for reporting consistency and alternative naming conventions in different system views.
acctnumberStringFalseNoThe unique account number assigned to the general ledger account. This number is used in financial transactions, reporting, and reconciliation processes.
accttypeStringFalseNoThe financial category assigned to the account, determining its function in accounting processes. Common types include Asset, Liability, Equity, Income, and Expense. These types dictate how transactions impact financial statements.
billableexpensesacctStringFalseNoThe designated general ledger account used to track billable expenses. This account ensures that reimbursable costs incurred on behalf of customers are properly recorded and included in invoices.
cashflowrateStringFalseNoThe method that is used to categorize the account’s impact on cash flow, affecting financial planning and cash management strategies. Common classifications include Operating, Investing, and Financing activities.
category1099miscStringFalseNoThe IRS 1099-MISC tax category assigned to the account, used for tracking reportable payments to vendors and independent contractors. This classification is necessary for tax compliance and annual reporting.
classStringFalseNoA classification used to segment transactions by department, division, or function for internal reporting and budgeting purposes. This classification helps organizations analyze financial data across different operational areas.
currencyStringFalseNoThe currency in which transactions for this account are recorded. This currency is particularly relevant for multi-currency environments where financial activities occur in different denominations.
deferralacctStringFalseNoThe general ledger account used for revenue or expense deferrals. Deferral accounts are crucial for recognizing revenue and expenses in the correct accounting period under accrual accounting principles.
departmentStringFalseNoThe department associated with this account, allowing transactions to be allocated to specific organizational units. Departments help track financial performance at a more granular level.
descriptionStringFalseNoA detailed explanation of the account’s purpose, usage, and role in financial transactions. This explanation helps users understand the function of the account within the chart of accounts.
displaynamewithhierarchyStringFalseNoThe display name of the account, including its position within a hierarchical structure. This name is useful for organizations that use parent-child account relationships to organize financial data.
eliminateBooleanFalseNoIndicates whether intercompany transactions involving this account should be eliminated during financial consolidation. This value is used to prevent double counting of revenue or expenses in multi-entity organizations.
externalidStringFalseNoA unique Id assigned to the account by an external system, enabling seamless integration and data exchange with third-party applications.
fullnameStringFalseNoThe complete name of the account, including any hierarchical context. This name helps users identify the account’s role in financial reporting when multiple accounts have similar names.
generalrateStringFalseNoThe default rate type assigned to transactions for this account, used in financial calculations, allocations, and revenue recognition models.
includechildrenBooleanFalseNoIndicates whether financial data from child accounts should be included in reports for this account. Used in roll-up reporting where summary accounts aggregate data from multiple subaccounts.
inventoryBooleanFalseNoSpecifies whether the account is linked to inventory management. If the value is 'true', this account is involved in tracking stock levels, cost of goods sold (COGS), and inventory valuation.
isinactiveBooleanFalseNoIndicates whether the account is marked as inactive. Inactive accounts are hidden from selection in transactions but remain in historical records for auditing and reporting purposes.
issummaryBooleanFalseNoIndicates whether the account functions as a summary account, aggregating financial data from multiple subaccounts rather than recording direct transactions.
locationStringFalseNoThe specific geographic or operational location assigned to the account. This location is used for regional financial tracking and compliance with location-based reporting requirements.
parentStringFalseNoThe parent account within a hierarchical chart of accounts. This structure is used for financial roll-ups where subaccounts report to a higher-level account.
restricttoaccountingbookStringFalseNoSpecifies whether this account is limited to a specific accounting book. This value is used in multi-book accounting environments where different financial ledgers operate under distinct reporting standards.
revalueBooleanFalseNoIndicates whether foreign currency balances in this account should be revalued based on fluctuating exchange rates. This value is essential for companies dealing with multi-currency transactions to ensure accurate financial reporting.
sbankcompanyidStringFalseNoThe company-assigned Id for a linked bank account. This Id is used for payment processing, reconciliations, and electronic funds transfers (EFT).
sbanknameStringFalseNoThe name of the financial institution where the account is held. This name is used in banking transactions, reconciliations, and electronic payments.
sbankroutingnumberStringFalseNoThe bank routing number associated with the account, used for processing wire transfers, ACH transactions, and direct deposits.
sspecacctStringFalseNoSpecifies whether this account is designated as a special account type, such as a clearing account, suspense account, or system-generated control account.
subsidiaryStringFalseNoThe subsidiaries that use this account for financial transactions. This information is relevant for multi-entity organizations to ensure proper financial tracking and reporting across different business units.

Return to Top

AccountContextSearch 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe unique identifier (Id) or name of the account being referenced. This Id is used to associate transactions and financial data with the appropriate general ledger account.
accountingcontextStringFalseNoThe specific accounting context applied to the account, defining the financial framework in which transactions are processed. This context ensures consistency in multi-book accounting and regulatory compliance.
acctnameStringFalseNoThe official name of the account as it appears in the financial system. This name helps users identify accounts in reports, searches, and financial statements.
localeStringFalseNoThe language setting associated with the account for localization purposes. This setting determines how account-related data is displayed in different regions and languages.

Return to Top

accountingbook 

NameTypeReadOnlyReferencesFilterOnlyDescription
basebookStringFalseNoThe base accounting book associated with this record, defining the primary ledger where financial transactions are recorded. This field ensures accurate financial reporting and compliance with accounting standards by distinguishing among different sets of books, such as GAAP, IFRS, or tax-based accounting.
customformStringFalseNoThe custom form used for this record, allowing organizations to tailor the layout and fields displayed when entering or viewing financial data. This field ensures that accounting entries align with company-specific workflows and reporting requirements.
effectiveperiodStringFalseNoThe accounting period during which this record is valid, determining the time frame for financial transactions. This field ensures that revenues, expenses, and adjustments are recognized in the correct reporting period based on accrual or cash accounting principles.
externalidStringFalseNoThe unique identifier (Id) assigned to this record by an external system, such as an ERP, CRM, or third-party financial application. This field facilitates seamless data exchange and integration between NetSuite and other platforms for consistent financial tracking.
includechildrenBooleanFalseNoIndicates whether this record applies to child entities within the organizational hierarchy, such as subsidiaries or divisions. This setting ensures that financial structures, consolidation rules, and reporting frameworks are consistently applied across related entities.
isadjustmentonlyBooleanFalseNoIndicates whether this record is restricted to adjustments only, meaning it cannot be used for standard transactions. This field ensures that specific accounts or books are reserved exclusively for financial corrections, reallocations, or reconciliation adjustments without affecting operational entries.
isconsolidatedBooleanFalseNoIndicates whether this record is included in financial consolidation processes, allowing multiple entities' financial results to be aggregated. This setting ensures that organizations with multiple subsidiaries can generate consolidated financial statements while eliminating intercompany transactions where applicable.
isprimaryBooleanFalseNoIndicates whether this record represents the primary accounting book for the entity, which is used as the default for financial transactions. This value ensures that accounting entries are automatically recorded in the main ledger unless a secondary book is specified for multi-book accounting compliance.
nameStringFalseNoThe official name assigned to this record, which is used for identification in searches, reports, and system processes. This name ensures consistency in financial documentation and improves usability when managing multiple accounting books.
statusStringFalseNoThe current status of this record, indicating whether it is active, inactive, or pending. This status determines whether the record is available for use in financial transactions and reporting, ensuring proper control over outdated or restricted entries.
subsidiaryStringFalseNoThe subsidiary associated with this record, defining the legal entity under which transactions are recorded. This value ensures that financial data is accurately attributed to the appropriate business unit, supporting multi-entity accounting and compliance with regional financial regulations.

Return to Top

accountingcontext 

NameTypeReadOnlyReferencesFilterOnlyDescription
externalidStringFalseNoThe unique identifier (Id) assigned to this accounting context by an external system. This Id ensures seamless integration with third-party applications, enabling consistent financial data exchange and synchronization across multiple platforms.
nameStringFalseNoThe official name of the accounting context, representing a specific financial framework or reporting structure. This field helps differentiate between various accounting contexts used for multi-book accounting, regulatory compliance, or internal financial management.

Return to Top

accountingperiod 

NameTypeReadOnlyReferencesFilterOnlyDescription
alllockedBooleanFalseNoIndicates whether all transaction types are locked for this accounting period. This setting prevents any modifications, ensuring that financial reports remain accurate and compliant after period close.
allownonglchangesBooleanFalseNoIndicates whether non-general ledger (non-GL) changes are permitted for this accounting period. This setting allows modifications to transactions that do not impact the general ledger, such as memo fields or classifications.
aplockedBooleanFalseNoIndicates whether accounts payable (AP) transactions are locked for this accounting period. This setting prevents any modifications to vendor bills, payments, or related AP transactions after the period has closed.
arlockedBooleanFalseNoIndicates whether accounts receivable (AR) transactions are locked for this accounting period. This restriction ensures that invoices, customer payments, and other AR transactions cannot be modified after closing.
closedBooleanFalseNoIndicates whether the accounting period has been officially closed. A closed period prevents further financial activity and ensures compliance with financial reporting standards.
closedondateDateFalseNoThe date on which the accounting period was officially closed. This date helps track when financial statements were finalized and locked for auditing purposes.
enddateDateFalseNoThe last date of the accounting period, defining the range for financial reporting. This date determines when transactions are no longer recorded for this period.
fiscalcalendarStringFalseNoThe fiscal calendar to which this accounting period belongs. This calendar setting ensures that financial reporting aligns with an organization's designated fiscal year structure.
isadjustBooleanFalseNoIndicates whether this period is designated for adjustments only. Adjustment periods are typically used for post-closing corrections and financial reconciliations without affecting operational periods.
isinactiveBooleanFalseNoIndicates whether the accounting period is inactive. An inactive period is not available for new transactions but remains in historical records for reference and auditing.
ispostingBooleanFalseNoIndicates whether the period allows posting of financial transactions. Posting periods enable the entry of general ledger transactions, while non-posting periods can be reserved for reporting or adjustments.
isquarterBooleanFalseNoIndicates whether this period represents a fiscal quarter. Quarterly periods are used for interim financial reporting and regulatory compliance.
isyearBooleanFalseNoIndicates whether this period represents a fiscal year. Annual accounting periods are critical for financial statement preparation, tax reporting, and year-end closing processes.
parentStringFalseNoThe parent accounting period in a hierarchical structure. This period is used for organizing periods within fiscal years, ensuring proper financial consolidation.
payrolllockedBooleanFalseNoIndicates whether payroll transactions are locked for this accounting period. This setting ensures that employee payroll records and tax filings remain unchanged after processing.
periodnameStringFalseNoThe official name of the accounting period, used in financial reporting and transaction processing. This name typically follows a structured format, such as 'Q1 2025' or 'January 2025'.
startdateDateFalseNoThe first date of the accounting period, defining when financial transactions begin to be recorded for that period. This date establishes the reporting range for financial activities.

Return to Top

accountingperiodfiscalcalendars 

NameTypeReadOnlyReferencesFilterOnlyDescription
parentStringFalseNoThe parent accounting period in a hierarchical fiscal structure. This field links the accounting period to a broader financial timeframe, such as a fiscal quarter or year, ensuring accurate financial consolidation and reporting.
fiscalcalendarStringFalseNoThe fiscal calendar associated with the accounting period. This field defines the organization’s financial year structure, ensuring that accounting periods align with company policies, tax requirements, and regulatory compliance.
accountingperiodStringFalseNoThe specific accounting period within the designated fiscal calendar. This field ensures that financial transactions are recorded within the correct period, supporting accurate financial reporting and period-based analysis.

Return to Top

accountLocalization 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with this localization record, identifying the general ledger account in the financial system. This field ensures that transactions are recorded under the appropriate account within a specific localization framework.
accountingcontextStringFalseNoThe accounting context defining the financial framework under which this account operates. This context ensures that the account is aligned with the correct set of accounting rules, financial reporting standards, and multi-book accounting structures.
acctnameStringFalseNoThe official name of the account as it appears in financial records and reporting. This account name helps users differentiate between accounts when managing localized financial statements.
legalnameStringFalseNoThe legally registered name of the entity associated with the account. This name is used for regulatory reporting, tax compliance, and financial disclosures to ensure that financial records align with legal entity requirements.
localeStringFalseNoThe language and regional settings associated with the account localization. These settings ensure that financial data, reports, and system labels are displayed in the correct language and format for compliance with local accounting standards.

Return to Top

AccountSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account associated with a specific subsidiary. This field ensures that financial transactions are properly attributed to the correct legal entity within a multi-subsidiary organization, supporting accurate financial consolidation and reporting.

Return to Top

accountType 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoThe system-generated unique identifier (Id)for the account type record. This Id is used internally for indexing, relationship mapping, and database reference to ensure data integrity.
balancesheetBooleanFalseNoIndicates whether this account type is classified as a balance sheet account. This setting determines whether the account appears on the balance sheet or the income statement, affecting financial statement presentation and reporting.
defaultcashflowratetypeStringFalseNoThe default cash-flow rate type that is assigned to this account type. This type determines how transactions using this account type are categorized in cash flow statements, aiding in liquidity and cash management analysis.
defaultgeneralratetypeStringFalseNoThe default general rate type that is associated with this account type. This type defines how financial transactions are treated within specific accounting methodologies and reporting frameworks.
eliminationalgoStringFalseNoThe elimination algorithm used for intercompany transactions when consolidating financial statements. This algorithm ensures that intercompany balances and transactions are correctly removed to prevent double counting in multi-entity financial reporting.
idStringFalseNoThe unique Id for the account type, which can be used for external integrations, reporting, and system references. This Id allows consistent categorization of accounts across various financial processes.
includeinrevaldefaultBooleanFalseNoIndicates whether accounts of this type should be included in foreign currency revaluation by default. This setting ensures that accounts subject to currency fluctuations are appropriately revalued for accurate financial reporting.
leftBooleanFalseNoIndicates whether this account type appears on the left side of financial reports, typically associated with asset or debit accounts. This setting impacts financial statement formatting and presentation.
longnameStringFalseNoThe full descriptive name of the account type. This name provides a clearer understanding of the account type's purpose, making it easier for users to categorize accounts correctly.
seqnumIntegerFalseNoThe sequence number that determines the display order of this account type in reports and financial statements. This sequence number ensures that account types are presented in a logical, structured manner for readability and compliance.

Return to Top

activity 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe system-generated identifier (Id) that uniquely distinguishes each activity record within NetSuite. This Id is used as the primary key for referencing and data relationships.
activityIntegerFalseNoThe Id that links the record to a specific customer relationship management (CRM) or project-related activity, such as tasks, phone calls, or events tracked within the system.
bomIntegerFalseNoThe Id that references the Bill of Materials (BOM) that is associated with the activity. This Id supports traceability in manufacturing or planning workflows.
bomrevisionIntegerFalseNoThe Id that specifies the revision level of the associated BOM. This Id allows for version tracking and configuration control.
companyIntegerFalseNoThe Id for the company or customer that is involved in the activity. This Id supports relationship tracking and CRM integration.
completeddateDateFalseNoThe date on which the activity was marked as completed. This date provides visibility into progress and performance tracking.
contactIntegerFalseNoThe Id that associates the activity with a specific contact. This Id enables detailed CRM engagement and interaction history.
createddateDateFalseNoThe date on which the activity record was created in the system. This field supports audit trails and time-based analysis.
externalidStringFalseNoAn optional, user-defined external Id that is used to integrate or map the activity to records in external systems or applications.
lastmodifieddateDatetimeFalseNoThe timestamp of the most recent update to the activity record. This field supports synchronization, version control, and audit purposes.
mfgroutingIntegerFalseNoThe Id that links the activity to a specific manufacturing routing record. This Id is used in production planning and execution workflows.
relateditemIntegerFalseNoThe Id for the inventory item or assembly item that is related to the activity. This Id aids in material planning, traceability, and reporting.
reminderminutesStringFalseNoThe number of minutes prior to the scheduled activity start time that a reminder should be triggered. Values include '5', '10', '15', '30', '60', and '120'.
remindertypeStringFalseNoThe delivery method or format of the reminder that is associated with the activity. Values include 'popup', 'email', and 'SMS'.
startdateDateFalseNoThe date when the activity is scheduled to begin. This date is used in scheduling, calendar views, and resource planning.
statusStringFalseNoThe current state of the activity, such as 'Not Started', 'In Progress', or 'Completed'. This field is used for workflow tracking and reporting.
supportcaseIntegerFalseNoThe Id that links the activity to a specific support case. This Id enables contextual visibility within the customer service process.
timedeventBooleanFalseNoA Boolean flag that indicates whether the activity is time-based ('true') or not ('false'). This flag is used in calendar displays and time management.
titleStringFalseNoThe subject or title of the activity. This field provides a brief and descriptive label for easy identification in lists and reports.
transactionIntegerFalseNoThe Id that links the activity to a transaction record, such as a sales order or invoice, for contextual insights and follow-ups.
typeStringFalseNoThe classification of the activity, such as 'task', 'call', or 'meeting'. This value defines the behavior, icons, and available fields in NetSuite workflows.

Return to Top

address 

NameTypeReadOnlyReferencesFilterOnlyDescription
addr1StringFalseNoThe first line of the street address, which typically contains primary address details such as a street number, street name, or building name. This field is critical for identifying the main physical location of an entity for billing, shipping, or legal purposes.
addr2StringFalseNoThe second line of the street address, often used for additional details such as apartment, suite, unit, or floor numbers. This field ensures that deliveries, invoices, and correspondence are directed to the correct subdivision of a building or complex.
addr3StringFalseNoThe third line of the street address, if applicable. This field is used for extended address information. It provides flexibility for regions with complex address structures, such as rural areas or countries requiring additional address details.
addresseeStringFalseNoThe name of the person, company, or entity associated with the address. This field ensures that documents, shipments, or communications are directed to the intended recipient, reducing errors in delivery or processing.
addressformatStringFalseNoThe standardized format applied to the address based on country-specific requirements. This field determines how the address is displayed in invoices, shipping labels, tax forms, and other documents to ensure compliance with local and international formatting standards.
addrphoneStringFalseNoThe phone number associated with the address, typically used for contacting the recipient regarding shipments, invoices, or verification purposes. This phone number is essential for logistics, customer service, and emergency contact scenarios.
addrtextStringFalseNoThe full formatted address stored as a single text string, combining all address components into a readable format. This field is useful for display purposes in reports, customer records, and automated communications.
attentionStringFalseNoThe name of a specific individual or department at the address who should receive attention. This field is commonly used for business addresses where a particular person, role, or team needs to be notified or contacted for deliveries, invoices, or legal notices.
cityStringFalseNoThe city associated with the address, providing essential geographical information for shipping, billing, and tax calculations. This field is required for most mailing and regulatory purposes to ensure location accuracy.
countryStringFalseNoThe country associated with the address, determining international shipping rules, tax jurisdictions, and regional compliance. This field ensures that address formatting follows the correct country-specific postal standards.
customformStringFalseNoThe custom form associated with this address record, allowing businesses to use a tailored form layout for address entry and management. This field supports company-specific workflows for data capture, validation, and integration with external systems.
externalidStringFalseNoThe unique identifier (Id) assigned to the address record by an external system. This Id enables seamless data synchronization between NetSuite and third-party applications, ensuring consistency across integrated platforms such as customer relationship management (CRM), enterprise resource planning (ERP), or e-commerce systems.
overrideBooleanFalseNoIndicates whether default address formatting should be overridden to allow manual adjustments. This setting ensures that exceptions, such as nonstandard addresses, can be correctly formatted while maintaining system compatibility.
stateStringFalseNoThe state, province, or region associated with the address, used for regional categorization in shipping, taxation, and compliance. This field ensures that addresses are properly validated for jurisdictional rules, tax calculations, and regulatory reporting.
zipStringFalseNoThe postal or ZIP code for the address, providing location-based categorization for mail delivery, tax determination, and service eligibility. This field ensures that addresses are accurately classified for domestic and international transactions.

Return to Top

addressType 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoThe classification or purpose of the address within the system. This classification defines whether the address is used for billing, shipping, corporate headquarters, or other business, ensuring accurate processing in transactions and reports.

Return to Top

AdmissibilityPackageType 

NameTypeReadOnlyReferencesFilterOnlyDescription
codeStringFalseNoThe unique code representing a specific package type classification. This code is used to standardize package categories for shipping, customs clearance, and logistics management.
inactiveBooleanFalseNoIndicates whether the package type is inactive and no longer available for use. This setting prevents obsolete package classifications from being used in shipping transactions while retaining historical data for reporting.
keyIntegerFalseNoThe system-generated identifier (Id) for the package type record. This Id uniquely distinguishes each package type within the database, enabling efficient reference and lookup in shipping and regulatory processes.
nameStringFalseNoThe official name of the package type as recognized in shipping and customs documentation. This official name ensures consistency in categorizing packages across different carriers, regulatory bodies, and logistics workflows.
shipperStringFalseNoThe carrier or shipping provider associated with this package type. This field ensures that package classifications align with carrier-specific requirements, helping streamline shipping operations and compliance with transport regulations.

Return to Top

advintercompanyjournalentry 

NameTypeReadOnlyReferencesFilterOnlyDescription
approvedBooleanFalseNoIndicates whether the intercompany journal entry has been approved. This value ensures that only authorized financial transactions are recorded in the system, adhering to approval workflows and compliance requirements.
createddateDatetimeFalseNoThe date and time when the intercompany journal entry was created. This timestamp provides an audit trail for financial transactions and ensures accurate record-keeping.
createdfromStringFalseNoThe source transaction or record from which this intercompany journal entry was generated. This field helps track the origin of financial adjustments and supports auditability.
credittotalDecimalFalseNoThe total credit amount that is recorded in the journal entry. This field ensures proper balance between debits and credits in financial transactions.
currencyStringFalseNoThe currency in which the intercompany journal entry is recorded. This currency name ensures that transactions reflect the appropriate monetary denomination for international financial reporting.
customformStringFalseNoThe custom form that is used for this journal entry. This field allows organizations to tailor the layout and fields for journal entry transactions based on specific business needs.
debittotalDecimalFalseNoThe total debit amount that is recorded in the journal entry. This field ensures that the financial entry maintains correct balance in the accounting system.
entitynexusStringFalseNoThe tax jurisdiction or nexus associated with the entity initiating the journal entry. This field ensures compliance with regional tax regulations for intercompany transactions.
expenseallocjournalcountStringFalseNoThe number of expense-allocation journal entries related to this transaction. This number helps track cost distributions across different entities or departments.
externalidStringFalseNoThe unique identifier (Id) assigned to this journal entry by an external system. This Id facilitates data integration and synchronization with third-party financial applications.
isbasecurrencyBooleanFalseNoIndicates whether the transaction is recorded in the subsidiary’s base currency. This setting ensures accurate currency conversion and financial reporting for multinational entities.
iscustomapprovalBooleanFalseNoIndicates whether this journal entry follows a custom approval workflow. This setting ensures that organization-specific approval rules are enforced before the transaction is posted.
lastmodifieddateDatetimeFalseNoThe date and time when the journal entry was last modified. This timestamp provides an audit trail and helps track changes to financial records.
memoStringFalseNoA free-text field used to enter a description or note about the intercompany journal entry. This field provides context for the transaction, making it easier to understand in financial reports.
nexusStringFalseNoThe tax jurisdiction under which the journal entry is recorded. This information is critical for ensuring compliance with tax regulations across different regions.
parentexpenseallocStringFalseNoThe reference to the primary expense allocation entry linked to this journal entry. This reference helps track hierarchical relationships between expense allocations.
postingperiodStringFalseNoThe financial period in which the journal entry is posted. This field ensures that transactions are recorded in the correct reporting period for accurate financial statements.
reversaldateDateFalseNoThe date on which this journal entry is scheduled to be reversed. This date ensures that temporary or correcting entries are properly nullified at the designated time.
reversaldeferBooleanFalseNoIndicates whether the reversal of this journal entry is deferred to a later period. This setting ensures that corrections are timed appropriately for financial reporting.
statusStringFalseNoThe current status of the journal entry, such as Pending Approval, Approved, or Posted. This status helps track the progress of the transaction in the accounting workflow.
subsidiaryStringFalseNoThe subsidiary responsible for this journal entry. This information ensures that financial data is properly attributed to the correct legal entity in a multi-subsidiary organization.
taxperiodStringFalseNoThe tax reporting period in which this journal entry is recorded. This field ensures that financial transactions align with tax filing and reporting schedules.
tosubsidiariesStringFalseNoThe subsidiaries that receive allocations or adjustments from this journal entry. This field ensures accurate financial consolidation across multiple entities.
trandateDateFalseNoThe transaction date of the journal entry. This date determines when the financial impact of the transaction is recognized in accounting records.
tranidStringFalseNoThe system-generated Id for the journal entry. This Id provides a unique reference for tracking and retrieving financial transactions.
transactionnumberStringFalseNoThe unique transaction number assigned to this journal entry. This transaction number ensures clear identification and organization of journal transactions within the accounting system.

Return to Top

aggregateItemLocation 

NameTypeReadOnlyReferencesFilterOnlyDescription
atpleadtimeIntegerFalseNoThe available-to-promise (ATP) lead time for the item at the specified location. This field determines the estimated number of days required to fulfill an order based on current and expected inventory availability.
averagecostmliDecimalFalseNoThe average cost per unit of the item at the specified location. This value is calculated based on historical purchase costs, production costs, and inventory valuation methods.
backwardconsumptiondaysIntegerFalseNoThe number of days before a forecasted demand date that inventory consumption can be applied. This setting ensures proper demand allocation by considering past inventory usage patterns.
costDecimalFalseNoThe standard cost assigned to the item at this location. This value is used for inventory valuation, cost accounting, and financial reporting.
costaccountingstatusStringFalseNoThe current cost accounting status of the item at this location. This status helps track whether the cost is under review, approved, or pending updates.
costinglotsizeDoubleFalseNoThe lot size used for cost calculations in this location. This lot size determines the economic order quantity (EOQ) for cost accounting and inventory planning.
currentstandardcostDecimalFalseNoThe most recently defined standard cost for the item at this location. This cost is used for financial reporting and inventory valuation.
currentstandardcosteffectivedateDateFalseNoThe date on which the current standard cost became effective. This date ensures accurate cost tracking and historical cost analysis.
defaultreturncostDecimalFalseNoThe default cost applied when returning an item to inventory. This cost value helps determine the financial impact of returns and restocking decisions.
demandsourceStringFalseNoThe origin of demand for the item at this location. This field helps differentiate between customer orders, internal stock transfers, and manufacturing requirements.
demandtimefenceIntegerFalseNoThe number of days within which demand changes are restricted. This setting ensures that short-term planning remains stable and minimizes disruptions in supply chain management.
fixedlotsizeDoubleFalseNoThe fixed lot size used when ordering or manufacturing the item at this location. This lot size ensures consistent replenishment quantities and improves procurement efficiency.
forwardconsumptiondaysIntegerFalseNoThe number of days after a forecasted demand date that inventory consumption can be applied. This setting allows for future demand smoothing and planning flexibility.
inventorycosttemplateStringFalseNoThe cost template applied to the item at this location. This template defines cost allocation methods and is critical for financial reporting and inventory valuation.
invtclassificationStringFalseNoThe inventory classification assigned to the item at this location. This field helps categorize items based on turnover rates, demand patterns, or ABC analysis.
invtcountintervalIntegerFalseNoThe number of days between inventory counts for the item at this location. This field supports cycle counting and stock accuracy initiatives.
itemStringFalseNoThe unique identifier (Id) of the item for which this location-specific record applies. This Id links inventory records to specific SKUs or product identifiers.
lastinvtcountdateDateFalseNoThe date on which the item was last physically counted at this location. This date helps track cycle count accuracy and audit compliance.
lastpurchasepricemliDecimalFalseNoThe most recent purchase price of the item at this location. This value provides visibility into supplier pricing trends and cost fluctuations.
locationStringFalseNoThe specific inventory location where the item is stored. This location ensures accurate stock tracking and replenishment planning across multiple warehouses or distribution centers.
nextinvtcountdateDateFalseNoThe next scheduled date for inventory counting of this item at the location. This field supports inventory accuracy initiatives and compliance with stock audits.
periodiclotsizedaysIntegerFalseNoThe number of days used to calculate the periodic lot size for replenishment. This value determines the frequency of supply orders based on expected demand.
periodiclotsizetypeStringFalseNoThe type of periodic lot size calculation used for the item at this location. This setting affects how supply chain planners determine order quantities.
preferredstocklevelDoubleFalseNoThe optimal inventory level that should be maintained for the item at this location. This value is used to minimize stockouts while controlling holding costs.
qtyintransitexternalDoubleFalseNoThe quantity of the item currently in transit from external suppliers. This field provides visibility into incoming shipments that have not yet been received.
quantityavailableDoubleFalseNoThe total quantity of the item available for sale or use at this location. This value excludes quantities that are committed to existing orders.
quantitybackorderedDoubleFalseNoThe total quantity of the item that has been ordered but is currently out of stock at this location. This field provides insights into fulfillment delays and inventory shortages.
quantitycommittedDoubleFalseNoThe total quantity of the item that has been allocated to sales or production orders at this location. This value ensures that reserved stock is not used for other transactions.
quantityintransitDoubleFalseNoThe total quantity of the item currently being transferred between locations. This value helps track inventory movement within a multi-location supply chain.
quantityonhandDoubleFalseNoThe total physical quantity of the item currently stored at this location. This value is used for stock verification, financial reporting, and inventory reconciliation.
quantityonorderDoubleFalseNoThe total quantity of the item that has been ordered but not yet received at this location. This value provides insight into expected inventory replenishments.
reorderpointDoubleFalseNoThe minimum inventory level at which a reorder is triggered for the item at this location. This value ensures that stock is replenished before depletion occurs.
rescheduleindaysIntegerFalseNoThe number of days an inbound supply order can be moved forward to meet demand. This setting helps optimize inventory flow by adjusting delivery schedules.
rescheduleoutdaysIntegerFalseNoThe number of days an inbound supply order can be pushed back due to changes in demand. This setting ensures efficient order management and prevents overstocking.
supplylotsizingmethodStringFalseNoThe lot sizing method used for supply planning at this location. This method determines how order quantities are calculated based on demand patterns and inventory policies.
supplytimefenceIntegerFalseNoThe number of days within which supply changes are restricted. This setting stabilizes short-term production and procurement planning.
supplytypeStringFalseNoThe type of supply source that is used for replenishing the item at this location. This field differentiates between purchased items, manufactured goods, and internal stock transfers.

Return to Top

alignOrHide 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoThe configuration setting that determines whether a field, section, or UI element should be aligned or hidden within the system. This setting is used to control the visibility and placement of elements in forms, reports, or dashboards, ensuring a streamlined and user-friendly interface.

Return to Top

allocationDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe system-generated unique identifier (Id) for the allocation detail record. This Id is used internally for indexing, reference, and ensuring data integrity in financial transactions.
createdjournalsStringFalseNoThe journal entry that is created as a result of the allocation process. This entry provides a reference to the financial transaction recorded in the general ledger for tracking and reconciliation purposes.
externalidStringFalseNoThe unique Id assigned to this allocation detail record by an external system. This Id facilitates integration with third-party financial applications and ensures consistency in data exchange.
parentscheduleStringFalseNoThe allocation schedule from which this allocation detail was generated. This field links the record to its originating allocation plan, ensuring accurate tracking of cost distribution and revenue allocation processes.
trandateDateFalseNoThe transaction date of the allocation detail entry. This date determines when the allocation impacts financial statements and ensures correct period-based reporting.

Return to Top

allocationDetailJournalMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
journalStringFalseNoThe journal entry associated with the allocation detail. This entry provides a reference to the financial transaction recorded in the general ledger, ensuring accurate tracking of cost distributions and financial allocations.

Return to Top

AllocationMethod 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoThe unique identifier (Id) for the allocation method. This Id is used to distinguish different allocation methodologies, ensuring consistency in cost distribution, financial reporting, and budgeting processes.

Return to Top

allocationschedule 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book that is associated with this allocation schedule. This field ensures that the allocation is applied within the correct financial ledger, supporting multi-book accounting and regulatory compliance.
accountsfromsourceBooleanFalseNoIndicates whether accounts are derived from the allocation source. This setting allows dynamic account selection based on the originating transaction, ensuring flexibility in cost distribution.
allocationmodeStringFalseNoThe method that is used to allocate expenses or revenue. This field defines whether the allocation is based on predefined percentages, statistical measures, or actual transaction values, ensuring consistency in financial planning.
creditaccountStringFalseNoThe general ledger account that will receive the allocated credit amount. This field ensures that financial distributions are correctly recorded in the accounting system.
creditclassStringFalseNoThe classification that is assigned to the credit portion of the allocation. This classification helps track financial data by class, enabling better financial analysis and reporting segmentation.
creditdepartmentStringFalseNoThe department that is associated with the credit side of the allocation. This field ensures that financial transactions are attributed to the correct department for budgeting and expense tracking.
creditentityStringFalseNoThe entity or subsidiary receiving the allocated credit amount. This field is essential for multi-entity organizations to track intercompany transactions and allocations accurately.
creditlocationStringFalseNoThe physical or operational location associated with the credit portion of the allocation. This location ensures that expenses and revenues are properly tracked across different business locations.
datebasisStringFalseNoThe basis for determining the allocation date. This field defines whether the allocation is based on the transaction date, period-end date, or another reference point, ensuring accurate financial timing.
externalidStringFalseNoThe unique identifier (Id) assigned to this allocation schedule by an external system. This Id facilitates integration with third-party financial applications, ensuring consistent data synchronization.
frequencyStringFalseNoThe recurrence pattern for the allocation schedule. This pattern defines how often the allocation process runs, such as monthly, quarterly, or annually, ensuring timely cost distribution.
inactiveBooleanFalseNoIndicates whether the allocation schedule is inactive. This setting prevents the schedule from being used in future allocations while retaining historical data for reporting.
nameStringFalseNoThe official name of the allocation schedule. This field provides a meaningful reference for users to identify and manage different allocation processes within the system.
nextdateDateFalseNoThe next scheduled date for running the allocation process. This date ensures timely execution of financial allocations based on predefined schedules.
remindforeverStringFalseNoIndicates whether reminders for this allocation schedule will continue indefinitely. This field helps maintain visibility into recurring allocations that require review or adjustments.
subsequentdateDateFalseNoThe date of the next allocation after the initially scheduled allocation. This date supports tracking recurring allocations to ensure they align with financial planning requirements.
subsidiaryStringFalseNoThe subsidiary that is associated with this allocation schedule. This information ensures that financial transactions are correctly assigned to the appropriate legal entity in multi-subsidiary organizations.
unitlabelStringFalseNoThe label that is assigned to the units used in the allocation process. This label helps clarify the measurement basis for allocations, such as hours, square footage, or revenue percentages.
unitstypeStringFalseNoThe type of unit used in the allocation calculation. This field defines the metric for distributing costs or revenue, ensuring accurate allocation based on relevant business drivers.
weightsinpercentageBooleanFalseNoIndicates whether allocation weights are expressed as percentages. This setting ensures clarity in cost distribution calculations, allowing users to allocate amounts proportionally.
weightsourceStringFalseNoThe source of the allocation weight. This field determines whether allocation percentages are based on historical data, fixed values, or dynamically calculated factors, ensuring accuracy in financial allocations.

Return to Top

allocationScheduleAllocationDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe system-generated unique identifier (Id) for the allocation schedule detail record. This Id is used internally for indexing, tracking, and ensuring data integrity within financial allocations.
createdjournalsStringFalseNoThe journal entry that is created as a result of the allocation process. This entry provides a reference to the general ledger transaction, ensuring proper tracking and reconciliation of allocated amounts.
externalidStringFalseNoThe unique Id assigned to this allocation schedule detail by an external system. This Id facilitates integration with third-party financial applications and ensures consistency in data exchange.
parentscheduleStringFalseNoThe allocation schedule from which this allocation detail was generated. This field links the record to its parent allocation plan, ensuring traceability of cost or revenue distribution.
trandateDateFalseNoThe transaction date of the allocation schedule detail entry. This date determines when the allocation affects financial statements, ensuring accurate period-based reporting.

Return to Top

allocationScheduleAllocationDetailGeneralDetailDestination 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account that will receive the allocated amounts. This field ensures that financial distributions are properly recorded and categorized within the accounting system.
classStringFalseNoThe classification assigned to the allocated transaction. This classification helps segment financial data for reporting and analysis, supporting internal cost tracking and financial management.
departmentStringFalseNoThe department that receives the allocated amounts. This field ensures that expenses and revenues are correctly attributed to the appropriate department for budgeting, performance tracking, and financial reporting.
entityStringFalseNoThe entity or recipient that is associated with the allocated transaction. This field identifies the specific business unit, vendor, customer, or project receiving the allocated amount, ensuring proper accounting treatment.
intercompanyaccountStringFalseNoThe intercompany account that is used for allocation when transactions occur between subsidiaries. This field ensures proper recording of intercompany transfers, eliminating duplication in consolidated financial reporting.
locationStringFalseNoThe location that is receiving the allocated amount. This location helps track regional or branch-level financial performance, supporting location-based budgeting and analysis.
parentscheduleStringFalseNoThe allocation schedule from which this allocation detail was generated. This field links the record to its originating allocation plan, ensuring traceability and consistency in cost or revenue distribution.
subsidiaryStringFalseNoThe subsidiary to which the allocated transaction applies. This field ensures that financial allocations are recorded correctly in multi-entity organizations, supporting compliance and consolidated financial reporting.

Return to Top

allocationScheduleAllocationDetailGeneralDetailSource 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account from which the allocated amounts originate. This field ensures that financial distributions are deducted from the correct account, maintaining accurate cost allocation and expense tracking.
classStringFalseNoThe classification that is assigned to the source transaction before allocation. This classification helps segment financial data for reporting and ensures that allocations align with internal cost structures.
departmentStringFalseNoThe department from which the allocated amounts originate. This field ensures that financial transactions are correctly attributed to the appropriate department for budgeting, cost tracking, and performance analysis.
locationStringFalseNoThe location that is associated with the source of the allocated amount. This location helps track financial performance at regional or branch levels, supporting location-based budgeting and financial planning.
parentscheduleStringFalseNoThe allocation schedule from which this allocation detail was generated. This field links the record to its originating allocation plan, ensuring traceability and accuracy in cost or revenue distribution.

Return to Top

allocationScheduleAllocationDetailJournalMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
journalStringFalseNoThe journal entry associated with the allocation schedule detail. This entry provides a reference to the general ledger transaction created as part of the allocation process, ensuring accurate financial tracking and reconciliation.

Return to Top

AllocationScheduleDestination 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account where the allocated amount is recorded. This field ensures that financial distributions are properly categorized and tracked within the accounting system.
classStringFalseNoThe classification assigned to the allocated transaction. This classification helps segment financial data, supporting internal reporting, budgeting, and cost management.
departmentStringFalseNoThe department receiving the allocated amount. This field ensures that expenses or revenues are correctly attributed to the appropriate department for financial tracking and performance evaluation.
entityStringFalseNoThe entity or subsidiary receiving the allocated amount. This field helps ensure accurate financial reporting in multi-entity organizations by properly attributing intercompany transactions.
locationStringFalseNoThe location where the allocated amount is applied. This location supports regional financial tracking, ensuring proper distribution of costs or revenues across different business locations.
parentscheduleStringFalseNoThe allocation schedule from which this allocation detail was generated. This field links the record to its originating allocation process, ensuring traceability and accurate cost distribution.

Return to Top

AllocationScheduleSource 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account from which the allocated amount originates. This field ensures that expenses or revenues are deducted from the correct account, maintaining accurate financial tracking and allocation integrity. This classification helps segment financial data, ensuring that allocations align with internal cost structures and reporting needs.
classStringFalseNoThe classification of users, businesses, or entities that is associated with an allocation schedule source in NetSuite. This field identifies the target audience that is linked to allocation processing, ensuring that financial distributions, reporting, and compliance tracking are correctly applied. This mapping supports cost allocation accuracy, financial transparency, and audit readiness.
departmentStringFalseNoThe department from which the allocated amount originates. This field ensures that financial distributions are correctly attributed to the appropriate department, supporting cost tracking and budget management.
locationStringFalseNoThe location associated with the source of the allocated amount. This location helps track financial performance and cost distribution across different business units, ensuring accurate regional financial reporting.
parentscheduleStringFalseNoThe allocation schedule from which this allocation detail was generated. This field links the record to its originating allocation process, ensuring traceability and accuracy in financial distributions.

Return to Top

amortizationschedule 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book that is associated with the amortization schedule. This field ensures that amortized expenses or revenues are recorded within the correct financial ledger, supporting multi-book accounting and regulatory compliance.
amortizationtypeStringFalseNoThe type of amortization method applied to the schedule. This type determines how expenses or revenues are systematically allocated over time, such as straight-line or declining balance amortization.
enddateDateFalseNoThe final date of the amortization schedule. This date defines when the amortization process is expected to be fully completed, ensuring accurate financial reporting and compliance.
externalidStringFalseNoThe unique identifier (Id) that is assigned to this amortization schedule by an external system. This Id facilitates integration with third-party financial applications, ensuring consistency in data exchange and reporting.
initialamountStringFalseNoThe original amount subject to amortization before any allocations or adjustments. This field represents the starting balance used for calculating periodic expense or revenue recognition.
isinactiveBooleanFalseNoIndicates whether the amortization schedule is inactive. This setting prevents the schedule from being used in future calculations while retaining historical data for auditing and compliance.
jobStringFalseNoThe job or project that is associated with the amortization schedule. This field ensures that amortized costs or revenues are correctly linked to specific projects for accurate financial tracking.
nameStringFalseNoThe official name of the amortization schedule. This official name provides a meaningful reference for users to identify and manage different amortization plans within the system.
parentSchedStringFalseNoThe parent amortization schedule to which this schedule is linked. This schedule ensures hierarchical structuring of amortization plans, supporting multi-level cost or revenue recognition tracking.
periodoffsetIntegerFalseNoThe number of periods by which amortization is offset from the transaction date. This information controls the timing of amortization recognition, ensuring alignment with financial reporting requirements.
recogintervalsrcStringFalseNoThe source of the recognition interval for the amortization schedule. This field determines whether amortization intervals are based on fixed periods, transaction settings, or external factors.
recurrencetypeStringFalseNoThe frequency at which amortization entries are posted. This frequency defines whether the schedule follows monthly, quarterly, or annual recognition patterns, ensuring compliance with financial planning standards.
remainingdeferredbalanceDecimalFalseNoThe outstanding balance that is yet to be amortized. This field tracks deferred expenses or revenues that are scheduled for future recognition, ensuring accurate financial reporting.
residualStringFalseNoThe final residual value of the amortized amount after the schedule is completed. This value ensures proper handling of any remaining balance that is not fully amortized.
revrecoffsetIntegerFalseNoThe offset period for revenue recognition in relation to the transaction date. This period determines how far amortization is deferred, supporting revenue recognition compliance.
schedulenumberStringFalseNoThe unique Id that is assigned to the amortization schedule within the system. This Id helps users track and manage amortization schedules efficiently.
sourcetranStringFalseNoThe originating transaction from which this amortization schedule was created. This field links the amortization process to its source document, ensuring traceability and financial auditability.
startdateDateFalseNoThe starting date of the amortization schedule. This date determines when the amortization process begins and ensures accurate financial period alignment.
statusStringFalseNoThe current status of the amortization schedule, such as Active, Completed, or Canceled. This status helps track the progress of amortization and prevents unintended modifications.
totalamortizedDecimalFalseNoThe total amount that has been amortized to date. This field provides insight into how much of the original amount has been recognized in financial statements.
totalamountDecimalFalseNoThe total amount subject to amortization over the entire schedule. This field represents the full financial obligation or revenue recognition amount allocated over time.

Return to Top

amortizationtemplate 

NameTypeReadOnlyReferencesFilterOnlyDescription
acctcontraStringFalseNoThe contra account that is used in the amortization process. This field ensures that offsetting entries are correctly recorded, maintaining balance sheet accuracy in deferred revenue or expense recognition.
acctdeferralStringFalseNoThe deferral account where the initial expense or revenue is recorded before amortization. This field tracks deferred costs or revenues that will be systematically recognized over time.
accttargetStringFalseNoThe target account where the amortized amounts are recognized. This field ensures that financial transactions are properly categorized in the general ledger, aligning with revenue or expense recognition principles.
amortizationperiodIntegerFalseNoThe total number of periods over which amortization occurs. This field determines the duration of expense or revenue recognition, ensuring compliance with financial reporting standards.
amortizationtypeStringFalseNoThe method that is used to amortize expenses or revenues over time. This method defines whether the amortization follows a straight-line, declining balance, or custom method to allocate amounts systematically.
externalidStringFalseNoThe unique identifier (Id) assigned to this amortization template by an external system. This Id facilitates data synchronization between NetSuite and third-party financial applications.
initialamountStringFalseNoThe original amount that is subject to amortization. This field represents the full financial obligation or deferred revenue that will be gradually recognized over the defined amortization period.
isinactiveBooleanFalseNoIndicates whether the amortization template is inactive. This setting prevents the template from being used in future amortization schedules while preserving historical data for reference.
nameStringFalseNoThe official name of the amortization template. This official name provides a meaningful reference for users when selecting templates for automated amortization schedules.
periodoffsetIntegerFalseNoThe number of periods by which amortization is offset from the transaction date. This field controls the timing of amortization recognition to align with financial reporting cycles.
recogintervalsrcStringFalseNoThe source that is used to determine the recognition intervals. This field defines whether amortization is based on fixed periods, transaction settings, or external factors, ensuring flexible financial planning.
recurrencetypeStringFalseNoThe recurrence pattern of amortization postings. This pattern specifies whether amortization is recorded monthly, quarterly, annually, or based on a custom schedule.
residualStringFalseNoThe final residual value after the amortization process is completed. This value ensures proper handling of any remaining balance that is not fully amortized.
revrecoffsetIntegerFalseNoThe offset period for revenue recognition in relation to the transaction date. This period determines how far amortization is deferred, ensuring compliance with revenue recognition rules.
totalamountDecimalFalseNoThe total amount that is allocated for amortization. This field represents the full financial value that will be systematically expensed or recognized over the defined periods.

Return to Top

AmortizationType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoThe unique identifier (Id) for the amortization type. This Id is used to classify different amortization methods, ensuring that expenses or revenues are recognized according to predefined accounting rules and financial reporting standards.

Return to Top

ApplicabilityModeType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoThe unique identifier (Id) for the applicability mode type. This Id defines how specific business rules, conditions, or workflows apply within financial or operational processes, ensuring consistency in system behavior and compliance with predefined criteria.

Return to Top

ApplicabilityReasonType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoThe unique identifier (Id) for the applicability reason type. This Id defines the justification or condition under which a specific rule, workflow, or financial process is applied, ensuring consistency and compliance with business policies.

Return to Top

ApplicabilityStatusType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoThe unique identifier (Id) for the applicability status type. This Id defines the current state or condition of a specific rule, workflow, or financial process, ensuring that applicable criteria are tracked and enforced systematically.

Return to Top

applyDiscountTo 

NameTypeReadOnlyReferencesFilterOnlyDescription
nameStringFalseNoThe entity or transaction component to which a discount is applied. This component determines whether the discount is applied to an entire order, specific line items, or another financial element, ensuring accurate pricing and financial calculations.

Return to Top

ApprovalStatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
nameStringFalseNoThe approval status that is assigned to a transaction or record. This status indicates whether an entry is pending approval, approved, or rejected, ensuring proper workflow control and compliance with financial and operational policies.

Return to Top

assemblybuild 

NameTypeReadOnlyReferencesFilterOnlyDescription
billofmaterialsStringFalseNoThe bill of materials (BOM) that is used for this assembly build. This BOM defines the list of raw materials, components, and subassemblies required to produce the finished item.
billofmaterialsrevisionStringFalseNoThe specific revision of the BOM that is applied to this assembly build. This field ensures that the correct version of the BOM is used, reflecting any design or component updates.
buildableDoubleFalseNoThe number of finished units that can be built based on available inventory. This field helps determine production feasibility by comparing component availability to the BOM requirements.
classStringFalseNoThe classification associated with this assembly build. This classification supports financial segmentation and reporting by grouping transactions under specific categories.
createddateDatetimeFalseNoThe date and time when the assembly build record was created. This timestamp provides an audit trail for manufacturing and inventory tracking purposes.
customformStringFalseNoThe custom form that is used for this assembly build transaction. This field allows organizations to apply a specific layout and data fields to meet unique business requirements.
departmentStringFalseNoThe department that is responsible for the assembly build. This field ensures that production costs are correctly attributed to the appropriate department for budgeting and financial reporting.
externalidStringFalseNoThe unique identifier (Id) assigned to this assembly build by an external system. This Id facilitates data synchronization and integration with third-party manufacturing or inventory systems.
inventorydetailStringFalseNoDetailed inventory-tracking information that is associated with this assembly build. This information provides visibility into lot numbers, serial numbers, and bin locations for better inventory control.
itemStringFalseNoThe finished item that is produced by this assembly build. This field identifies the manufactured product and links it to inventory management and sales processes.
lastmodifieddateDatetimeFalseNoThe date and time when the assembly build record was last modified. This timestamp helps track changes and ensures data accuracy in manufacturing records.
locationStringFalseNoThe physical or operational location where the assembly build is performed. This location supports warehouse management, inventory tracking, and cost allocation.
memoStringFalseNoA free-text field for adding notes or comments related to this assembly build. This field provides additional context or instructions for production and inventory teams.
postingperiodStringFalseNoThe financial period in which this assembly build transaction is recorded. This field ensures that manufacturing costs and inventory adjustments are properly recognized in accounting records.
quantityStringFalseNoThe total number of finished units that is produced in this assembly build. This field helps track production output and inventory adjustments.
revisionStringFalseNoThe specific product or engineering revision that is applied to the finished item. This field ensures that the correct version of the product is manufactured according to current specifications.
revisionmemoStringFalseNoAdditional notes or details related to the revision used in this assembly build. This field provides contextual information about design changes or production updates.
subsidiaryStringFalseNoThe subsidiary that is responsible for this assembly build transaction. This field ensures that manufacturing activities are correctly assigned to the appropriate legal entity in multi-subsidiary organizations.
totalDecimalFalseNoThe total cost that is associated with this assembly build. This total includes the cost of components, labor, and overhead, ensuring accurate financial tracking of production expenses.
trandateDateFalseNoThe transaction date of the assembly build. This date determines when the inventory and financial impact of the build is recorded in the system.
tranidStringFalseNoThe system-generated unique Id for this assembly build transaction. This Id provides a reference for tracking and retrieving build records in inventory and financial systems.
unitsStringFalseNoThe unit of measure (UOM) that is applied to the finished item. This UOM ensures consistency in inventory tracking and production planning.

Return to Top

assemblyitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
alternatedemandsourceitemStringFalseNoThe designated alternative item that can be used to fulfill demand when the primary item is unavailable. This item supports business continuity by reducing stockouts, ensuring customer satisfaction, and maintaining supply chain flexibility.
assetaccountStringFalseNoThe general ledger account that is used to track the financial value of this assembly item as an asset. This account ensures proper accounting for inventory valuation, asset depreciation, and balance sheet reporting.
atpmethodStringFalseNoThe Available-to-Promise (ATP) method that is used to calculate whether inventory is available to meet demand. This method can be based on supply chain forecasts, existing stock, and lead times to optimize order fulfillment.
auctionquantityStringFalseNoThe quantity of this item available for auction-based sales. This field is used in online marketplaces and dynamic pricing strategies to manage bidding constraints and stock availability.
auctiontypeStringFalseNoThe type of auction applicable to this item (for example, such as 'standard,' 'reserve,' or 'buy-it-now'). The auction type determines the bidding structure and sale conditions for this product.
autoleadtimeBooleanFalseNoIndicates whether the system automatically calculates the lead time that is required to procure or manufacture this item. This value ensures that replenishment cycles align with demand fluctuations and supplier performance.
autopreferredstocklevelBooleanFalseNoSpecifies whether the preferred stock level for this item is dynamically determined based on historical sales, demand forecasting, and inventory turnover rates. This feature helps maintain optimal stock levels.
autoreorderpointBooleanFalseNoIndicates whether the system should automatically calculate the reorder point for this item, ensuring that stock is replenished before running out. This field prevents stockouts and maintains efficient supply chain operations.
availabletopartnersBooleanFalseNoDefines whether this item is visible and available for purchase by business partners in a multiple-tier distribution model. This field enables controlled sharing of inventory within partner networks, supporting business-to-business (B2B) sales and collaborative supply chain management.
averagecostDecimalFalseNoThe system-calculated average cost per unit of this item, based on purchase history, production expenses, and costing methods. This cost is used in financial reporting, profitability analysis, and inventory valuation.
billexchratevarianceacctStringFalseNoThe general ledger account that records exchange rate variances related to supplier billing. This account ensures that fluctuations in currency conversion are properly accounted for in financial statements.
billingscheduleStringFalseNoThe predefined invoicing schedule associated with this item, specifying how and when customers are billed. This schedule is commonly used for recurring revenue models, installment payments, or subscription-based services.
billpricevarianceacctStringFalseNoThe general ledger account that captures discrepancies between estimated and actual billed prices. This account is crucial for variance analysis, contract compliance, and profitability tracking.
billqtyvarianceacctStringFalseNoThe account that is used to track differences between estimated and actual billed quantities. This account ensures accurate financial reconciliation, helping organizations detect billing discrepancies and prevent revenue leakage.
buildentireassemblyBooleanFalseNoIndicates whether this item must be fully assembled in one production run or whether partial builds are allowed. This setting impacts production scheduling, labor allocation, and supply chain planning.
buildtimeDoubleFalseNoThe estimated time that is required to fully assemble one unit of this item. This field is used in production planning, labor scheduling, and efficiency analysis to optimize manufacturing workflows.
buildtimelotsizeDoubleFalseNoThe standard lot size for which build time is calculated. This lot size ensures accurate estimates for assembly duration and supports batch processing in production environments.
buyitnowpriceDecimalFalseNoThe fixed price at which customers can immediately purchase this item in an auction-based marketplace, bypassing the bidding process. This strategy is commonly used for high-demand products to encourage instant purchases.
classStringFalseNoThe classification or category that is assigned to this item, which helps in financial segmentation, inventory organization, and reporting. This classification can influence taxation, pricing strategies, and cost allocation.
cogsaccountStringFalseNoThe general ledger account that records the cost of goods sold (COGS) for this item. This account is a critical component of financial accounting, used for calculating gross margins and tracking profitability.
conditionenabledStringFalseNoIndicates whether conditional rules are applied to this item. This field is useful for dynamic pricing, promotional eligibility, or specific workflow requirements based on predefined conditions.
conditionhelpurlStringFalseNoA Uniform Resource Locator (URL) link to documentation or help resources explaining the conditions and rules applied to this item. This URL assists users in configuring and troubleshooting item-specific conditions.
consumptionunitStringFalseNoThe unit of measure (UOM) in which this item is consumed or used (for example, 'pieces,' 'kilograms,' or 'liters'). This UOM ensures accurate inventory tracking, pricing, and billing calculations.
copydescriptionBooleanFalseNoDetermines whether the item's description should be automatically copied to related transactions such as sales orders, invoices, or purchase orders. This field maintains consistency and saves manual entry time.
costDecimalFalseNoThe standard or base cost of the item, which is used for financial forecasting, pricing strategies, and margin analysis. This cost value affects profitability calculations and cost-based pricing models.
costcategoryStringFalseNoThe predefined cost category that is associated with this item, which is used for financial reporting, cost allocation, and budget tracking. This cost category helps in grouping expenses under relevant accounting categories.
costestimateDecimalFalseNoThe projected cost to produce or procure this item. This estimate is used for budgeting, financial planning, and cost control in supply chain management (SCM).
costestimatetypeStringFalseNoThe methodology that is used to estimate costs for this item (for example, 'standard cost,' 'average cost,' or 'last purchase cost'). This selection determines how cost calculations impact financial statements.
costingmethodStringFalseNoThe inventory costing method that is assigned to this item (for example, First-In, First-Out [FIFO]; Last-In, First Out [LIFO]; or weighted average cost). This costing method impacts cost accounting and inventory valuation.
costingmethoddisplayStringFalseNoA user-friendly display format of the costing method that is used for this item. This display format ensures transparency and understanding in financial reports and inventory management.
costunitsStringFalseNoThe UOM that is used in cost calculations, ensuring consistency in pricing, inventory valuation, and financial reporting.
countryofmanufactureStringFalseNoThe country where this item is manufactured. This field is crucial for compliance with import/export regulations, country-of-origin labeling, and tariff applications.
createddateDatetimeFalseNoThe date and time when this item record was created. This timestamp is used for audit tracking, historical analysis, and system monitoring.
createrevenueplansonStringFalseNoSpecifies the conditions under which revenue plans are generated for this item. This field is important for revenue recognition policies, contract-based billing, and financial forecasting.
currencyStringFalseNoThe currency in which financial transactions that are related to this item are recorded. This field ensures accuracy in multi-currency environments, supports global financial compliance, and maintains consistent pricing strategies.
customformStringFalseNoThe predefined custom form that is associated with this item, determining the layout and fields used when entering or editing records in the system. This custom form supports process customization and compliance with business workflows.
custreturnvarianceaccountStringFalseNoThe general ledger account used to track discrepancies in customer returns, such as differences in refund amounts or returned quantities. This account ensures accurate reconciliation in financial statements.
defaultrevisionStringFalseNoThe default revision level that is assigned to this item. This revision level ensures that product updates, design modifications, or quality improvements are version-controlled for manufacturing, inventory, and sales tracking.
deferredrevenueaccountStringFalseNoThe general ledger account that is used to record deferred revenue for this item. This account is critical for compliance with revenue recognition policies, ensuring that revenue is reported in the appropriate period.
deferrevrecBooleanFalseNoIndicates whether revenue recognition for this item is deferred. If this field is enabled, revenue from this item is recognized over time rather than immediately upon sale, in accordance with accounting standards.
demandmodifierStringFalseNoA variable that is used to adjust demand calculations for this item based on market conditions, promotional campaigns, or seasonality. This variable helps refine demand forecasting and inventory planning.
demandtimefenceIntegerFalseNoThe number of days within which demand changes are restricted, preventing late-stage fluctuations from affecting supply chain planning. This information stabilizes production schedules and procurement strategies.
departmentStringFalseNoThe department that is responsible for managing this item, used for financial tracking, budget allocation, and reporting purposes within the organization.
descriptionStringFalseNoA detailed text description of this item, providing essential information for purchasing, sales, and inventory management. This description can be displayed in catalogs, invoices, and online listings.
directrevenuepostingBooleanFalseNoDetermines whether revenue from this item is posted directly to the general ledger without being deferred. This setting is important for cash-flow management and revenue-recognition compliance.
displayinebaystoreBooleanFalseNoIndicates whether this item is listed and visible in an eBay store. If this field is enabled, it allows the item to be sold through an online marketplace, expanding sales channels.
displaynameStringFalseNoThe name of this item as displayed in user interfaces, product catalogs, and reports. This name is used to improve searchability and consistency in item identification.
distributioncategoryStringFalseNoA classification that is used to categorize this item within a distribution network. This classification helps in organizing supply chain logistics, warehouse storage, and shipping prioritization.
distributionnetworkStringFalseNoThe specific distribution network or supply-chain channel through which this item is allocated. This field ensures proper routing for fulfillment, regional availability, and inventory optimization.
dontshowpriceBooleanFalseNoSpecifies whether this item's price should be hidden on public-facing sales channels, catalogs, or customer portals. This field is useful for negotiated pricing models and tiered discount structures.
dropshipexpenseaccountStringFalseNoThe general ledger account used to track expenses related to drop-shipped items. This account ensures proper financial reporting for cost of sales without affecting internal inventory balances.
ebayhandlingtimeStringFalseNoThe estimated time that is required to process and prepare this item for shipment when sold on eBay. This estimation affects customer expectations and delivery commitments.
ebayintlinsurancefeeDecimalFalseNoThe insurance fee that is applied to international eBay shipments for this item, covering potential loss or damage during transit.
ebayintlpackagehandlingfeeDecimalFalseNoAn additional handling fee that is charged for international shipments of this item, accounting for packaging, customs processing, or extra handling requirements.
ebayintlshipinsuranceStringFalseNoIndicates whether international shipping insurance is available for this item when sold on eBay. This field impacts customer confidence and risk mitigation in cross-border transactions.
ebayisintlcalculatedrateStringFalseNoSpecifies whether international shipping rates for this item are dynamically calculated based on its weight, dimensions, and destination. This field ensures accurate shipping cost estimation.
ebayisirregularpackageBooleanFalseNoDetermines whether this item is classified as an irregular package for eBay shipping. If this field is enabled, special shipping requirements or additional charges might apply.
ebayitemdescriptionStringFalseNoThe description of this item as it appears on its eBay listing. This text provides potential buyers with relevant product details, specifications, and selling points.
ebayitemlocdisplayStringFalseNoDetermines whether the item's location is displayed on its eBay listing. This field helps buyers assess shipping times and potential regional restrictions.
ebayitemloczipcodeStringFalseNoThe ZIP code of the item's shipping location for eBay transactions. This ZIP code is used to calculate shipping rates, delivery estimates, and location-based fees.
ebayitemlotsIntegerFalseNoThe number of units that are included per lot when selling this item on eBay. This number defines bulk-sale pricing and ensures proper inventory tracking for lot-based transactions.
ebayitemsubtitleStringFalseNoAn optional subtitle that is displayed beneath the main title of the eBay listing. This subtitle is used to add additional promotional details or highlight unique selling points of the product.
ebayitemtitleStringFalseNoThe main title that is used for this item’s eBay listing, serving as the primary identifier in search results and product pages. This title should be optimized for discoverability and relevance.
ebayitemweightamtStringFalseNoThe recorded weight of the item for eBay transactions. This weight is used in shipping cost calculations and carrier selection.
ebaylayoutStringFalseNoThe selected eBay layout template that defines the appearance and design of the listing. This template helps maintain a consistent branding and presentation strategy.
ebaypackagetypeStringFalseNoThe packaging type that is used for shipping this item via eBay. Examples include 'Box,' 'Envelope,' or 'Tube,' which impact carrier options and shipping rates.
ebaypagecounterStringFalseNoIndicates whether an eBay page counter is displayed on the listing, tracking the number of views and visitor engagement metrics.
ebayrelistingoptionStringFalseNoThe selected relisting option for this item on eBay. This option determines whether an item is automatically relisted if it does not sell within the initial listing period.
ebaythemeStringFalseNoThe applied theme for the eBay store in which this item is listed. This theme ensures branding consistency and a visually appealing online storefront.
ebaythemegroupStringFalseNoThe designated theme group for this item’s eBay listing, ensuring branding consistency and alignment with predefined store aesthetics. This field helps maintain a cohesive visual presentation across multiple product listings.
effectivebomcontrolStringFalseNoThe control method used for managing the Bill of Materials (BOM) that is associated with this item. This method determines how and when changes to the BOM take effect in production, ensuring accurate tracking of components, costs, and materials.
endauctionswhenoutofstockBooleanFalseNoSpecifies whether active eBay auctions for this item should automatically end when the inventory level reaches zero. Enabling this feature prevents overselling and ensures accurate stock availability across sales channels.
enforceminqtyinternallyBooleanFalseNoIndicates whether the system enforces a predefined minimum quantity threshold when processing transactions. This prevents depletion of essential inventory levels, ensuring stock availability for critical operations and customer orders.
excludefromsitemapBooleanFalseNoDetermines whether this item should be excluded from the website’s sitemap, preventing search engines from indexing it. This field is useful for items not meant for public sale, internal-use products, or restricted-access inventory.
externalidStringFalseNoA unique identifier (Id) that is assigned to this item for integration with external systems, such as third-party e-commerce platforms, enterprise resource planning (ERP) solutions, or supply-chain networks. This Id ensures seamless data synchronization across multiple business applications.
fixedbuildtimeDoubleFalseNoThe standard fixed time that is required to assemble this item, irrespective of the quantity produced. This fixed time is a critical factor in production planning, labor scheduling, and efficiency calculations for manufacturing operations.
froogleproductfeedStringFalseNoIndicates whether this item is included in Google Shopping (formerly Froogle) product feeds. Ensuring inclusion in product feeds improves discoverability and enhances online marketing strategies.
futurehorizonStringFalseNoThe timeframe that is used for demand forecasting and long-term planning for this item. This setting helps businesses anticipate future inventory needs, align production schedules, and mitigate supply chain risks.
gainlossaccountStringFalseNoThe general ledger account used to track gains or losses resulting from fluctuations in foreign exchange rates when transactions involving this item are processed in multiple currencies. This account is critical for financial reconciliation and compliance.
galleryBooleanFalseNoSpecifies whether this item is eligible to be displayed in an eBay gallery. Featuring products in an eBay gallery improves visibility, increasing the likelihood of attracting potential buyers.
galleryfeaturedBooleanFalseNoDetermines whether this item should receive premium placement as a featured product in an eBay gallery. Featured items gain increased exposure and priority placement in search results, boosting sales potential.
gifttypeexpressshipBooleanFalseNoIndicates whether this item qualifies for express shipping when purchased as a gift. Enabling this feature provides buyers with faster shipping options, improving customer satisfaction and service levels.
gifttypegiftwrapBooleanFalseNoSpecifies whether this item is eligible for gift wrapping during the checkout process. Enabling this feature enhances the customer experience by offering additional customization and presentation options for gift purchases.
gifttypeshiptorecipientBooleanFalseNoDetermines whether this item can be shipped directly to a recipient as part of a gift purchase. This field is essential for gift services, corporate gifting programs, and personalized order fulfillment.
handlingcostDecimalFalseNoThe additional cost that is incurred for handling this item during fulfillment, including packaging, special processing, and labor expenses. This cost is factored into shipping calculations to ensure profitability and cost recovery.
handlingcostunitsStringFalseNoThe UOM that is used for calculating handling costs (for example, 'per item,' 'per order,' or 'per shipment'). Defining this UOM ensures accurate pricing and cost allocation in financial reporting and invoicing.
handlinggroupStringFalseNoThe designated handling group for this item, which determines the specific fulfillment rules, shipping restrictions, and additional processing requirements based on business policies.
imagesgroupStringFalseNoA grouping of images that are associated with this item. This grouping ensures a structured approach to managing product visuals across online listings, marketing materials, and internal documentation.
imageslocationStringFalseNoThe location or URL path where this item's images are stored, either in a digital asset-management system, an e-commerce platform, or an internal server. This location enables efficient retrieval and display of product visuals.
includechildrenBooleanFalseNoIndicates whether child items (such as components, variations, or sub-assemblies) should be included when referencing this assembly item. This field ensures accurate BOM processing, inventory tracking, and cost roll-up calculations.
incomeaccountStringFalseNoThe general ledger account where revenue from the sale of this item is recorded. Assigning the correct income account ensures accurate financial reporting and revenue recognition compliance.
intercocogsaccountStringFalseNoThe intercompany Cost of Goods Sold (COGS) account that is used for transactions involving sales between different business entities or subsidiaries within the same organization. This account ensures correct internal cost allocations and eliminates duplicate expense recognition.
intercoincomeaccountStringFalseNoThe intercompany income account that is used to recognize revenue when this item is sold between different legal entities within the organization. Proper account mapping ensures financial compliance and consistency in intercompany transactions.
internalidIntegerFalseNoThe system-generated unique Id that is assigned to this item within the database. This internal Id is used for record tracking, reporting, and system automation purposes.
iscalculatedrateStringFalseNoSpecifies whether the pricing or shipping rate for this item is dynamically calculated based on predefined formulas, such as weight-based shipping, volume pricing, or real-time carrier rates.
isdonationitemBooleanFalseNoIndicates whether this item is classified as a donation, meaning it is provided to customers, charities, or organizations without direct revenue generation. This classification is important for tax reporting and charitable contribution tracking.
isdropshipitemBooleanFalseNoDetermines whether this item is eligible for drop-shipping, meaning it is fulfilled directly by a third-party supplier rather than being stocked in internal inventory. Drop-shipping reduces holding costs and expands product availability without requiring warehouse storage.
isgcocompliantBooleanFalseNoSpecifies whether this item complies with Google Checkout (GCO) payment-processing requirements. This field ensures compatibility with Google’s payment and order processing systems for seamless e-commerce transactions.
isinactiveBooleanFalseNoIndicates whether this item is currently inactive, meaning it is not available for sale, purchase, or inventory tracking. Inactive items remain in the system for historical records and audit purposes but cannot be used in transactions.
isonlineBooleanFalseNoDetermines whether this item is available for online sales through e-commerce platforms, marketplaces, or customer portals. If this field is enabled, this item can be purchased through digital channels.
isphantomBooleanFalseNoSpecifies whether this item is a phantom item, meaning it is used only for planning purposes and does not exist as a physical stock item. Phantom items are commonly used in kitting, virtual bundling, or production-planning scenarios.
isspecialorderitemBooleanFalseNoIndicates whether this item is a special order item, meaning it is not regularly stocked and must be specifically requested from a supplier upon customer purchase.
isspecialworkorderitemBooleanFalseNoDetermines whether this item requires a specialized work order for manufacturing or assembly. Special work-order items often involve custom builds, unique configurations, or made-to-order production.
isstorepickupallowedBooleanFalseNoSpecifies whether this item is eligible for in-store pickup as a fulfillment option. Enabling this field supports omnichannel retail strategies by allowing customers to purchase online and collect in person.
issueproductStringFalseNoDefines the related product that is issued when this item is sold or consumed in inventory. This field ensures correct tracking of inventory adjustments, replacements, or substitute products.
itemconditionStringFalseNoSpecifies the condition of this item (for example, 'New,' 'Refurbished,' or 'Used'). Proper classification ensures accurate pricing, compliance with marketplace standards, and clear customer expectations.
itemhandlingfeeDecimalFalseNoThe additional handling fee charged for this item, covering extra costs related to special packaging, fragile item processing, or labor-intensive fulfillment.
itemidStringFalseNoThe unique system-generated Id for this item, which is used for inventory tracking, sales processing, and reporting purposes. This Id ensures consistency across transactions and business applications.
iteminsurancefeeDecimalFalseNoThe insurance fee that is applied to this item during shipping, providing coverage against loss, theft, or damage while in transit. This fee is an optional charge based on carrier policies or customer preferences.
itemoptionsStringFalseNoA list of customizable options available for this item (for example, size, color, or material). These options allow for product variations and enhance customer selection in sales and e-commerce environments.
itemrevenuecategoryStringFalseNoThe revenue category that is assigned to this item, which determines how its sales revenue is classified in financial reporting. This category is essential for revenue tracking, tax compliance, and financial analysis.
itemshipinsuranceStringFalseNoIndicates whether shipping insurance is available for this item, protecting against loss or damage in transit. This field can be optional or required based on shipping policies.
itemtypeStringFalseNoThe classification of this item (for example, 'inventory item,' 'assembly item,' 'non-inventory item,' or 'service'). The item type determines how it is managed in inventory, sales, and financial accounting.
lastmodifieddateDatetimeFalseNoThe date and time when this item record was last updated. This timestamp is useful for audit tracking, synchronization with external systems, and change history management.
lastpurchasepriceDecimalFalseNoThe most recent purchase price of this item, reflecting the last recorded cost from a vendor or supplier. This purchase price is important for cost tracking, pricing strategies, and margin analysis.
leadtimeIntegerFalseNoThe estimated number of days that are required to procure or manufacture this item before it becomes available for sale or use. Lead time is crucial for demand planning and inventory management.
listimmediateStringFalseNoIndicates whether this item should be immediately listed for sale upon entry into the system. This setting is commonly used in e-commerce and online marketplace integrations.
listingdurationStringFalseNoThe period for which this item remains listed for sale on an online platform, such as eBay or an e-commerce website. This period affects the visibility and expiration of the listing.
listingstartdateDateFalseNoThe date on which this item's listing becomes active in an online marketplace. This date ensures coordinated product launches and marketing campaigns.
listingstarttimeStringFalseNoThe specific time of day when this item's listing becomes active. This timestamp is often used for timed product releases, auction start times, or flash sales.
locationStringFalseNoThe primary location where this item is stored, shipped from, or available for purchase. Location tracking is essential for inventory management, logistics, and fulfillment operations.
manufacturerStringFalseNoThe name of the company or entity that manufactures this item. This information is used for vendor management, sourcing, and compliance with regulatory requirements.
manufactureraddr1StringFalseNoThe first line of the manufacturer's address, typically including the street address or P.O. Box. This address line is used for supplier tracking, regulatory filings, and logistics coordination.
manufacturercityStringFalseNoThe city where the manufacturer is located, relevant for regulatory compliance, shipping calculations, and supplier relationship management.
manufacturerstateStringFalseNoThe state or province in which the manufacturer is based. This field is important for tax calculations, trade compliance, and logistics planning.
manufacturertariffStringFalseNoThe tariff code or Harmonized System (HS) code that is assigned to this item by the manufacturer. This code is crucial for international trade, customs clearance, and import/export documentation.
manufacturertaxidStringFalseNoThe tax identification number (TIN) of the manufacturer, which is used for tax reporting, invoicing, and compliance with VAT/GST regulations.
manufacturerzipStringFalseNoThe postal or ZIP code of the manufacturer’s location, supporting logistics, tax calculations, and supply-chain management.
matchbilltoreceiptBooleanFalseNoSpecifies whether billing for this item should be matched to the receipt of goods, ensuring accurate financial reconciliation and fraud prevention.
matrixitemnametemplateStringFalseNoA naming convention template that is used to generate names for matrix (variant) items. This template ensures consistency in product catalogs and inventory records.
maxdonationamountDecimalFalseNoThe maximum monetary value or quantity that is allowed for donation transactions involving this item. This quantity is used for tax deductions, corporate giving programs, and donation limits.
maximumquantityStringFalseNoThe highest quantity of this item that can be purchased in a single transaction. This quantity helps enforce inventory controls, bulk purchase restrictions, and promotional limits.
metataghtmlStringFalseNoHTML metadata tags that are associated with this item, which are used for search engine optimization (SEO) in e-commerce platforms and product listing pages.
minimumquantityStringFalseNoThe lowest allowable quantity of this item that can be ordered or maintained in stock. This quantity is essential for order processing, bulk discounts, and procurement controls.
minimumquantityunitsStringFalseNoThe UOM that is used when enforcing minimum quantity requirements (for example, 'pieces,' 'boxes,' or 'kilograms'). This UOM ensures accurate inventory tracking and purchasing rules.
mpnStringFalseNoThe Manufacturer Part Number (MPN) for this item, assigned by the manufacturer to uniquely identify it. MPNs help in supply-chain standardization, product identification, and cross-referencing in procurement.
multmanufactureaddrBooleanFalseNoIndicates whether this item has multiple manufacturer addresses, supporting complex supply chain structures, vendor diversification, and sourcing flexibility.
nextagcategoryStringFalseNoThe assigned product category for Nextag, an online comparison shopping engine. Categorization improves search visibility and ensures proper listing placement in Nextag’s marketplace.
nextagproductfeedStringFalseNoIndicates whether this item is included in the Nextag product feed, enabling its visibility on the price comparison platform and supporting e-commerce marketing efforts.
nopricemessageStringFalseNoA message that is displayed when the item’s price is not available or hidden from the public. This message is often used for custom quotes, special promotions, or B2B pricing models.
numactivelistingsIntegerFalseNoThe total number of active listings for this item across various online marketplaces. This number helps track product availability and monitor e-commerce performance.
numcurrentlylistedIntegerFalseNoThe number of instances of this item that is currently listed for sale on online platforms. This number is useful for monitoring stock levels and preventing duplicate listings.
offersupportBooleanFalseNoIndicates whether this item includes customer support or warranty services, helping businesses communicate post-purchase support options to customers.
outofstockbehaviorStringFalseNoDefines the system behavior when this item goes out of stock (for example, 'hide listing,' 'allow backorders,' or 'notify customers'). This setting ensures proper inventory management and customer communication.
outofstockmessageStringFalseNoA customizable message displayed to customers when this item is out of stock. This message can inform buyers about restocking dates, backorder options, or alternative products.
overallquantitypricingtypeStringFalseNoSpecifies the pricing type that is applied when calculating quantity-based pricing for bulk purchases. This pricing type helps businesses implement tiered pricing strategies to encourage larger orders.
packageheightStringFalseNoThe height of the packaged item, used for shipping calculations, carrier rate determination, and warehouse storage planning.
packagelengthStringFalseNoThe length of the packaged item, essential for logistics, dimensional weight pricing, and warehouse storage allocation.
packagewidthStringFalseNoThe width of the packaged item, used for optimizing shipping costs, pallet configuration, and fulfillment processes.
pagetitleStringFalseNoThe title of the item's webpage or product listing, optimized for search engines (SEO) and online marketplace visibility.
parentStringFalseNoThe parent item that is associated with this product. Typically, this item is used in item hierarchies such as matrix items, kits, or assemblies to establish relationships between variations.
planningitemcategoryStringFalseNoThe planning category that is assigned to this item, determining how it is managed in supply-chain planning, inventory forecasting, and replenishment strategies.
preferencecriterionStringFalseNoDefines the criteria that is used to determine the preferred supplier or fulfillment source for this item. This criteria ensures optimal procurement and stock allocation.
preferredlocationStringFalseNoThe default warehouse or inventory location that is designated for storing or fulfilling this item. This setting optimizes logistics, fulfillment efficiency, and stock replenishment.
preferredstockleveldaysDoubleFalseNoThe number of days of inventory supply to maintain at the preferred stock level. This information helps businesses balance inventory turnover with demand forecasting.
pricinggroupStringFalseNoThe pricing group to which this item belongs. This pricing group is used for managing bulk discounts, promotional pricing, or customer-specific price lists.
primarycatdisplaynameStringFalseNoThe display name of the primary category that is assigned to this item. This display name ensures proper categorization and discoverability in online stores and product catalogs.
primarycategoryIntegerFalseNoThe primary category Id that is assigned to this item. This Id determines its classification in product hierarchies, inventory reports, and e-commerce platforms.
printitemsBooleanFalseNoSpecifies whether this item should be included in printed sales documents such as invoices, packing slips, and order confirmations.
prodpricevarianceacctStringFalseNoThe general ledger account that is used to track variances in the production cost of this item due to price fluctuations in raw materials or manufacturing expenses.
prodqtyvarianceacctStringFalseNoThe account that is used to track discrepancies between expected and actual production quantities. This account ensures accurate financial reconciliation and cost control.
producerBooleanFalseNoIndicates whether this item is classified as a producer item, meaning it generates another item or is part of a production process. This field affects manufacturing workflows and cost tracking.
productfeedStringFalseNoDefines whether this item is included in external product feeds for online marketplaces, comparison shopping engines, and advertising platforms such as Google Shopping.
purchasedescriptionStringFalseNoThe description of this item as it appears on purchase orders. This description is used for supplier communication, procurement documentation, and receiving processes.
purchaseorderamountStringFalseNoThe total monetary amount for this item in purchase orders, reflecting procurement costs and budget allocations.
purchaseorderquantityStringFalseNoThe quantity of this item that is included in purchase orders. This quantity ensures accurate inventory replenishment and vendor fulfillment tracking.
purchaseorderquantitydiffStringFalseNoThe difference between the ordered and received quantities for this item in purchase orders. This difference helps identify discrepancies and manage supplier performance.
purchasepricevarianceacctStringFalseNoThe account that is used to track price variances between the standard purchase price and the actual cost paid. This account ensures financial transparency and budget control.
purchaseunitStringFalseNoThe UOM in which this item is purchased from suppliers (for example, 'cases,' 'pallets,' or 'kilograms'). This UOM affects procurement and inventory tracking.
quantitypricingscheduleStringFalseNoThe predefined pricing schedule for quantity-based discounts. This schedule allows businesses to offer lower prices for bulk purchases.
quantityreorderunitsStringFalseNoThe standard unit in which this item is reordered, ensuring consistency in procurement and inventory replenishment strategies.
receiptamountStringFalseNoThe total monetary value of this item received from suppliers. This value helps reconcile payments with purchase orders and financial records.
receiptquantityStringFalseNoThe actual quantity of this item received in inventory upon delivery. This quantity ensures alignment between purchase orders and received stock.
receiptquantitydiffStringFalseNoThe difference between the ordered and received quantities of this item. This information identifies potential errors, supplier inconsistencies, or inventory miscounts.
refundgivenasStringFalseNoThe method by which refunds for this item are issued (for example, store credit, cash, or replacement items). This method ensures compliance with return policies.
relateditemsdescriptionStringFalseNoA description of related items commonly purchased with this product. This description supports upselling and cross-selling strategies in e-commerce and retail environments.
reordermultipleStringFalseNoThe fixed quantity in which this item should be reordered. This quantity ensures efficient stock replenishment and supplier order fulfillment.
rescheduleindaysIntegerFalseNoThe number of days an incoming order for this item can be rescheduled earlier based on demand fluctuations and inventory needs.
rescheduleoutdaysIntegerFalseNoThe number of days an order for this item can be postponed without disrupting supply chain operations or order fulfillment schedules.
reservepriceDecimalFalseNoThe minimum price that must be met in an online auction before the item can be sold. This minimum price prevents the item from being sold below a set threshold, ensuring profitability in auction-based sales.
returnpolicyStringFalseNoThe general return policy for this item, outlining the conditions under which returns are accepted. This field is critical for customer satisfaction and regulatory compliance.
returnpolicydetailsStringFalseNoAdditional details about the return policy, such as restocking fees, condition requirements, or special terms applicable to specific customer groups or markets.
returnshippingpaidbyStringFalseNoSpecifies who is responsible for paying the return shipping costs, either the buyer or seller. This specification affects return policies and customer service strategies.
returnswithinStringFalseNoDefines the timeframe within which a return request must be initiated after purchase. This timeframe is used to enforce return policies and protect both buyers and sellers.
revenueallocationgroupStringFalseNoThe revenue allocation group that determines how revenue is distributed across multiple products or services in a bundled sale. This information ensures compliance with revenue recognition standards.
revenuerecognitionruleStringFalseNoThe specific revenue recognition rule that is applied to this item. This rule determines when and how revenue from its sale is recorded in financial statements.
revrecforecastruleStringFalseNoThe revenue recognition forecast rule used to project revenue over a period of time. This rule ensures alignment with accounting principles and financial forecasting.
revrecscheduleStringFalseNoThe predefined schedule dictating how revenue from this item is recognized over time, such as immediate recognition, percentage-of-completion, or deferred revenue models.
safetystocklevelDoubleFalseNoThe minimum quantity of this item that should always be maintained in stock to prevent shortages. This quantity is used in inventory management to reduce the risk of stockouts.
safetystockleveldaysIntegerFalseNoThe number of days of inventory coverage the safety stock level should provide. This number ensures that fluctuations in demand or supply-chain delays do not disrupt operations.
safetystocklevelunitsStringFalseNoThe UOM that is used for tracking the safety stock level (for example, 'units,' 'cases,' or 'pallets'). This UOM ensures accurate replenishment calculations.
saleunitStringFalseNoThe UOM in which this item is sold. This UOM ensures consistent pricing, inventory tracking, and order fulfillment.
schedulebcodeStringFalseNoThe Schedule B code that is used for U.S. export reporting. This cod ensures compliance with international trade regulations and facilitating customs documentation.
schedulebnumberStringFalseNoThe classification number that is assigned under the Schedule B system for tracking exported goods, required for regulatory reporting and trade compliance.
schedulebquantityStringFalseNoThe quantity unit that is required for Schedule B export reporting (for example, 'dozen' or 'kilograms'). This unit ensures standardized measurement for trade reporting.
scrapacctStringFalseNoThe general ledger account used to record the cost of scrapped or discarded items. This account ensures proper tracking of waste and inventory write-offs.
searchkeywordsStringFalseNoA list of keywords associated with this item to improve search engine discoverability in e-commerce platforms, online marketplaces, and internal catalogs.
seasonaldemandBooleanFalseNoIndicates whether this item experiences seasonal fluctuations in demand. This value affects inventory planning, marketing strategies, and production scheduling.
secondarycatdisplaynameStringFalseNoThe display name of the secondary category assigned to this item. This display name ensures proper classification and searchability in product catalogs and e-commerce sites.
secondarycategoryIntegerFalseNoThe secondary category Id that is assigned to this item. This Id provides additional classification beyond the primary category for better product organization.
sellonebayBooleanFalseNoSpecifies whether this item is listed for sale on eBay. This field enables businesses to expand their online marketplace presence.
shipasiaBooleanFalseNoIndicates whether this item can be shipped to countries in Asia. This field ensures accurate shipping policy enforcement and international order processing.
shipaustraliaBooleanFalseNoIndicates whether this item can be shipped to Australia, ensuring compliance with regional shipping restrictions and fulfillment options.
shipcanadaBooleanFalseNoDetermines whether this item is available for shipping to Canada. This field allows businesses to manage cross-border sales and logistics efficiently.
shipeuropeBooleanFalseNoIndicates whether this item can be shipped to European countries. This field ensures that proper tax, customs, and shipping regulations are accounted for.
shipgermanyBooleanFalseNoSpecifies whether this item can be shipped to Germany. This field ensures compliance with EU trade regulations and shipping policies.
shipindividuallyBooleanFalseNoIndicates whether this item must be shipped separately from other items in an order due to size, weight, or packaging constraints, affecting fulfillment and shipping costs.
shipjapanBooleanFalseNoDetermines whether this item is available for shipping to Japan. This field ensures proper international shipping logistics and compliance with customs regulations.
shipmexicoBooleanFalseNoIndicates whether this item can be shipped to Mexico. This field ensures proper tax calculation and cross-border shipping compliance.
shipnorthsouthamericaBooleanFalseNoDetermines whether this item is available for shipping to countries in North and South America, affecting international fulfillment strategies.
shippackageStringFalseNoThe package type that is used for shipping this item (for example, 'box,' 'envelope,' or 'tube'). This package type ensures compatibility with carrier shipping policies.
shippingcostDecimalFalseNoThe cost that is associated with shipping this item, either as a fixed amount or dynamically calculated based on carrier rates and customer location.
shippingcostunitsStringFalseNoThe UOM that is used to calculate shipping costs (for example, 'per item,' 'per weight unit,' or 'per order'). This UOM ensures accurate pricing.
shippingdomesticmethodsgroupStringFalseNoA grouping of domestic shipping methods available for this item (for example, standard, expedited, or overnight shipping).
shippingdomgroupStringFalseNoDefines the domestic shipping-policy group for this item. This field ensures that shipping options are properly assigned based on customer location.
shippingintlgroupStringFalseNoDefines the international shipping-policy group for this item. This field ensures compliance with regional carrier availability, customs duties, and international shipping restrictions.
shippingintlgroup1StringFalseNoThe first set of international shipping methods assigned to this item. This method set helps businesses manage country-specific logistics options.
shippingintlgroup2StringFalseNoThe second set of international shipping options available for this item. This method set ensures flexibility in global shipping strategies.
shippingintlgroup3StringFalseNoThe third set of international shipping methods assigned to this item. This method set allows for diversified shipping options across multiple regions.
shippingitem1StringFalseNoThe first designated shipping item or method that is associated with this product. This item or method defines specific carrier options, shipping tiers, or flat-rate shipping for fulfillment operations.
shippingitem2StringFalseNoThe second designated shipping item or method for this product. This item or method provides an alternative shipping option for different regions, customer preferences, or delivery timeframes.
shippingitem3StringFalseNoThe third designated shipping item or method available for this product. This item or method enables multiple shipping choices across various fulfillment strategies.
shippinglocationsgroupStringFalseNoThe predefined group of shipping locations where this item is available for fulfillment. This information helps streamline logistics by restricting or prioritizing fulfillment centers based on location.
shippingpackaginggroupStringFalseNoThe assigned packaging group that determines the type of packaging used for this item. This information impacts shipping costs, weight calculations, and dimensional pricing.
shippingrate1DecimalFalseNoThe primary shipping rate associated with this item. This rate defines the base shipping cost for domestic or international deliveries.
shippingrate2DecimalFalseNoThe secondary shipping rate applied when alternative shipping methods, weight classes, or regional adjustments are required.
shippingrate3DecimalFalseNoThe tertiary shipping rate option used for specific conditions such as expedited shipping, bulk orders, or tiered pricing structures.
shipukBooleanFalseNoIndicates whether this item is eligible for shipping to the United Kingdom. This field ensures compliance with regional shipping policies and tax regulations.
shipworldwideBooleanFalseNoSpecifies whether this item can be shipped globally. This field allows for international sales and fulfillment without geographic restrictions.
shoppingdotcomcategoryStringFalseNoThe product category that is assigned for listings on Shopping.com. This category ensures accurate product classification and improved visibility in online comparison shopping engines.
shoppingproductfeedStringFalseNoIndicates whether this item is included in Shopping.com’s product feed. This field enables automated updates to pricing, availability, and product details.
shopzillacategoryidIntegerFalseNoThe category Id that is assigned to this item in Shopzilla’s marketplace. This Id ensures proper classification and search optimization in online comparison shopping platforms.
shopzillaproductfeedStringFalseNoSpecifies whether this item is included in Shopzilla’s product feed.This field ensures regular data synchronization for online visibility and competitive pricing strategies.
showasgiftBooleanFalseNoIndicates whether this item can be purchased as a gift. This field enables additional checkout options such as gift wrapping or customized messaging.
showdefaultdonationamountBooleanFalseNoDetermines whether a default donation amount is displayed for this item. This donation amount is commonly used in charitable or fundraising sales models.
sitemappriorityStringFalseNoThe priority level that is assigned to this item in the website’s sitemap. This priority level influences how search engines rank its importance relative to other products.
softdescriptorStringFalseNoA custom descriptor that appears on customer bank statements for transactions involving this item. This descriptor helps identify purchases clearly and reduces chargeback disputes.
standardimagesStringFalseNoA set of predefined standard images that are associated with this item. This image set is used in product catalogs, online listings, and marketing materials.
startingpriceDecimalFalseNoThe minimum starting price for an auction or promotional sale of this item. This price defines the initial bid or entry-level discount.
stockdescriptionStringFalseNoA brief summary of the stock availability and status for this item. This summary provides key inventory insights for sales and logistics teams.
stockunitStringFalseNoThe UOM that is used to track this item in inventory (for example, 'pieces,' 'packs,' or 'boxes'). This UOM ensures consistency in stock management.
storecatdisplaynameStringFalseNoThe display name of the primary store category assigned to this item. This display name ensures organized product placement in online and physical store catalogs.
storecatdisplayname2StringFalseNoThe secondary store-category display name. This display name provides an additional classification for multi-category listings in online stores.
storecategoryIntegerFalseNoThe primary store category Id that is associated with this item. This Id enables accurate product classification for store navigation and merchandising.
storecategory2IntegerFalseNoThe secondary store category Id for this item. This Id allows businesses to assign multiple product categories for better cross-selling and search visibility.
storedescriptionStringFalseNoA general description of this item as it appears in the store. This description ensures informative and engaging product listings.
storedetaileddescriptionStringFalseNoAn extended, detailed description of this item, often including technical specifications, features, and benefits to assist potential buyers.
storedisplayimageStringFalseNoThe main product image that is displayed in the online store or catalog. This image is used for visual representation and marketing purposes.
storedisplaynameStringFalseNoThe name of this item as it appears in store listings. This item name ensures clear and recognizable product identification for customers.
storedisplaythumbnailStringFalseNoA smaller, thumbnail-sized version of the product image that is used in search results, category pages, and recommendation sections.
storeitemtemplateStringFalseNoThe predefined store template that is used for this item’s online listing. This template ensures consistent branding and layout in digital storefronts.
subsidiaryStringFalseNoThe subsidiary or business entity that is responsible for managing, selling, or reporting on this item. This entity ensures proper financial and operational segmentation.
supersizeimagesBooleanFalseNoDetermines whether high-resolution, supersized images should be used for this item. This option enhances visual clarity in online product listings.
supplyreplenishmentmethodStringFalseNoThe method that is used to replenish stock for this item, such as manual ordering, automated reorder points, or just-in-time inventory management. This method ensures optimal stock levels and reduces shortages or excess inventory.
supplytimefenceIntegerFalseNoThe number of days within which supply orders (for example, purchase orders, manufacturing orders) should not be rescheduled or adjusted. This information prevents last-minute disruptions in procurement and production planning.
taxableBooleanFalseNoIndicates whether this item is subject to taxation. If this field is enabled, sales transactions will include applicable taxes based on regional tax rules and tax schedules.
taxscheduleStringFalseNoThe tax schedule that is assigned to this item, determining the tax rates and rules applicable in different jurisdictions. This tax schedule ensures compliance with local and international tax regulations.
templatesgroupStringFalseNoThe predefined group of templates that is associated with this item. These templates are used for generating sales orders, purchase orders, and other transactional documents.
totalvalueDecimalFalseNoThe total financial value of this item in inventory, calculated as unit cost multiplied by available quantity. This value is essential for financial reporting, cost accounting, and asset valuation.
tracklandedcostBooleanFalseNoIndicates whether landed costs (for example, shipping, customs duties, insurance) should be tracked for this item. This information helps in calculating the true cost of goods for profitability analysis.
transferpriceDecimalFalseNoThe price at which this item is transferred between different business entities, warehouses, or subsidiaries within an organization. This price is essential for intercompany transactions and cost allocation.
transferpriceunitsStringFalseNoThe UOM that is used for transfer pricing. This UOM ensures consistency in cost tracking when moving inventory between locations or business entities.
unbuildvarianceaccountStringFalseNoThe general ledger account that is used to record cost variances when this item is unbuilt (disassembled). This account ensures accurate financial tracking in manufacturing operations.
unitstypeStringFalseNoThe classification of units that is used for this item, such as 'weight-based' or 'volume-based'. This classification ensures consistency in inventory measurements and transactions.
upccodeStringFalseNoThe Universal Product Code (UPC) that is assigned to this item. This UPC is used for barcode scanning, product identification, and retail transactions.
urlcomponentStringFalseNoThe SEO-friendly URL slug for this item’s product page. This URL slug ensures improved search engine rankings and easy navigation in e-commerce platforms.
usebinsBooleanFalseNoIndicates whether this item uses bin tracking in inventory management. This value ensures accurate stock control by specifying bin locations within warehouses.
usemarginalratesBooleanFalseNoDetermines whether marginal tax rates apply to this item, impacting how tax calculations are performed for progressive tax structures.
vendornameStringFalseNoThe name of the preferred vendor or supplier for this item. This information is used for procurement, purchase order processing, and vendor performance tracking.
vendreturnvarianceaccountStringFalseNoThe general ledger account that isused to track variances related to vendor returns (for example, price differences or quantity discrepancies). This account ensures accurate reconciliation.
vsoedeferralStringFalseNoSpecifies how revenue for this item should be deferred under Vendor-Specific Objective Evidence (VSOE) accounting rules. This field ensures compliance with revenue recognition standards.
vsoedeliveredBooleanFalseNoIndicates whether this item has been delivered in a transaction that follows VSOE revenue recognition rules. This information determines when revenue can be recognized.
vsoepermitdiscountStringFalseNoDefines whether this item is eligible for discounts under VSOE accounting. This field ensures compliance with financial reporting standards.
vsoepriceDecimalFalseNoThe price used for Vendor-Specific Objective Evidence (VSOE) compliance. This price ensures that revenue is recognized correctly for bundled sales or software transactions.
vsoesopgroupStringFalseNoThe VSOE Standard Operating Procedure (SOP) group that is assigned to this item. This information ensures proper revenue allocation and compliance with financial regulations.
weightDoubleFalseNoThe physical weight of this item, which is used for shipping cost calculations, carrier selection, and warehouse storage optimization.
weightunitStringFalseNoThe UOM for the item's weight (for example, 'pounds,' 'kilograms,' or 'grams'). This UOM ensures accurate shipping and handling calculations.
weightunitsStringFalseNoThe plural form of the UOM for the item's weight, which ensures consistency in reporting and documentation.
willshipStringFalseNoIndicates whether this item is available for shipping. This field helps businesses manage fulfillment strategies and logistics constraints.
wipacctStringFalseNoThe Work-In-Progress (WIP) general ledger account that is used to track the value of partially completed goods in the production process.
wipvarianceacctStringFalseNoThe general ledger account that is used to record cost variances that occur during the Work-In-Progress (WIP) phase of manufacturing. This account ensures accurate cost tracking.
yahooproductfeedStringFalseNoSpecifies whether this item is included in Yahoo’s product feed. This field ensures accurate data synchronization for e-commerce listings and online advertising campaigns.

Return to Top

assemblyitembom 

NameTypeReadOnlyReferencesFilterOnlyDescription
assemblyStringFalseNoThe unique identifier (Id) of the assembly item that is associated with this Bill of Materials (BOM) in NetSuite. This field links the BOM configuration to the correct inventory assembly record.
billofmaterialsStringFalseNoThe unique Id of the BOM record that defines the components and structure for the associated assembly item. This field ensures proper version control and component tracking.
defaultBooleanFalseNoIndicates whether this BOM version is the default option for the associated assembly item. A value of 'true' means this version is used unless a different one is specified during transactions.
locationsStringFalseNoThe list of location Ids where this BOM version is applicable. Locations are separated by commas and represent warehouses or fulfillment centers (for example, '1, 2, or 5').

Return to Top

assemblyItemCorrelateditem 

NameTypeReadOnlyReferencesFilterOnlyDescription
correlationfldDoubleFalseNoThe correlation percentage representing the statistical relationship between this item and a correlated item based on past purchase behavior or inventory movements. A higher correlation indicates a stronger likelihood of these items being purchased together.
countfldIntegerFalseNoThe number of times this item has been sold or used in conjunction with the correlated item. This field helps in identifying frequently paired products for cross-selling and inventory planning.
itemStringFalseNoThe unique identifier (Id) for the primary item in the correlation analysis. This item is analyzed to determine its relationship with other items based on sales data, usage patterns, or historical transactions.
itemnkeyfldStringFalseNoThe correlated item that has been frequently purchased or used with the primary item. This item is used for product bundling, recommendation engines, and demand forecasting.
liftfldDoubleFalseNoThe lift percentage representing the increase in likelihood of purchasing the correlated item when the primary item is bought. A lift value greater than 1.0 indicates that the correlated item is more likely to be purchased together with the primary item than by random chance.

Return to Top

assemblyItemItemAccountingBookDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe specific accounting book that is associated with this item, which determines the financial reporting rules, currency adjustments, and accounting standards applied. This field ensures compliance with multi-book accounting practices and regulatory requirements.
itemStringFalseNoThe unique identifier (Id) for the assembly item being tracked in this accounting book. This Id ensures that financial transactions, cost tracking, and reporting align with the appropriate accounting records.

Return to Top

assemblyItemItemQuantityPricingDiscount 

NameTypeReadOnlyReferencesFilterOnlyDescription
leveldiscountDoubleFalseNoThe discount percentage or amount that is applied to this item based on the assigned price level. This discount is used for volume-based pricing, promotional discounts, and customer-specific pricing structures.
levelpricenameStringFalseNoThe predefined price level that is associated with this discount. This price level determines the pricing tier applied to different customer groups, order quantities, or sales channels.
parentitemStringFalseNoThe item to which this pricing discount is applied. This field ensures that quantity-based discounts are correctly assigned to the corresponding assembly or inventory item.

Return to Top

assemblyItemItemQuantityPricingLevel 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe unique identifier (Id) for the assembly item to which this pricing level applies. This Id ensures that quantity-based discounts or price adjustments are accurately assigned to the correct inventory item.
leveldiscountDoubleFalseNoThe discount percentage or fixed amount that is applied to this item at the specified quantity pricing level. This Id is used for volume-based pricing strategies, wholesale discounts, and promotional offers.

Return to Top

assemblyItemItemVendor 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe unique identifier (Id) for the assembly item being sourced from a vendor. This Id ensures accurate tracking of supplier relationships, procurement costs, and vendor-specific pricing.
preferredvendorBooleanFalseNoIndicates whether this vendor is the preferred supplier for this item. A preferred vendor is prioritized for purchase orders and procurement planning to maintain supplier consistency and favorable pricing agreements.
purchasepriceStringFalseNoThe price at which this item is purchased from the vendor. This price is essential for cost tracking, profitability analysis, and purchase order creation.
scheduleStringFalseNoThe purchasing schedule that is associated with this vendor for this item. This schedule defines order frequency, delivery timelines, and contract-based supply agreements.
subsidiaryStringFalseNoThe subsidiary or business entity that procures this item from the specified vendor. This entity is used for multi-entity financial reporting and internal cost allocations.
vendorStringFalseNoThe name of the vendor supplying this item. This information is crucial for managing supplier relationships, purchase negotiations, and sourcing strategies.
vendorcodeStringFalseNoA unique Id or code that is assigned to the vendor in the system. This code facilitates streamlined vendor management, procurement automation, and supplier compliance tracking.
vendorcostenteredDecimalFalseNoThe cost of this item as entered by the vendor. This cost reflects the agreed purchase price before adjustments, taxes, or volume discounts.
vendorcurrencyidStringFalseNoThe currency in which the vendor's purchase price is denominated. This field ensures proper multi-currency financial tracking, exchange rate calculations, and international procurement compliance.

Return to Top

assemblyItemLocations 

NameTypeReadOnlyReferencesFilterOnlyDescription
atpleadtimeIntegerFalseNoThe number of days that are required to fulfill an Available-to-Promise (ATP) request for this assembly item at the specified location. This value determines how long it takes before the item can be committed to a sales order, factoring in supply chain constraints, open purchase orders, and production lead times.
averagecostmliDecimalFalseNoThe calculated average cost of the assembly item at this location, used for financial reporting and inventory valuation. This cost is typically derived from historical purchase prices, manufacturing costs, and any additional cost allocations. It plays a crucial role in cost accounting and profitability analysis.
backwardconsumptiondaysIntegerFalseNoThe number of days before a planned order’s requirement date during which demand can consume available supply. This setting allows NetSuite to balance fluctuations in demand by allowing sales orders or work orders to consume supply from earlier production or procurement.
costDecimalFalseNoThe standard cost that is assigned to the assembly item at this location, used as a benchmark for cost control, variance analysis, and financial reporting. Standard costing is commonly applied in manufacturing and inventory valuation to maintain consistent pricing and profitability tracking.
costaccountingstatusStringFalseNoThe current cost accounting status of the assembly item, indicating whether cost calculations and adjustments have been applied. This status helps businesses track whether cost updates (such as standard cost changes or revaluations) have been finalized in financial records.
costinglotsizeDoubleFalseNoThe predetermined lot size that is used for costing calculations, defining the quantity basis for cost allocations. This value influences cost-per-unit calculations in standard costing and helps determine accurate product cost structures in NetSuite’s financial and inventory management modules.
currentstandardcostDecimalFalseNoThe most recent standard cost that is applied to the assembly item at this location, reflecting the expected cost per unit for financial and operational decision-making. This value is updated periodically based on cost accounting rules and is used in financial statements, inventory valuation, and profitability analysis.
currentstandardcosteffectivedateDateFalseNoThe date on which the current standard cost became effective, marking the transition point for financial reporting and inventory valuation. This date ensures that any cost changes are properly tracked and applied to transactions occurring after this date.
defaultreturncostDecimalFalseNoThe cost that is automatically assigned when the assembly item is returned at this location. This value is used to determine the financial impact of returns and ensure proper accounting for returned inventory, refunds, or credit memos issued to customers.
demandsourceStringFalseNoThe primary source of demand for this assembly item at the specified location. Common demand sources include customer sales orders, work orders for manufacturing, and intercompany transfers. This information is critical for demand planning, order fulfillment, and inventory allocation strategies.
demandtimefenceIntegerFalseNoThe number of days within which new demand (such as sales orders or work orders) is not automatically considered in planning calculations. This value helps stabilize inventory planning by preventing sudden changes to supply orders based on short-term demand fluctuations.
fixedlotsizeDoubleFalseNoThe predefined fixed lot size for replenishment and order fulfillment. This value ensures that procurement and production orders are generated in consistent batch sizes, optimizing efficiency in manufacturing and supply chain management.
forwardconsumptiondaysIntegerFalseNoThe number of days after a planned order’s requirement date during which demand can consume available supply. This date allows inventory to be allocated flexibly, preventing short-term shortages while optimizing order fulfillment.
inventorycosttemplateStringFalseNoThe inventory cost template that is assigned to the assembly item, defining the cost structure and accounting rules applied at this location. Cost templates standardize how inventory costs are calculated, ensuring uniform cost management across different locations and subsidiaries.
invtclassificationStringFalseNoThe classification category that is assigned to the inventory item, used for segmentation, reporting, and planning purposes. Inventory classifications can include fast-moving, slow-moving, obsolete, or other categories based on business rules.
invtcountintervalIntegerFalseNoThe interval, in days, between scheduled inventory counts for this assembly item at the specified location. Regular inventory counts help maintain accurate stock levels and prevent discrepancies in inventory records.
iswipBooleanFalseNoIndicates whether this assembly item is classified as work-in-progress (WIP) inventory at this location. WIP items are partially completed products that are still in the production process, affecting manufacturing cost tracking and financial reporting.
itemStringFalseNoThe unique identifier (Id) or name of the assembly item associated with this inventory record. This Id is used across NetSuite for tracking, reporting, and order management.
lastinvtcountdateDateFalseNoThe most recent date on which a physical inventory count was conducted for this assembly item at this location. Accurate counting ensures proper stock levels and financial reconciliation.
lastpurchasepricemliDecimalFalseNoThe last recorded purchase price of the assembly item at this location, reflecting the most recent procurement cost from a vendor. This value helps determine future pricing strategies and cost trends.
locationStringFalseNoThe specific location or warehouse where this inventory record applies. NetSuite allows businesses to manage inventory across multiple locations, and this value ensures stock movements are properly tracked.
nextinvtcountdateDateFalseNoThe next scheduled date for a physical inventory count of this assembly item at the specified location. Scheduled counts help maintain accurate inventory records and prevent stock discrepancies.
onhandvaluemliDecimalFalseNoThe total inventory value of the assembly item on hand at this location, calculated based on the assigned costing method. This value is used for financial reporting, tax calculations, and profitability analysis.
periodiclotsizedaysIntegerFalseNoThe number of days that define the periodic lot-size increment for supply planning. This setting influences order scheduling and batch production, ensuring efficient use of resources and supply planning strategies.
periodiclotsizetypeStringFalseNoThe type of periodic lot-sizing method that is used for this assembly item, affecting the supply plan's lot-sizing calculations. Common types include fixed period, min-max replenishment, and economic order quantity (EOQ).
preferredstocklevelDoubleFalseNoThe target stock level that is maintained for the assembly item at this location to optimize inventory availability and reduce shortages. This level is used to ensure adequate supply without excessive overstocking.
qtyintransitexternalDoubleFalseNoThe quantity of this assembly item currently in transit from external sources such as suppliers or third-party logistics providers. These in-transit quantities are expected to arrive at the location but are not yet available for use.
quantityavailableDoubleFalseNoThe total quantity of the assembly item that is available for sale or use at this location, excluding committed or reserved stock. This value is critical for order fulfillment and inventory allocation.
quantitybackorderedDoubleFalseNoThe total quantity of this assembly item that is backordered due to insufficient stock availability at the location. Backordered items indicate demand that cannot be met currently.
quantitycommittedDoubleFalseNoThe total quantity of the assembly item that is committed to sales orders, work orders, or other planned allocations at this location. Committed quantities are reserved and unavailable for other transactions.
quantityintransitDoubleFalseNoThe total quantity of this assembly item that is currently in transit between locations or warehouses. These quantities are expected to be received but are not yet physically available.
quantityonhandDoubleFalseNoThe actual quantity of the assembly item that is physically available at this location, used for stock tracking and order fulfillment.
quantityonorderDoubleFalseNoThe total quantity of the assembly item that is currently on order but not yet received at this location. These items are expected from suppliers or internal production.
reorderpointDoubleFalseNoThe minimum stock level that triggers a replenishment order to avoid stockouts at this location. Reorder points ensure that inventory is replenished in time to meet demand.
rescheduleindaysIntegerFalseNoThe number of days by which existing supply orders can be moved forward in the schedule to meet demand requirements. This information helps optimize inventory planning and prevent shortages.
rescheduleoutdaysIntegerFalseNoThe number of days by which existing supply orders can be deferred to a later date without affecting demand fulfillment. This information helps optimize resource utilization and minimize excess inventory.
supplylotsizingmethodStringFalseNoThe lot-sizing method that is used for generating supply orders, such as fixed, lot-for-lot, or periodic order quantity. This method determines how purchase and production orders are sized.
supplytimefenceIntegerFalseNoThe number of days within which new supply orders are restricted from being automatically created to stabilize planning and avoid excessive adjustments.
supplytypeStringFalseNoThe category of supply fulfillment for this assembly item, such as make-to-stock, make-to-order, or purchase order-based supply. This classification helps define sourcing strategies.

Return to Top

assemblyItemMember 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe system-generated identifier (Id) for this assembly-item member record. This unique value is used to track and reference specific component associations within the bill of materials (BOM) structure.
bomquantityDecimalFalseNoThe quantity of this component that is required to assemble one unit of the parent assembly item, as defined in the BOM. This value determines material consumption per unit of finished goods.
componentyieldDoubleFalseNoThe expected yield percentage of this component when used in the assembly process. A yield lower than 100% accounts for potential scrap, wastage, or inefficiencies in manufacturing.
effectivedateDateFalseNoThe date when this component becomes effective as part of the BOM for the parent assembly item. Any production or procurement using this BOM before this date does not include the component.
effectiverevisionStringFalseNoThe specific revision of the BOM where this component becomes effective. BOM revisions track changes to product configurations, ensuring that the correct components are used at the right time.
itemStringFalseNoThe unique Id or name of the component item that is included in the assembly. This item is used as a subcomponent in the parent assembly item’s BOM.
itemsourceStringFalseNoThe source of this component, specifying whether it is manufactured internally, procured from vendors, or transferred from another location. This classification helps determine supply chain strategies for the component.
linenumberIntegerFalseNoThe system-assigned line Id for this component within the BOM. Line numbers define the sequence in which components are listed and help differentiate between multiple components.
obsoletedateDateFalseNoThe date when this component is no longer valid for use in the BOM. After this date, the component is considered obsolete and should not be included in new production runs.
obsoleterevisionStringFalseNoThe specific revision of the BOM where this component becomes obsolete. This revision ensures that outdated components are removed from active production and replaced with newer versions if applicable.
parentitemStringFalseNoThe parent assembly item that this component belongs to in the BOM. This item defines the hierarchical relationship between the finished product and its subcomponents.
quantityDecimalFalseNoThe total quantity of this component that is required for the specified parent assembly item, as defined in the BOM. This value determines material requirements for production planning and procurement.

Return to Top

assemblyItemPresentationItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
basepriceDecimalFalseNoThe standard base price that is assigned to this presentation item before any discounts, promotions, or custom pricing rules are applied. This price serves as the default pricing reference in sales transactions.
descriptionStringFalseNoThe descriptive text that provides details about the presentation item, including its features, specifications, or intended use. This description is displayed in item records and may appear in online listings or sales documents.
onlinepriceDecimalFalseNoThe price of the presentation item when sold through an online storefront, e-commerce platform, or web-store integration. This price can differ from the base price due to online-specific pricing strategies or promotional discounts.
presentationitemStringFalseNoThe related item that is displayed alongside the primary assembly item as part of a presentation or recommendation strategy. This item might be suggested for upselling, bundling, or enhancing the customer purchase experience.
presitemidIntegerFalseNoThe system-generated identifier (Id) for this presentation item record. This unique Id is used to track and reference the presentation relationship within NetSuite’s database.
superitemStringFalseNoThe primary or parent item that is associated with this presentation item. This field defines hierarchical relationships between assembly items and their related presentation items, often used in product groupings or recommendation logic.

Return to Top

assemblyItemPrice 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencypageStringFalseNoThe currency that is associated with the pricing of the assembly item. This value determines the monetary unit in which the price is displayed and transactions are processed.
discountdisplayDoubleFalseNoThe default discount percentage that is applied to the assembly item price, representing a standard reduction in cost before any additional adjustments or promotions.
isinactiveBooleanFalseNoIndicates whether the assembly item price is inactive within the system. When set to 'true', this price record is not used in calculations, transactions, or customer-facing pricing displays.
itemStringFalseNoThe assembly item for which the price is being set. This item refers to a finished good or bundled product composed of multiple components, which is typically manufactured or assembled before being sold.
priceDecimalFalseNoThe amount that is assigned as the price for the assembly item. This value reflects the base cost before any applicable discounts, taxes, or additional charges.

Return to Top

assemblyItemQuantity 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe assembly item for which quantity limits are being set. This item refers to a finished good or bundled product that is composed of multiple components, typically manufactured or assembled before being sold.
maxcountIntegerFalseNoThe maximum quantity that is allowed for the assembly item in inventory management, order processing, or stock allocation. This limit can be used for operational constraints, stocking policies, or compliance with business rules.
mincountIntegerFalseNoThe minimum quantity that is required for the assembly item to maintain inventory levels, trigger reorder points, or meet production-and-demand planning requirements.

Return to Top

assemblyItemSiteCategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
categorydescriptionStringFalseNoThe description of the category that is assigned to the assembly item. This description provides details about its classification for organizational, display, or reporting purposes.
isdefaultBooleanFalseNoIndicates whether this category is the preferred or default category for the assembly item within the system. When this column is set to 'true', this category is automatically selected for relevant processes.
itemStringFalseNoThe assembly item that is associated with the site category. This item refers to a finished good or bundled product composed of multiple components, which is typically manufactured or assembled before being sold.
websiteStringFalseNoThe website or online storefront where the assembly item is categorized, determining how it is displayed, filtered, or organized for customers and internal users.

Return to Top

assemblyItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe assembly item that is associated with the subsidiary mapping. This item refers to a finished good or bundled product composed of multiple components, which is typically manufactured or assembled before being sold. This mapping determines how the item is assigned to different subsidiaries within the organization for financial reporting, inventory tracking, and operational management.

Return to Top

assemblyItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe assembly item for which translation details are being provided. This item refers to a finished good or bundled product composed of multiple components, which is typically manufactured or assembled before being sold.
displaynameStringFalseNoThe translated display name of the assembly item, shown in various interfaces such as e-commerce sites, catalogs, and reports.
languageStringFalseNoThe language that is associated with the translated content. This language ensures that the assembly item information is accurately localized for different regions or markets.
nopricemessageStringFalseNoThe translated message that is displayed when no price is available for the assembly item. Typically, this message is in online stores or catalogs.
outofstockmessageStringFalseNoThe translated message that is shown when the assembly item is out of stock. This message informs customers or users about the item's unavailability.
pagetitleStringFalseNoThe translated page title for the assembly item's product page, affecting how the page appears in browser tabs and search engine results.
salesdescriptionStringFalseNoThe translated sales description that is used in marketing materials, product listings, and promotional content to highlight the assembly item’s features and benefits.
storedescriptionStringFalseNoThe translated general description of the assembly item as displayed in the online store. This description provides essential product details.
featureddescriptionStringFalseNoThe translated featured description that is used for promotional displays. This description emphasizes key selling points or special attributes of the assembly item.
specialsdescriptionStringFalseNoThe translated description that is used in special promotions, discounts, or limited-time offers to attract customer interest.
storedisplaynameStringFalseNoThe translated name of the assembly item as it appears in the online store. This name ensures consistency with the localized brand presentation.
storedetaileddescriptionStringFalseNoThe translated detailed description of the assembly item in the online store. This description provides in-depth information about the product’s specifications, usage, and benefits.

Return to Top

assemblyunbuild 

NameTypeReadOnlyReferencesFilterOnlyDescription
billofmaterialsStringFalseNoThe bill of materials (BOM) that is associated with the unbuild transaction. This BOM identifies the components and structure of the assembly item that is being dismantled.
billofmaterialsrevisionStringFalseNoThe specific revision of the BOM that is used for the unbuild process. This information ensures that the correct version of the component structure is referenced.
builtDoubleFalseNoThe quantity of the assembly item that was originally built and is now being unbuilt or disassembled.
classStringFalseNoThe classification that is associated with the unbuild transaction. This classification is often used for reporting, categorization, or internal tracking purposes.
createddateDatetimeFalseNoThe date and time when the unbuild transaction was created in the system. This timestamp is used for tracking and auditing purposes.
customformStringFalseNoThe custom form that is used to record and display the unbuild transaction. This form allows for customized data entry and presentation.
departmentStringFalseNoThe department that is responsible for the unbuild transaction. This field is used for financial tracking, cost allocation, and internal reporting.
externalidStringFalseNoThe system-generated identifier (Id) that is used to reference the unbuild transaction in external integrations or data exchanges.
inventorydetailStringFalseNoThe specific inventory details that are related to the unbuild transaction (for example, lot numbers, serial numbers, or bin locations).
itemStringFalseNoThe assembly item that is being unbuilt. This item represents a finished good or bundled product that is being broken down into its component parts.
lastmodifieddateDatetimeFalseNoThe date and time when the unbuild transaction was last modified. This timestamp helps track changes and updates to the record.
locationStringFalseNoThe physical or virtual location where the unbuild transaction takes place. This location is used for inventory tracking and warehouse management.
memoStringFalseNoA note or reference that is entered for the unbuild transaction. This information provides additional details or context for internal users.
postingperiodStringFalseNoThe accounting period in which the unbuild transaction is recorded. This field ensures accurate financial reporting and period-based analysis.
quantityStringFalseNoThe number of units of the assembly item that is being unbuilt in this transaction.
revisionStringFalseNoThe specific revision of the assembly item that is being unbuilt. This revision ensures that the correct version of the product is processed.
revisionmemoStringFalseNoA note or description that is associated with the revision of the assembly item. This description provides context for changes or updates in the unbuild process.
subsidiaryStringFalseNoThe subsidiary that is associated with the unbuild transaction. This field determines which business entity or division is responsible for the process.
totalDecimalFalseNoThe total cost or value that is associated with the unbuild transaction. This value reflects the financial impact of breaking down the assembly item.
trandateDateFalseNoThe transaction date of the unbuild process. This date indicates when the assembly item was disassembled for inventory and financial tracking.
tranidStringFalseNoThe unique Id that is assigned to the unbuild transaction within the system. This Id is used for record-keeping and referencing.
unitsStringFalseNoThe unit of measure (UOM) that is associated with the quantity being unbuilt. The UOM ensures consistency in inventory and reporting calculations.

Return to Top

ATPMethodType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoThe internal identifier (Id) for the Available-to-Promise (ATP) method type. This Id is used within the system to reference specific ATP calculation methodologies for inventory planning and order fulfillment.

Return to Top

Attendee 

NameTypeReadOnlyReferencesFilterOnlyDescription
attendee [KEY]IntegerFalseNoThe unique identifier (Id) for the attendee, representing an individual, employee, customer, or external participant that is registered for the scheduled event. This Id ensures proper tracking of event participants within the system.
calendarevent [KEY]IntegerFalseNoThe unique Id for the calendar event to which the attendee is associated. This Id links the attendee to a specific meeting, appointment, seminar, or gathering, enabling scheduling and participation tracking.
attendanceStringFalseNoIndicates the attendance status of the attendee at the event, such as 'Present', 'Absent', or 'Tentative'. This status helps in monitoring engagement, compliance with attendance policies, and post-event analysis.
responseStringFalseNoThe attendee’s response to the event invitation, such as 'Accepted', 'Declined', or 'No Response'. This information is used to assess participant interest, plan event logistics, and manage seating or resource allocations.

Return to Top

audienceDepartmentMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the department mapping, representing a specific group, demographic, or target segment linked to a department for communication, marketing, or operational purposes. This mapping helps define departmental reach and engagement strategies.

Return to Top

audienceDepartmentMapClient 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the department mapping for client-related interactions. This field represents a specific group, customer segment, or target demographic that is linked to a department for tailored communication, marketing campaigns, or service delivery. This mapping helps define how departments engage with different client groups.

Return to Top

audienceDepartmentMapMassUpdate 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the department mapping for mass updates. This field represents a specific group, customer segment, or target demographic that is linked to a department for bulk modifications such as updating department assignments, communication strategies, or access permissions across multiple records simultaneously.

Return to Top

audienceDepartmentMapPortlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with the audienceDepartmentMapPortlet_in process in NetSuite. This field identifies the target audience that is linked to this portlet, ensuring that the correct visibility settings, data filtering, and user access permissions are applied. This mapping supports role-based access, personalized dashboard experiences, and optimized departmental insights.

Return to Top

audienceDepartmentMapRestlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the department mapping for portlet display. This field represents a specific group, customer segment, or target demographic this is linked to a department for personalized dashboard widgets or data visualization in a user interface. This field allows for targeted insights and streamlined access to relevant information.

Return to Top

audienceDepartmentMapSuitelet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the department mapping for Suitelet-based interactions. This field represents a specific group, customer segment, or target demographic that is linked to a department for customized Suitelet applications. This field enables tailored user experiences, interactive dashboards, or automated data processing within the system.

Return to Top

audienceDepartmentMapUserEvent 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that ia associated with the department mapping for user-event scripts. This field represents a specific group, customer segment, or target demographic that is linked to a department. This field enables automated actions that are triggered by user interactions such as record updates, form submissions, or workflow executions within the system.

Return to Top

audienceDepartmentMapWorkflow 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the department mapping for workflow automation. This field represents a specific group, customer segment, or target demographic that is linked to a department. This field enables rule-based automation of business processes, approvals, notifications, and task assignments within the system.

Return to Top

audienceEmployeeMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the employee mapping. This field represents a specific group, role, or target segment that linked to employees for access control, communication, or organizational structuring. This mapping helps define employee group assignments for system permissions, notifications, or reporting purposes.

Return to Top

audienceEmployeeMapClient 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the employee mapping for client-related interactions. This field represents a specific group, role, or target segment that is linked to employees for managing client communications, service assignments, or role-based access to client-related data. This mapping ensures proper alignment between employees and the client segments they interact with.

Return to Top

audienceEmployeeMapMassUpdate 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the employee mapping for mass updates. This field represents a specific group, role, or target segment linked to employees, which enables bulk modifications of employee assignments, access levels, or communication preferences across multiple records simultaneously. This mapping streamlines large-scale organizational changes and data management.

Return to Top

audienceEmployeeMapPortlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the employee mapping for portlet display. This field represents a specific group, role, or target segment that is linked to employees for personalized dashboard widgets, real-time data insights, or role-based content display within the system interface. This mapping helps tailor information visibility for different employee groups.

Return to Top

audienceEmployeeMapRestlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the employee mapping for RESTlet-based interactions. This field represents a specific group, role, or target segment that is linked to employees for API-driven data exchanges, system integrations, or automated processing of employee-related assignments. This mapping enables efficient communication between external applications and the system.

Return to Top

audienceEmployeeMapSuitelet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the employee mapping for Suitelet-based interactions. This field represents a specific group, role, or target segment that is linked to employees for custom Suitelet applications. This mapping enables tailored user experiences, role-based dashboards, or automated processing of employee-related assignments within the system.

Return to Top

audienceEmployeeMapUserEvent 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the employee mapping for user event scripts. This field represents a specific group, role, or target segment that is linked to employees. This mapping enables automated actions triggered by user interactions, such as record updates, form submissions, or workflow executions within the system.

Return to Top

audienceEmployeeMapWorkflow 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the employee mapping for workflow automation. This field represents a specific group, role, or target segment linked to employees. This mapping enables rule-based automation of business processes, approvals, notifications, and task assignments within the system.

Return to Top

audienceGroupMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the group mapping. This field represents a specific set of users, roles, or target segments that is linked to a group for access control, communication, or organizational structuring. This mapping helps define group assignments for system permissions, notifications, or reporting purposes.

Return to Top

audienceGroupMapClient 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the group mapping for client-related interactions. This field represents a specific set of users, roles, or customer segments that is linked to a group for managing client communications, service assignments, or role-based access to client-related data. This mapping ensures structured client engagement and streamlined group-based operations.

Return to Top

audienceGroupMapMassUpdate 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the group mapping for mass updates. This field represents a specific set of users, roles, or target segments that is linked to a group, enabling bulk modifications of group assignments, access levels, or communication preferences across multiple records simultaneously. This mapping streamlines large-scale organizational changes and data management.

Return to Top

audienceGroupMapPortlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the group mapping for portlet display. This field represents a specific set of users, roles, or target segments that is linked to a group for personalized dashboard widgets, real-time data insights, or role-based content display within the system interface. This mapping helps tailor information visibility for different user groups.

Return to Top

audienceGroupMapRestlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the group mapping for portlet display. This field represents a specific set of users, roles, or target segments that is linked to a group for personalized dashboard widgets, real-time data insights, or role-based content display within the system interface. This mapping helps tailor information visibility for different user groups.

Return to Top

audienceGroupMapSuitelet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the group mapping for Suitelet-based interactions. This field represents a specific set of users, roles, or target segments that is linked to a group for custom Suitelet applications. This mapping enables tailored user experiences, role-based dashboards, or automated processing of group-related assignments within the system.

Return to Top

audienceGroupMapUserEvent 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience associated with the group mapping for user event scripts. This field represents a specific set of users, roles, or target segments that is linked to a group. This mapping enables automated actions triggered by user interactions, such as record updates, form submissions, or workflow executions within the system.

Return to Top

audienceGroupMapWorkflow 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the group mapping for workflow automation. This field represents a specific set of users, roles, or target segments this is linked to a group. This mapping enables rule-based automation of business processes, approvals, notifications, and task assignments within the system.

Return to Top

audiencePartnerMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the partner mapping. This field represents a specific set of partners, business affiliates, or external collaborators that is linked to an audience for targeted communication, role-based access, or partnership management. This mapping ensures structured engagement and streamlined partner-related processes within the system.

Return to Top

audiencePartnerMapClient 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with the audiencePartnerMapClient_in process in NetSuite. This field identifies the target audience that is linked to this client script, ensuring that the correct visibility settings, data filtering, and user access permissions are applied. This mapping supports role-based access, partner-specific configurations, and optimized client-side interactions.

Return to Top

audiencePartnerMapMassUpdate 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the partner mapping for mass updates. This field represents a specific set of partners, business affiliates, or external collaborators linked to an audience, enabling bulk modifications of partner assignments, access levels, or communication preferences across multiple records simultaneously. This mapping streamlines large-scale partner management and data updates.

Return to Top

audiencePartnerMapPortlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the partner mapping for portlet display. This field represents a specific set of partners, business affiliates, or external collaborators that is linked to an audience for personalized dashboard widgets, real-time data insights, or role-based content display within the system interface. This mapping helps tailor information visibility for different partner groups.

Return to Top

audiencePartnerMapRestlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe audience that is associated with the partner mapping for RESTlet-based interactions. This field represents a specific set of partners, business affiliates, or external collaborators linked to an audience for API-driven data exchanges, system integrations, or automated processing of partner-related assignments. This mapping enables efficient communication between external applications and the system.

Return to Top

audiencePartnerMapSuitelet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of target users, businesses, or segments that is relevant to a partner mapping process in NetSuite. This field defines which audience groups are associated with specific partners, ensuring proper segmentation for marketing campaigns, business relationships, or custom integrations. This mapping is used in reporting and analytics to track partner engagement with different audience segments.

Return to Top

audiencePartnerMapUserEvent 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with a partner mapping process in NetSuite. This field identifies the target audience that is linked to specific user-driven events, such as interactions, transactions, or system-triggered actions. This mapping is used to segment and analyze audience engagement, ensuring accurate reporting, personalized marketing efforts, and optimized partner strategies.

Return to Top

audiencePartnerMapWorkflow 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with a partner mapping process in NetSuite. This field identifies the target audience that is linked to workflow-driven actions, including automated processes, scheduled tasks, or custom workflows. This mapping is used to segment and analyze audience engagement for enhanced reporting, workflow automation, and targeted partner strategies.

Return to Top

audienceRoleMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with a role mapping process in NetSuite. This field identifies the target audience that is linked to specific system roles, ensuring that access permissions, workflow actions, or role-based configurations are applied appropriately. This mapping supports role-based segmentation for reporting, security management, and operational efficiency within NetSuite.

Return to Top

audienceRoleMapClient 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with a role mapping process in NetSuite. This field identifies the target audience that is linked to client-specific role assignments, ensuring that access permissions, security configurations, or role-based workflows are tailored to client needs. This mapping supports segmentation for client management, security enforcement, and personalized system interactions.

Return to Top

audienceRoleMapMassUpdate 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with a role mapping process in NetSuite. This field identifies the target audience that is impacted by mass role updates, ensuring that role-based permissions, workflow configurations, or access settings are efficiently updated across multiple records. This mapping supports bulk modifications for security management, compliance enforcement, and operational efficiency within NetSuite.

Return to Top

audienceRoleMapPortlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with a role mapping process in NetSuite. This field identifies the target audience that is linked to specific portlet configurations, ensuring that dashboard content, role-based views, or personalized system widgets are displayed appropriately. This mapping supports user experience customization, security enforcement, and role-based segmentation for improved system navigation and reporting.

Return to Top

audienceRoleMapRestlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with a role mapping process in NetSuite. This field identifies the target audience that is linked to RESTlet-based integrations, ensuring that role-based permissions and access controls are correctly applied to API interactions. This mapping supports secure data exchange, controlled system access, and integration governance for external applications communicating with NetSuite.

Return to Top

audienceRoleMapSuitelet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with a role mapping process in NetSuite. This field identifies the target audience linked to Suitelet-based custom applications, ensuring that role-based permissions, access restrictions, and workflow configurations are correctly applied. This mapping supports controlled user interactions, secure data processing, and customized Suitelet functionality tailored to specific roles.

Return to Top

audienceRoleMapUserEvent 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with a role mapping process in NetSuite. This field identifies the target audience that is linked to user event scripts, ensuring that role-based permissions and workflow automation are correctly applied during system-triggered events, such as record creation, updates, or deletions. This mapping supports security enforcement, controlled automation, and event-driven role segmentation.

Return to Top

audienceRoleMapWorkflow 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with a role mapping process in NetSuite. This field identifies the target audience linked to workflow-driven automation, ensuring that role-based permissions, approval processes, and system-triggered actions are correctly applied. This mapping supports workflow customization, security enforcement, and process optimization by ensuring that automated tasks are executed within the appropriate role-based access framework.

Return to Top

audienceSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with a subsidiary mapping process in NetSuite. This field identifies the target audience that is linked to specific subsidiaries, ensuring that access permissions, financial reporting structures, and operational controls are correctly applied. This mapping supports subsidiary-based segmentation, regulatory compliance, and optimized business management by ensuring that users and entities are assigned to the appropriate organizational units.

Return to Top

audienceSubsidiaryMapClient 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with a subsidiary mapping process in NetSuite. This field identifies the target audience that is linked to client-specific subsidiaries, ensuring that access permissions, financial reporting structures, and operational controls are correctly applied. This mapping supports client-based subsidiary segmentation, regulatory compliance, and optimized business management by ensuring that users and entities are assigned to the appropriate organizational units.

Return to Top

audienceSubsidiaryMapMassUpdate 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with a subsidiary mapping process in NetSuite. This field identifies the target audience that is linked to mass updates for subsidiary assignments, ensuring that access permissions, financial reporting structures, and operational controls are efficiently applied across multiple records. This mapping supports bulk subsidiary updates, regulatory compliance, and streamlined business management by ensuring that users and entities are assigned to the appropriate organizational units at scale.

Return to Top

audienceSubsidiaryMapPortlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with a subsidiary mapping process in NetSuite. This field identifies the target audience that is linked to custom portlet configurations for subsidiaries, ensuring that dashboard content, role-based views, and subsidiary-specific widgets are displayed appropriately. This mapping supports personalized user experiences, security enforcement, and optimized system navigation by ensuring that relevant subsidiary data is accessible within portlets.

Return to Top

audienceSubsidiaryMapRestlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with a subsidiary mapping process in NetSuite. This field identifies the target audience that is linked to RESTlet-based integrations for subsidiaries, ensuring that role-based permissions, data access, and API interactions are correctly applied. This mapping supports secure data exchange, controlled system access, and integration governance by ensuring that subsidiary-related information is processed and managed through RESTlet services.

Return to Top

audienceSubsidiaryMapSuitelet 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with the audienceSubsidiaryMapSuitelet_in process in NetSuite. This field identifies the target audience that is linked to this suitelet, ensuring that the correct visibility settings, data filtering, and user access permissions are applied. This mapping supports role-based access, subsidiary-specific reporting, and optimized workflow customization.

Return to Top

audienceSubsidiaryMapUserEvent 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with a subsidiary mapping process in NetSuite. This field identifies the target audience that is linked to user event scripts for subsidiaries, ensuring that role-based permissions, automated triggers, and data processing rules are correctly applied. This mapping supports event-driven subsidiary management, security enforcement, and workflow automation by ensuring that system-triggered actions operate within the appropriate subsidiary framework.

Return to Top

audienceSubsidiaryMapWorkflow 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe classification of users, businesses, or entities that is associated with a subsidiary mapping process in NetSuite. This field identifies the target audience that is linked to workflow-driven automation for subsidiaries, ensuring that role-based permissions, approval processes, and system-triggered actions are correctly applied. This mapping supports workflow customization, security enforcement, and process optimization by ensuring that automated tasks operate within the appropriate subsidiary framework.

Return to Top

AuthenticateDeviceInput 

NameTypeReadOnlyReferencesFilterOnlyDescription
cardholderauthenticationStringFalseNoThe authentication details that are associated with the cardholder in NetSuite. This field captures authentication data that is used to verify the identity of the cardholder during device-based transactions, ensuring compliance with security protocols and fraud prevention measures.
nameStringFalseNoThe name of the individual or entity that is associated with the authentication process in NetSuite. This field identifies the cardholder or authorized user, ensuring accurate identity verification and recordkeeping for secure transactions.

Return to Top

AuthenticateDeviceResult 

NameTypeReadOnlyReferencesFilterOnlyDescription
cardholderauthenticationStringFalseNoThe authentication details that are associated with the cardholder in NetSuite. This field captures authentication results that are used to verify the identity of the cardholder during device-based transactions, ensuring compliance with security protocols and fraud prevention measures.
nameStringFalseNoThe name of the individual or entity that is associated with the authentication result in NetSuite. This field identifies the cardholder or authorized user, ensuring accurate identity verification and recordkeeping for secure transactions.

Return to Top

AuthenticationField 

NameTypeReadOnlyReferencesFilterOnlyDescription
cardholderauthenticationStringFalseNoThe authentication details that are associated with the cardholder in NetSuite. This field captures authentication data that is used to verify the identity of the cardholder during transactions, ensuring compliance with security protocols and fraud prevention measures.
nameStringFalseNoThe name of the individual or entity that is associated with the authentication process in NetSuite. This field identifies the cardholder or authorized user, ensuring accurate identity verification and recordkeeping for secure transactions.

Return to Top

automatedclearinghouse 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountownernameStringFalseNoThe name of the individual or entity that owns the bank account that is associated with the Automated Clearing House (ACH) process in NetSuite. This field ensures proper identification of the account holder for transaction processing and compliance purposes.
accounttypeStringFalseNoThe classification of the bank account that is used in the ACH process in NetSuite. This field specifies whether the account is a checking, savings, or other type of financial account, ensuring appropriate handling of transactions.
bankaccountnumberStringFalseNoThe bank account number that is associated with the ACH process in NetSuite. This field stores the account details necessary for electronic fund transfers while adhering to security and compliance regulations.
banknameStringFalseNoThe name of the financial institution that is associated with the ACH process in NetSuite. This field identifies the bank facilitating the electronic transactions to ensure accurate processing and reconciliation.
customerconsentStringFalseNoThe recorded authorization that is provided by the customer for ACH transactions in NetSuite. This field ensures compliance with financial regulations and confirms that electronic payments can be processed.
entityStringFalseNoThe classification of the customer, vendor, or other business entity that is associated with the ACH process in NetSuite. This field ensures proper linkage of payment records to the relevant entity for transaction tracking and financial reporting.
externalidStringFalseNoThe unique identifier (Id) that is assigned to the ACH record from an external system in NetSuite. This field supports integration with third-party financial platforms, ensuring seamless data synchronization and consistency.
idIntegerFalseNoThe system-generated Id that is assigned to the ACH record in NetSuite. This field ensures uniqueness and traceability of ACH transactions for auditing and financial tracking.
instrumenttypeStringFalseNoThe classification of the financial instrument that is used in the ACH process in NetSuite. This field defines whether the payment method is a direct debit, credit transfer, or other form of electronic payment.
isdefaultBooleanFalseNoIndicates whether this ACH account is the primary payment method for the associated entity in NetSuite. This field ensures that default settings are correctly applied for seamless transaction processing.
isinactiveBooleanFalseNoIndicates whether this ACH account is inactive in NetSuite. This field ensures that deactivated accounts are not used for processing transactions, maintaining data integrity and security.
limitStringFalseNoThe maximum transaction amount that is allowed for ACH payments associated with this record in NetSuite. This field enforces financial controls and regulatory compliance for payment processing.
maskStringFalseNoA masked representation of the bank account number that is associated with the ACH process in NetSuite. This field enhances security by displaying only partial account details to protect sensitive financial information.
memoStringFalseNoA descriptive note that is associated with the ACH transaction in NetSuite. This field provides additional context for payments, assisting in recordkeeping and financial reconciliation.
paymentmethodStringFalseNoThe payment method that is associated with the ACH transaction in NetSuite. This field specifies whether the transaction is processed via ACH debit, credit, or another electronic payment format.
preserveonfileBooleanFalseNoIndicates whether this ACH payment record should be retained for future transactions in NetSuite. This field ensures continuity in payment processing while adhering to data retention policies.
routingnumberStringFalseNoThe routing number of the financial institution that is associated with the ACH process in NetSuite. This field ensures that transactions are correctly routed through the banking system for processing.
stateStringFalseNoThe current status of the ACH record in NetSuite. This field tracks whether the payment method is active, pending, or deactivated for transaction processing.
supportedoperationsStringFalseNoThe list of permitted operations for this ACH payment method in NetSuite. This field specifies whether the account supports debit, credit, refund, or other transaction types, ensuring proper payment handling.

Return to Top

balancetrxbysegments 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with the transaction, used for financial reporting and compliance.
balancingsegmentsStringFalseNoSegments used to ensure transactions remain balanced across multiple entities or departments.
createdbyStringFalseNoThe user or system that created the transaction record.
datetimecreatedDatetimeFalseNoThe date and time when the transaction record was created.
externalidStringFalseNoA unique identifier for the transaction used for integration with external systems.
includechildrenBooleanFalseNoIndicates whether child subsidiaries or related records are included in the report.
internalidIntegerFalseNoThe internal NetSuite system identifier for the transaction record.
memoStringFalseNoA free-text field for adding notes or explanations related to the transaction.
percentagecompleteStringFalseNoThe percentage of completion for projects or work related to this transaction.
postingperiodStringFalseNoThe financial period in which the transaction is posted, affecting reporting and accounting.
statusStringFalseNoThe current status of the transaction, such as Pending, Approved, or Completed.
subsidiaryStringFalseNoThe specific subsidiary to which this transaction is associated, relevant for multi-entity organizations.

Return to Top

billingaccount 

NameTypeReadOnlyReferencesFilterOnlyDescription
billingscheduleStringFalseNoThe predefined billing schedule used for invoicing customers at specific intervals.
cashsaleformStringFalseNoThe default form template used when processing cash sales transactions.
classStringFalseNoThe classification category used for tracking and reporting transactions, such as department or business unit.
createdbyStringFalseNoThe user or system that created this record.
createddateDatetimeFalseNoThe date and time when the record was created.
currencyStringFalseNoThe currency used for this transaction or record, based on the company's financial settings.
customerStringFalseNoThe customer associated with this transaction or billing schedule.
customerdefaultBooleanFalseNoIndicates whether this billing schedule is the default for the associated customer.
customformStringFalseNoThe custom form template applied to this record for specific business needs.
departmentStringFalseNoThe department associated with this record, used for financial reporting and categorization.
externalidStringFalseNoA unique identifier used for integration with external systems or data imports.
frequencyStringFalseNoThe interval at which billing occurs, such as Monthly, Quarterly, or Annually.
idnumberStringFalseNoThe internal identification number assigned to this record.
idnumberexternalStringFalseNoAn external identification number used for integration or reference purposes.
inactiveBooleanFalseNoIndicates whether this record is inactive and no longer in use.
invoiceformStringFalseNoThe default form template used for generating invoices.
lastbillcycledateDateFalseNoThe date of the most recent billing cycle for this schedule.
lastbilldateDateFalseNoThe last date an invoice or billing transaction was generated.
memoStringFalseNoA free-text field for adding notes or comments related to this record.
nameStringFalseNoThe name assigned to this billing schedule or related entity.
nextbillcycledateDateFalseNoThe scheduled date for the next billing cycle.
startdateDateFalseNoThe start date for this billing schedule or related record.
subsidiaryStringFalseNoThe subsidiary associated with this transaction, relevant for multi-entity organizations.

Return to Top

billingclass 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoA brief summary or details about the item, service, or record.
externalidStringFalseNoA unique identifier used for integration with external systems or data imports.
isinactiveBooleanFalseNoIndicates whether this record is inactive and no longer available for use.
nameStringFalseNoThe name assigned to this item, service, or record for identification purposes.
priceStringFalseNoThe assigned price or cost associated with this item or service.

Return to Top

billingClassPriceCost 

NameTypeReadOnlyReferencesFilterOnlyDescription
billingclassStringFalseNoThe billing classification used to categorize transactions for invoicing and reporting purposes.
currencynameStringFalseNoThe name of the currency associated with this record, used for financial transactions and reporting.

Return to Top

BillingMilestone 

NameTypeReadOnlyReferencesFilterOnlyDescription
idIntegerFalseNoThe unique internal identifier assigned to this record within the system.

Return to Top

billingratecard 

NameTypeReadOnlyReferencesFilterOnlyDescription
externalidStringFalseNoA unique identifier used for integration with external systems or data imports.
isinactiveBooleanFalseNoIndicates whether this record is inactive and no longer available for use.
nameStringFalseNoThe name assigned to this record for identification and reference purposes.

Return to Top

BillingRateCardPriceMultiForSearch 

NameTypeReadOnlyReferencesFilterOnlyDescription
billingclassStringFalseNoThe classification used to categorize billing transactions for pricing and invoicing purposes.
billingratecardStringFalseNoThe predefined rate card that determines pricing for services or items.
currencyStringFalseNoThe currency in which the billing rates are defined and applied.
priceDecimalFalseNoThe assigned price or rate for the service or item based on the billing rate card.
saleunitStringFalseNoThe unit of measure used for sales, such as hours, units, or subscriptions.
versionStringFalseNoThe version of the billing rate card, used to track changes and updates over time.

Return to Top

BillingRateCardVersion 

NameTypeReadOnlyReferencesFilterOnlyDescription
billingratecardStringFalseNoThe predefined rate card that sets pricing for services or items based on billing rules.
effectivedateDateFalseNoThe date when this billing rate card becomes active and applicable.
enddateDateFalseNoThe date when this billing rate card is no longer valid or in use.

Return to Top

billingrevenueevent 

NameTypeReadOnlyReferencesFilterOnlyDescription
amountDecimalFalseNoThe monetary amount associated with this transaction or event.
cumulativepercentcompleteStringFalseNoThe total percentage of completion for a project or task up to this point.
customformStringFalseNoThe custom form template applied to this record for specific business needs.
eventdateDateFalseNoThe date when the event or transaction occurred.
eventpurposeStringFalseNoThe reason or purpose behind the event or transaction.
eventtypeStringFalseNoThe classification of the event, such as billing, adjustment, or milestone.
externalidStringFalseNoA unique identifier used for integration with external systems or data imports.
quantityDoubleFalseNoThe numerical quantity of items or units involved in this transaction.
recordStringFalseNoThe specific record associated with this event or transaction.
recordtypeStringFalseNoThe type of record, such as an invoice, sales order, or journal entry.
transactionlineStringFalseNoThe line item within a transaction, specifying details such as item, service, or charge.

Return to Top

billingschedule 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier assigned to this record within the system.
applytosubtotalBooleanFalseNoIndicates whether this charge or adjustment is applied to the subtotal before taxes and discounts.
billforactualsBooleanFalseNoSpecifies if invoices should include only actual time worked rather than estimated time.
externalidStringFalseNoA unique identifier used for integration with external systems or data imports.
frequencyStringFalseNoThe recurrence interval for billing, such as Monthly, Quarterly, or Annually.
inarrearsBooleanFalseNoIndicates whether payments are collected after services are rendered instead of in advance.
initialtermsStringFalseNoThe payment terms for the first billing cycle, such as Net 30 or Due on Receipt.
isinactiveBooleanFalseNoIndicates whether this record is inactive and no longer available for use.
ispublicBooleanFalseNoSpecifies whether this record is publicly accessible within the system.
jobStringFalseNoThe project or job associated with this billing schedule or transaction.
nameStringFalseNoThe name assigned to this billing schedule, project, or record.
numberremainingIntegerFalseNoThe remaining number of billing cycles before the recurrence ends.
recurrencepatternStringFalseNoThe pattern defining how often and when the billing recurs, such as 'Every 1 Month on the 15th'.
recurrencetermsStringFalseNoThe payment terms applied to recurring invoices or transactions.
repeateveryStringFalseNoThe interval at which the transaction repeats, such as '2 Weeks' or '3 Months'.
transactionStringFalseNoThe related financial transaction, such as an invoice, sales order, or charge.

Return to Top

billingScheduleMilestone 

NameTypeReadOnlyReferencesFilterOnlyDescription
billingscheduleStringFalseNoThe predefined billing schedule that dictates when and how invoices are generated.
commentsStringFalseNoAdditional notes or remarks related to the billing schedule or milestone.
milestoneactualcompletiondateDateFalseNoThe date when the milestone was actually completed.
milestoneamountDoubleFalseNoThe monetary value associated with this milestone payment or billing event.
milestonecompletedBooleanFalseNoIndicates whether the milestone has been completed.
milestonedateDateFalseNoThe expected or estimated completion date for the milestone.
milestonetermsStringFalseNoThe payment terms that apply to this milestone, such as Net 30 or Due on Receipt.

Return to Top

billingScheduleRecurrence 

NameTypeReadOnlyReferencesFilterOnlyDescription
billingscheduleStringFalseNoThe predefined billing schedule that determines when and how invoices are generated.
countIntegerFalseNoThe total number of occurrences or billing cycles.
paymenttermsStringFalseNoThe payment terms associated with the billing schedule, such as Net 30 or Due on Receipt.
recurrencedateDateFalseNoThe specific date when the billing recurrence occurs.
recurrenceidIntegerFalseNoThe unique identifier assigned to a billing recurrence instance.
relativetopreviousBooleanFalseNoIndicates whether this recurrence is scheduled relative to the previous occurrence rather than a fixed date.

Return to Top

billingScheduleRecurrencePattern 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoThe unique identifier assigned to this record within the system.

Return to Top

BillingScheduleType 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoA unique identifier assigned to this record for tracking and reference.

Return to Top

billOfDistribution 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier assigned to this record within the system.
distributioncategoryStringFalseNoThe category used to classify distribution activities for reporting and management.
distributionnetworkStringFalseNoThe network or channel through which goods or services are distributed.
isinactiveBooleanFalseNoIndicates whether this record is inactive and no longer available for use.
locationStringFalseNoThe physical or logical location associated with this distribution record.

Return to Top

billOfDistributionDistributionSource 

NameTypeReadOnlyReferencesFilterOnlyDescription
billofdistributionStringFalseNoThe predefined distribution plan that outlines how goods are transferred between locations.
effectivedateDateFalseNoThe date when this distribution plan or rule becomes active and applicable.
leadtimeIntegerFalseNoThe estimated number of days required for goods to be delivered from the source location to the destination.
safetytimeIntegerFalseNoThe additional buffer time, in days, added to account for potential delays in distribution.
sourcelocationStringFalseNoThe originating location from which goods are distributed.
sourcesubsidiaryStringFalseNoThe subsidiary responsible for supplying goods in this distribution plan.

Return to Top

BillVarianceStatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoThe unique internal identifier assigned to this record within the system.

Return to Top

bin 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier assigned to this bin record within the system.
binnumberStringFalseNoThe designated number or code assigned to a storage bin within a warehouse or location.
externalidStringFalseNoA unique identifier used for integration with external systems or data imports.
isinactiveBooleanFalseNoIndicates whether this bin record is inactive and no longer in use.
locationStringFalseNoThe warehouse or storage location where this bin is assigned.
memoStringFalseNoA free-text field for adding notes or comments related to this bin.

Return to Top

bintransfer 

NameTypeReadOnlyReferencesFilterOnlyDescription
createddateDatetimeFalseNoThe date and time when this record was created in the system.
externalidStringFalseNoA unique identifier used for integration with external systems or data imports.
lastmodifieddateDatetimeFalseNoThe date and time when this record was last modified.
locationStringFalseNoThe physical or logical location associated with this transaction or record.
memoStringFalseNoA free-text field for adding notes or comments related to this transaction.
subsidiaryStringFalseNoThe subsidiary associated with this transaction, relevant for multi-entity organizations.
totalDecimalFalseNoThe total monetary amount for this transaction.
trandateDateFalseNoThe date on which this transaction occurred or was recorded.

Return to Top

binworksheet 

NameTypeReadOnlyReferencesFilterOnlyDescription
createddateDatetimeFalseNoThe date and time when this record was created in the system.
externalidStringFalseNoA unique identifier used for integration with external systems or data imports.
lastmodifieddateDatetimeFalseNoThe date and time when this record was last modified.
locationStringFalseNoThe physical or logical location associated with this transaction or record.
memoStringFalseNoA free-text field for adding notes or comments related to this transaction.
subsidiaryStringFalseNoThe subsidiary associated with this transaction, relevant for multi-entity organizations.
trandateDateFalseNoThe date on which this transaction occurred or was recorded.

Return to Top

blanketpurchaseorder 

NameTypeReadOnlyReferencesFilterOnlyDescription
billedamountDecimalFalseNoThe total monetary amount that has been billed for this transaction.
billinginstructionsStringFalseNoSpecial instructions or notes related to the billing process.
carrierStringFalseNoThe shipping carrier responsible for delivering the goods or services.
classStringFalseNoThe classification category used for tracking and reporting transactions, such as department or business unit.
createddateDatetimeFalseNoThe date and time when this record was created in the system.
createdfromStringFalseNoThe original record from which this transaction was generated, such as a sales order or purchase order.
currencyStringFalseNoThe currency in which the transaction is recorded.
currencynameStringFalseNoThe name of the currency used in this transaction.
currencysymbolStringFalseNoThe symbol of the currency used in this transaction, such as $ or €.
customformStringFalseNoThe custom form template applied to this record for specific business needs.
departmentStringFalseNoThe department associated with this transaction, used for financial reporting and categorization.
effectivitybasedonStringFalseNoSpecifies whether the transaction's effectivity is based on date, approval status, or other criteria.
employeeStringFalseNoThe employee associated with this transaction, if applicable.
enddateDateFalseNoThe date when the transaction, contract, or agreement ends.
entityStringFalseNoThe customer, vendor, or other entity associated with this transaction.
entitynexusStringFalseNoThe tax nexus applicable to the entity in this transaction.
exchangerateDecimalFalseNoThe exchange rate used to convert foreign currency amounts into the base currency.
externalidStringFalseNoA unique identifier used for integration with external systems or data imports.
incotermStringFalseNoThe international commercial term (Incoterm) that defines the delivery terms and responsibilities.
isbasecurrencyBooleanFalseNoIndicates whether this currency is the base currency for the subsidiary or company.
lastmodifieddateDatetimeFalseNoThe date and time when this record was last modified.
locationStringFalseNoThe physical or logical location associated with this transaction or record.
maximumamountStringFalseNoThe maximum allowable amount for this transaction or contract.
memoStringFalseNoA free-text field for adding notes or comments related to this transaction.
nexusStringFalseNoThe tax jurisdiction or nexus associated with this transaction.
oldrevenuecommitmentStringFalseNoThe previous revenue commitment associated with this transaction, if applicable.
orderstatusStringFalseNoThe current status of the order, such as Pending, Approved, or Shipped.
otherrefnumStringFalseNoAn additional reference number used for tracking this transaction.
packinglistinstructionsStringFalseNoSpecial instructions related to the packing list for this transaction.
productlabelinginstructionsStringFalseNoGuidelines or requirements for labeling the products in this transaction.
purchasedamountDecimalFalseNoThe total amount spent on purchases related to this transaction.
purchaseorderinstructionsStringFalseNoSpecial instructions or notes related to the purchase order.
receivedamountDecimalFalseNoThe total amount received for this transaction, such as payments or goods.
sourceStringFalseNoThe origin of this transaction, such as an online order, import, or manual entry.
startdateDateFalseNoThe date when the transaction, contract, or agreement begins.
statusStringFalseNoThe current status of this transaction, such as Open, Closed, or In Progress.
statusRefStringFalseNoA system reference for the status of this transaction.
subsidiaryStringFalseNoThe subsidiary associated with this transaction, relevant for multi-entity organizations.
termsStringFalseNoThe payment terms applied to this transaction, such as Net 30 or Due on Receipt.
trandateDateFalseNoThe date on which this transaction occurred or was recorded.
tranidStringFalseNoThe unique transaction ID assigned to this record.
updatecurrencyStringFalseNoIndicates whether the currency details for this transaction have been updated.

Return to Top

blanketPurchaseOrderExpenseMachine 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with this transaction, used for financial tracking and reporting.
blanketpurchaseorderStringFalseNoThe related blanket purchase order, if applicable, used for recurring purchases.
categoryStringFalseNoThe classification category assigned to this transaction or item.
classStringFalseNoThe classification category used for tracking and reporting transactions, such as department or business unit.
departmentStringFalseNoThe department associated with this transaction, used for financial reporting and categorization.
grossamtDecimalFalseNoThe total monetary amount before taxes, discounts, or deductions.
lineIntegerFalseNoThe line number within the transaction, representing an individual item or charge.
locationStringFalseNoThe physical or logical location associated with this transaction or record.
memoStringFalseNoA free-text field for adding notes or comments related to this transaction.
orderscheduleStringFalseNoThe scheduling details for the order, including frequency or delivery timeline.

Return to Top

bom 

NameTypeReadOnlyReferencesFilterOnlyDescription
availableforallassembliesBooleanFalseNoIndicates whether this component is available for use in all assembly items.
availableforalllocationsBooleanFalseNoIndicates whether this component is available for use in all locations.
createddateDateFalseNoThe date when this record was created in the system.
externalidStringFalseNoA unique identifier used for integration with external systems or data imports.
includechildrenBooleanFalseNoIndicates whether child records, such as sub-components, are included in this record's scope.
isinactiveBooleanFalseNoIndicates whether this record is inactive and no longer in use.
memoStringFalseNoA free-text field for adding notes or comments related to this record.
nameStringFalseNoThe name assigned to this component, assembly, or record for identification purposes.
restricttoassembliesStringFalseNoSpecifies which assembly items this component is restricted to.
restricttolocationsStringFalseNoSpecifies the locations where this component can be used.
subsidiaryStringFalseNoThe subsidiaries associated with this component, relevant for multi-entity organizations.
usecomponentyieldBooleanFalseNoIndicates whether component yield is factored into assembly production calculations.
usedonassemblyBooleanFalseNoSpecifies whether this component is used in an assembly item.

Return to Top

bomAssembly 

NameTypeReadOnlyReferencesFilterOnlyDescription
assemblyStringFalseNoThe assembly item that this record is associated with, used in manufacturing or production processes.
billofmaterialsStringFalseNoThe BOM that defines the components and quantities required to build the assembly.
canbemasterBooleanFalseNoIndicates whether this BOM can be set as the master default for the assembly.

Return to Top

bomrevision 

NameTypeReadOnlyReferencesFilterOnlyDescription
billofmaterialStringFalseNoBOM that defines the components and quantities required for assembly or production.
createddateDateFalseNoThe date when this BOM record was created in the system.
effectivedateDateFalseNoThe start date when this BOM record becomes active and applicable.
externalidStringFalseNoA unique identifier used for integration with external systems or data imports.
isinactiveBooleanFalseNoIndicates whether this BOM record is inactive and no longer in use.
memoStringFalseNoA free-text field for adding notes or comments related to this BOM.
nameStringFalseNoThe name assigned to this BOM for identification purposes.
obsoletedateDateFalseNoThe end date when this BOM is no longer valid or used.

Return to Top

bomrevisioncomponent 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier assigned to this BOM component record.
quantityFloatFalseNoThe quantity of the component required for the assembly or production process.
itemIntegerFalseNoThe unique identifier of the item used as a component in the BOM.
bomrevisionIntegerFalseNoThe revision number of the BOM, used for version control and tracking changes.
componentyieldDoubleFalseNoThe expected yield percentage of the component, accounting for potential loss or wastage.
bomquantityFloatFalseNoThe total quantity of this component specified in the BOM.
unitsIntegerFalseNoThe unit of measure associated with this component, such as pieces, kilograms, or meters.
itemsourceStringFalseNoThe source of the item, such as purchased, manufactured, or subcontracted.
descriptionStringFalseNoA brief description of the item or component used in the BOM.

Return to Top

bonus 

NameTypeReadOnlyReferencesFilterOnlyDescription
bonusamountabsoluteStringFalseNoThe fixed bonus amount awarded to the employee.
bonusamountpercentageStringFalseNoThe percentage-based bonus calculated from a base salary or performance metric.
bonusawarddateDateFalseNoThe date when the bonus was awarded to the employee.
bonuscommentStringFalseNoAdditional notes or comments related to the awarded bonus.
bonusemployeeStringFalseNoThe employee receiving the bonus.
bonusstatusStringFalseNoThe current status of the bonus, such as Pending, Approved, or Paid.
bonustypeStringFalseNoThe category of the bonus, such as Performance-Based, Referral, or Retention.
externalidStringFalseNoA unique identifier used for integration with external systems or data imports.
idIntegerFalseNoThe unique identifier assigned to this bonus record within the system.
internalidIntegerFalseNoThe internal system identifier used for tracking this bonus record.

Return to Top

bonustype 

NameTypeReadOnlyReferencesFilterOnlyDescription
externalidStringFalseNoA unique identifier used for integration with external systems or data imports.
idIntegerFalseNoThe unique identifier assigned to this payroll-related record within the system.
internalidIntegerFalseNoThe internal system identifier used for tracking this record.
isinactiveBooleanFalseNoIndicates whether this record is inactive and no longer in use.
nameStringFalseNoThe name assigned to this payroll-related record for identification purposes.
payrollitemStringFalseNoThe specific payroll item associated with this record, such as salary, bonus, or deduction.
subsidiaryStringFalseNoThe subsidiary associated with this payroll record, relevant for multi-entity organizations.

Return to Top

budgetcategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique internal identifier assigned to this budget record within the system.
budgettypeBooleanFalseNoIndicates whether the budget applies globally across all subsidiaries and departments.
isinactiveBooleanFalseNoIndicates whether this budget record is inactive and no longer in use.

Return to Top

budgetexchangerate 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with this exchange rate, used for financial reporting.
averagerateDecimalFalseNoThe average exchange rate for the specified period.
currentrateDecimalFalseNoThe most recent exchange rate available for this currency conversion.
externalidStringFalseNoA unique identifier used for integration with external systems or data imports.
fromcurrencyStringFalseNoThe source currency being converted from.
fromsubsidiaryStringFalseNoThe subsidiary from which the transaction originates.
historicalrateDecimalFalseNoThe historical exchange rate used for financial reporting and analysis.
idIntegerFalseNoThe unique identifier assigned to this exchange rate record within the system.
internalidIntegerFalseNoThe internal system identifier used for tracking this exchange rate record.
isderivedBooleanFalseNoIndicates whether this exchange rate is derived from another calculation or manually entered.
iseliminationsubsidiaryBooleanFalseNoIndicates whether this subsidiary is used for intercompany eliminations.
isperiodclosedBooleanFalseNoIndicates whether the accounting period associated with this exchange rate is closed.
periodstartdateDateFalseNoThe start date of the financial period for this exchange rate.
postingperiodStringFalseNoThe financial period in which this exchange rate is applied for transactions.
tocurrencyStringFalseNoThe target currency being converted to.
tosubsidiaryStringFalseNoThe subsidiary that receives the converted currency value.

Return to Top

budgetimport 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique identifier assigned to this financial record.
accountIntegerFalseNoThe general ledger account associated with this record.
accountingBookIntegerFalseNoThe accounting book used for financial reporting and compliance.
amountDecimalFalseNoThe total monetary value associated with this record.
categoryStringFalseNoThe classification category for financial reporting, such as expense or revenue.
classIntegerFalseNoThe classification category used for tracking and reporting transactions, such as business unit or department.
currencyIntegerFalseNoThe currency used for this transaction or financial record.
customerIntegerFalseNoThe customer associated with this transaction or financial record.
departmentIntegerFalseNoThe department linked to this financial record for reporting and budget tracking.
itemIntegerFalseNoThe specific item or service linked to this financial record.
locationIntegerFalseNoThe physical or logical location associated with this financial transaction.
periodamount10DecimalFalseNoThe monetary amount recorded for financial period 10.
periodamount11DecimalFalseNoThe monetary amount recorded for financial period 11.
periodamount12DecimalFalseNoThe monetary amount recorded for financial period 12.
periodamount15DecimalFalseNoThe monetary amount recorded for financial period 15.
periodamount16DecimalFalseNoThe monetary amount recorded for financial period 16.
periodamount17DecimalFalseNoThe monetary amount recorded for financial period 17.
periodamount18DecimalFalseNoThe monetary amount recorded for financial period 18.
periodamount19DecimalFalseNoThe monetary amount recorded for financial period 19.
periodamount1DecimalFalseNoThe monetary amount recorded for financial period 1.
periodamount20DecimalFalseNoThe monetary amount recorded for financial period 20.
periodamount21DecimalFalseNoThe monetary amount recorded for financial period 21.
periodamount22DecimalFalseNoThe monetary amount recorded for financial period 22.
periodamount23DecimalFalseNoThe monetary amount recorded for financial period 23.
periodamount24DecimalFalseNoThe monetary amount recorded for financial period 24.
periodamount2DecimalFalseNoThe monetary amount recorded for financial period 2.
periodamount3DecimalFalseNoThe monetary amount recorded for financial period 3.
periodamount4DecimalFalseNoThe monetary amount recorded for financial period 4.
periodamount5DecimalFalseNoThe monetary amount recorded for financial period 5.
periodamount6DecimalFalseNoThe monetary amount recorded for financial period 6.
periodamount7DecimalFalseNoThe monetary amount recorded for financial period 7.
periodamount8DecimalFalseNoThe monetary amount recorded for financial period 8.
periodamount9DecimalFalseNoThe monetary amount recorded for financial period 9.
subsidiaryIntegerFalseNoThe subsidiary associated with this financial transaction, relevant for multi-entity organizations.
yearIntegerFalseNoThe fiscal year for which this financial record applies.

Return to Top

budgetlegacy 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique internal identifier assigned to this financial record within the system.
accountIntegerFalseNoThe general ledger account associated with this transaction or financial record.
accountingBookIntegerFalseNoThe accounting book used for financial reporting and compliance.
periodIntegerFalseNoThe financial period in which this transaction or record is reported.
amountDecimalFalseNoThe total monetary value associated with this record.
categoryStringFalseNoThe classification category for financial reporting, such as expense, revenue, or asset.
classIntegerFalseNoThe classification category used for tracking and reporting transactions, such as business unit or cost center.
currencyDecimalFalseNoThe currency in which the transaction is recorded.
customerIntegerFalseNoThe customer associated with this transaction or financial record.
departmentIntegerFalseNoThe department linked to this financial record for reporting and budget tracking.
itemIntegerFalseNoThe specific item or service linked to this financial record.
lastModifiedDateDatetimeFalseNoThe date and time when this record was last modified in the system.
locationIntegerFalseNoThe physical or logical location associated with this financial transaction.
subsidiaryIntegerFalseNoThe subsidiary associated with this financial transaction, relevant for multi-entity organizations.

Return to Top

budgets 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier assigned to this budget record within the system.
accountStringFalseNoThe general ledger account associated with this budget entry.
accountingbookStringFalseNoThe accounting book used for financial reporting and compliance.
categoryStringFalseNoThe budget category, such as Operating Expenses, Revenue, or Capital Expenditures.
classStringFalseNoThe classification category used for tracking and reporting budget allocations, such as department or business unit.
currencyStringFalseNoThe currency in which the budget is recorded.
customerStringFalseNoThe customer associated with this budget entry, if applicable.
departmentStringFalseNoThe department responsible for this budget allocation.
itemStringFalseNoThe specific item or service linked to this budget entry.
locationStringFalseNoThe physical or logical location associated with this budget allocation.
subsidiaryStringFalseNoThe subsidiary associated with this budget entry, relevant for multi-entity organizations.
totalDecimalFalseNoThe total budgeted amount for this entry.
yearStringFalseNoThe fiscal year for which this budget entry applies.

Return to Top

budgetsMachine 

NameTypeReadOnlyReferencesFilterOnlyDescription
amountDecimalFalseNoThe monetary value recorded for the specified accounting period.
periodStringFalseNoThe financial accounting period associated with this transaction or record, such as a month or quarter.

Return to Top

bulkownershiptransfer 

NameTypeReadOnlyReferencesFilterOnlyDescription
inboundshipmentnumberStringFalseNoThe unique identifier assigned to the inbound shipment for tracking and reference.
incotermStringFalseNoThe international commercial term (Incoterm) defining the delivery terms and responsibilities between buyer and seller.
postingperiodStringFalseNoThe financial period in which this inbound shipment is recorded for accounting purposes.
receivinglocationStringFalseNoThe location where the inbound shipment is received and processed.
trandateDateFalseNoThe date on which the inbound shipment transaction occurred.
vendorStringFalseNoThe supplier or vendor responsible for shipping the goods.

Return to Top

bundleinstallationscript 

NameTypeReadOnlyReferencesFilterOnlyDescription
afterinstallfunctionStringFalseNoThe function executed after the script installation process is completed.
afterupdatefunctionStringFalseNoThe function executed after the script is updated to a new version.
beforeinstallfunctionStringFalseNoThe function executed before the script installation process begins.
beforeuninstallfunctionStringFalseNoThe function executed before the script is uninstalled from the system.
beforeupdatefunctionStringFalseNoThe function executed before the script is updated to a new version.
descriptionStringFalseNoA brief summary or details about the script and its functionality.
externalidStringFalseNoA unique identifier used for integration with external systems or data imports.
isinactiveBooleanFalseNoIndicates whether this script record is inactive and no longer in use.
nameStringFalseNoThe name assigned to this script for identification purposes.
notifyadminsBooleanFalseNoIndicates whether administrators should receive notifications about script events.
notifyemailsStringFalseNoA list of email addresses to notify about script-related events, separated by commas.
notifyownerBooleanFalseNoIndicates whether the script owner should receive notifications about script events.
ownerStringFalseNoThe user or entity responsible for managing and maintaining this script.
scriptfileStringFalseNoThe file that contains the script’s source code.
scriptidStringFalseNoThe unique script identifier used within the system.
scripttypeStringFalseNoThe type of script, such as User Event, Scheduled, or Client Script.

Return to Top

BusinessEventHandler 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoA unique internal identifier used for tracking this record within the system.

Return to Top

BusinessEventHandlerFeedDetailType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoA unique internal identifier used for tracking and referencing this record within the system.

Return to Top

BusinessEventHandlerFeedStatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoA unique internal identifier used for tracking and referencing this record within the system.

Return to Top

BusinessEventType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoA unique internal identifier used for tracking and referencing this record within the system.

Return to Top

button 

NameTypeReadOnlyReferencesFilterOnlyDescription
buttonfunctionStringFalseNoThe function executed when the button is clicked.
buttonlabelStringFalseNoThe text displayed on the button.
ownerStringFalseNoThe user or entity responsible for managing this button configuration.

Return to Top

CalculateDiscountType 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoThe unique internal identifier for the record.

Return to Top

calendarevent 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record.
accesslevelStringFalseNoSpecifies the access level for the event, such as public or private.
alldayeventBooleanFalseNoIndicates whether the event lasts all day without a specific start and end time.
bomStringFalseNoThe bill of materials associated with the record.
bomrevisionStringFalseNoThe specific revision of the bill of materials.
companyStringFalseNoThe company associated with the event or transaction.
completeddateDateFalseNoThe date when the event or process was completed.
contactStringFalseNoThe contact person associated with the record.
createddateDateFalseNoThe date when the record was created.
externalidStringFalseNoA unique external identifier for referencing the record in external systems.
lastmodifieddateDateFalseNoThe date when the record was last modified.
locationStringFalseNoThe physical or virtual location where the event or transaction occurred.
messageStringFalseNoA message or note related to the record.
mfgroutingStringFalseNoThe manufacturing routing associated with the item or process.
organizerStringFalseNoThe individual or entity organizing the event.
ownerStringFalseNoThe person responsible for managing the record.
relateditemStringFalseNoAn item related to the event or transaction.
reminderminutesStringFalseNoThe number of minutes before the event when a reminder should be sent.
remindertypeStringFalseNoSpecifies the type of reminder, such as email or popup notification.
startdateDateFalseNoThe date when the event or process begins.
statusStringFalseNoThe current status of the record, such as active or completed.
supportcaseStringFalseNoThe support case associated with the event or transaction.
timedeventBooleanFalseNoIndicates whether the event is time-bound instead of an all-day event.
titleStringFalseNoThe title or subject of the event or record.

Return to Top

campaign 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoThe target audience for the campaign.
autonameBooleanFalseNoIndicates whether the campaign is automatically named.
basecostDecimalFalseNoThe base cost associated with running the campaign.
campaignidStringFalseNoThe unique identifier assigned to the campaign.
categoryStringFalseNoThe category under which the campaign falls.
convcostpercustomerDecimalFalseNoThe conversion cost per acquired customer.
conversionsIntegerFalseNoThe number of successful conversions attributed to the campaign.
costDecimalFalseNoThe total cost incurred for running the campaign.
costpercustomerDecimalFalseNoThe cost of acquiring a single customer through the campaign.
customformStringFalseNoThe custom form used for entering campaign details.
enddateDateFalseNoThe date when the campaign is scheduled to end.
eventnumberStringFalseNoThe reference number associated with the campaign event.
expectedrevenueDecimalFalseNoThe projected revenue expected from the campaign.
externalidStringFalseNoA unique external identifier for referencing the campaign in external systems.
familyStringFalseNoThe campaign family or grouping it belongs to.
isinactiveBooleanFalseNoIndicates whether the campaign is currently inactive.
itemStringFalseNoThe item associated with the campaign, such as a product or service.
keywordStringFalseNoThe main keyword associated with the campaign for search tracking.
leadsgeneratedIntegerFalseNoThe total number of leads generated by the campaign.
messageStringFalseNoThe main message or slogan used in the campaign.
offerStringFalseNoThe promotional offer linked to the campaign.
ownerStringFalseNoThe individual or team responsible for managing the campaign.
profitDecimalFalseNoThe total profit generated from the campaign after deducting costs.
promotioncodeStringFalseNoThe promotion code associated with the campaign.
roiStringFalseNoThe return on investment (ROI) percentage for the campaign.
searchengineStringFalseNoThe search engine associated with the campaign, such as Google or Bing.
startdateDateFalseNoThe date when the campaign officially begins.
titleStringFalseNoThe title or name of the campaign.
totalrevenueDecimalFalseNoThe total revenue generated from the campaign.
uniquevisitorsIntegerFalseNoThe number of unique visitors who interacted with the campaign.
urlStringFalseNoThe website or landing page URL associated with the campaign.
verticalStringFalseNoThe industry vertical targeted by the campaign, such as retail or healthcare.

Return to Top

campaignevent 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique identifier for the campaign event.
campaignStringFalseNoThe campaign associated with this event.
campaigngroupStringFalseNoThe target group or audience for the campaign event.
channelStringFalseNoThe marketing or communication channel used for the campaign, such as email or social media.
costDecimalFalseNoThe total cost incurred for executing this campaign event.
datesentDateFalseNoThe date when the campaign event was executed.
dscheduledDateFalseNoThe scheduled date for the campaign event.
promocodeStringFalseNoThe promotion code associated with the campaign event.
statusStringFalseNoThe current status of the campaign event, such as active or completed.
subscriptionStringFalseNoThe subscription associated with the campaign event, if applicable.
templateStringFalseNoThe template used for the campaign event, such as an email or ad template.
typeStringFalseNoThe type of campaign event, such as webinar, email blast, or social media ad.

Return to Top

campaignEventResponse 

NameTypeReadOnlyReferencesFilterOnlyDescription
bouncedIntegerFalseNoThe number of emails that bounced and were not successfully delivered.
bouncedratioDoubleFalseNoThe percentage of emails that bounced out of the total sent.
clickedthruIntegerFalseNoThe number of recipients who clicked on a link in the email.
clickedthruratioDoubleFalseNoThe percentage of recipients who clicked on a link out of the total opened emails.
openedIntegerFalseNoThe number of recipients who opened the email.
openedratioDoubleFalseNoThe percentage of recipients who opened the email out of the total sent.
respondedIntegerFalseNoThe number of recipients who responded to the email or campaign.
respondedratioDoubleFalseNoThe percentage of recipients who responded out of the total sent.
sentIntegerFalseNoThe total number of emails sent in the campaign.
unsubscribedIntegerFalseNoThe number of recipients who unsubscribed from future emails.
unsubscribedratioDoubleFalseNoThe percentage of recipients who unsubscribed out of the total sent.

Return to Top

campaignresponse 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the campaign response.
campaigneventStringFalseNoThe campaign event associated with this response.
campaignresponsedateDateFalseNoThe date when the campaign response was recorded.
channelStringFalseNoThe marketing or communication channel through which the response was received, such as email or social media.
entityStringFalseNoThe recipient or individual who responded to the campaign.
leadsourceStringFalseNoThe campaign that generated the response.

Return to Top

campaignResponseHistoryEntry 

NameTypeReadOnlyReferencesFilterOnlyDescription
authorStringFalseNoThe author or creator of the campaign response note.
campaignresponseStringFalseNoThe campaign response associated with this note.
noteStringFalseNoAdditional notes or comments related to the campaign response.
responsedateDateFalseNoThe date and time when the campaign response was recorded.

Return to Top

campaigntemplate 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the email template or content record.
contentStringFalseNoThe main content or body of the email template.
descriptionStringFalseNoA brief description of the email template or content.
emailassalesrepBooleanFalseNoIndicates whether the email is sent as the assigned sales representative.
fromemailStringFalseNoThe sender's email address for outgoing emails.
fromnameStringFalseNoThe name displayed as the sender of the email.
isautoconvertedBooleanFalseNoIndicates whether the template was automatically converted from another format.
isinactiveBooleanFalseNoIndicates whether the email template is currently inactive.
isprivateBooleanFalseNoIndicates whether the email template is private and restricted from public access.
mediaitemStringFalseNoThe media item or attachment associated with the email template.
nameStringFalseNoThe name of the email template.
recordtypeStringFalseNoThe type of record associated with the email template, such as campaign or transactional email.
replytoemailStringFalseNoThe email address where replies to this email will be directed.
subjectStringFalseNoThe subject line of the email template.
subscriptionStringFalseNoThe subscription category associated with this email template.

Return to Top

CardholderAuthBillAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the address record.
addr1StringFalseNoThe primary address line.
addr2StringFalseNoThe secondary address line, if applicable.
addr3StringFalseNoThe tertiary address line, if applicable.
addresseeStringFalseNoThe name of the person or entity receiving mail at this address.
addrphoneStringFalseNoThe phone number associated with the address.
attentionStringFalseNoThe name of the person to whom the address is specifically directed.
cardholderauthenticationStringFalseNoAuthentication details related to the cardholder, if applicable.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country associated with the address.
stateStringFalseNoThe state or province associated with the address.

Return to Top

cardholderauthentication 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the transaction.
acceptheaderStringFalseNoThe Accept Header value sent in the request, used for authentication.
amountDecimalFalseNoThe total amount of the transaction.
authenticatedeviceformactionStringFalseNoThe form action URL for device authentication.
authenticatedeviceformidStringFalseNoThe unique identifier for the device authentication form.
billingaddressStringFalseNoThe billing address associated with the transaction.
cavvStringFalseNoThe Cardholder Authentication Verification Value (CAVV), used for 3D Secure authentication.
challengeshopperformactionStringFalseNoThe form action URL for challenging the shopper during authentication.
challengeshopperformidStringFalseNoThe unique identifier for the shopper challenge form.
challengewindowsizeStringFalseNoThe window size for the 3D Secure authentication challenge.
currencyStringFalseNoThe currency used for the transaction.
eciStringFalseNoThe E-Commerce Indicator (ECI) value, representing the security level of the transaction.
entityStringFalseNoThe cardholder or entity making the payment.
externalidStringFalseNoA unique external identifier for referencing the transaction in external systems.
ipaddressStringFalseNoThe IP address of the cardholder making the transaction.
notificationurlStringFalseNoThe URL used to send payment notifications.
paymentmethodStringFalseNoThe payment method used for the transaction.
paymentoptionStringFalseNoThe payment option selected by the cardholder.
paymentprocessingprofileStringFalseNoThe payment processing profile used for handling the transaction.
shippingaddressStringFalseNoThe shipping address associated with the transaction.
statusStringFalseNoThe current status of the transaction.
subsidiaryStringFalseNoThe subsidiary associated with the transaction.
threedstransactionidStringFalseNoThe unique identifier for the 3D Secure transaction.
threedstranstatusreasonStringFalseNoThe reason code for the 3D Secure transaction status.
threedsversionStringFalseNoThe version of 3D Secure used for authentication.

Return to Top

CardholderAuthenticationEvent 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the transaction record.
cardholderauthenticationStringFalseNoThe authentication details of the cardholder, used for transaction security.
eventdatetimeDateFalseNoThe date and time when the transaction event occurred.
externalidStringFalseNoA unique external identifier for referencing the transaction in external systems.
paymentprocessingprofileStringFalseNoThe payment processing profile used to handle the transaction.
referencecodeStringFalseNoA reference code associated with the transaction, used for tracking.
requestStringFalseNoThe raw request data sent for transaction processing.
responseStringFalseNoThe raw response data received from the payment processor.
statusStringFalseNoThe current status of the transaction, such as approved or declined.
statusdetailsStringFalseNoAdditional details regarding the transaction status.
statusreasonStringFalseNoThe reason code explaining the transaction status.
threedstranstatusStringFalseNoThe status of the 3D Secure transaction authentication.
threedstranstatusreasonStringFalseNoThe reason code for the 3D Secure transaction status.

Return to Top

CardholderAuthenticationEventList 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the payment transaction event.
cardholderauthenticationStringFalseNoThe authentication details of the cardholder, used for verifying transaction security.
eventdatetimeDateFalseNoThe date and time when the transaction event occurred.
externalidStringFalseNoA unique external identifier for referencing the transaction in external systems.
paymentprocessingprofileStringFalseNoThe payment processing profile associated with this transaction.
referencecodeStringFalseNoA reference code used for tracking the transaction.
requestStringFalseNoThe raw request data sent for processing the payment transaction.
responseStringFalseNoThe raw response data received from the payment processor.
statusStringFalseNoThe current status of the transaction, such as approved, declined, or pending.
statusdetailsStringFalseNoAdditional details providing insight into the transaction status.
statusreasonStringFalseNoThe reason or explanation for the current transaction status.
threedstranstatusStringFalseNoThe authentication status of the 3D Secure transaction.
threedstranstatusreasonStringFalseNoThe reason or explanation for the 3D Secure transaction status.

Return to Top

CardholderAuthenticationStatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier or key used for referencing the record.

Return to Top

CardholderAuthShipAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the address record.
addr1StringFalseNoThe primary address line, typically including street name and number.
addr2StringFalseNoThe secondary address line, used for apartment, suite, or building details.
addr3StringFalseNoThe tertiary address line, if applicable.
addresseeStringFalseNoThe name of the person or business associated with the address.
addrphoneStringFalseNoThe phone number linked to the address.
attentionStringFalseNoThe name of the individual who should receive attention at this address.
cardholderauthenticationStringFalseNoThe authentication details of the cardholder, used for verification.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country associated with the address.
stateStringFalseNoThe state or province associated with the address.

Return to Top

CartSortOrder 

NameTypeReadOnlyReferencesFilterOnlyDescription
sdescrStringFalseNoA brief description or summary of the record.

Return to Top

cashrefund 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the transaction.
allowemptycardsBooleanFalseNoIndicates whether empty card details are allowed for processing.
althandlingcostDecimalFalseNoAlternative handling cost applied to the transaction.
altshippingcostDecimalFalseNoAlternative shipping cost applied to the transaction.
billaddressStringFalseNoThe full billing address associated with the transaction.
billaddresslistStringFalseNoThe list of available billing addresses.
billingaddressStringFalseNoThe specific billing address selected for the transaction.
billisresidentialStringFalseNoIndicates whether the billing address is residential.
ccapprovedBooleanFalseNoIndicates whether the credit card transaction was approved.
ccexpiredateStringFalseNoThe expiration date of the credit card used in the transaction.
ccholdStringFalseNoIndicates whether the credit card transaction is on hold.
ccholdetailsStringFalseNoAdditional details regarding the credit card hold.
ccispurchasecardbinBooleanFalseNoIndicates whether the credit card is a purchase card BIN.
ccnameStringFalseNoThe name on the credit card used in the transaction.
ccnumberStringFalseNoThe masked credit card number used in the transaction.
ccprocessoraccountStringFalseNoThe payment processor account handling the credit card transaction.
ccstreetStringFalseNoThe street address associated with the credit card.
cczipcodeStringFalseNoThe ZIP code associated with the credit card billing address.
chargeitBooleanFalseNoIndicates whether the transaction is charged to the credit card.
checknumberStringFalseNoThe check number used for the transaction.
classStringFalseNoThe classification assigned to the transaction, such as department or category.
clearedBooleanFalseNoIndicates whether the transaction has been cleared.
cleareddateDateFalseNoThe date when the transaction was cleared.
couponcodeStringFalseNoThe coupon code applied to the transaction.
createddateDatetimeFalseNoThe date and time when the transaction was created.
createdfromStringFalseNoThe original transaction that this record was created from.
creditcardStringFalseNoThe credit card used for the transaction.
creditcardprocessorStringFalseNoThe credit card processor handling the payment.
currencyStringFalseNoThe currency used for the transaction.
currencynameStringFalseNoThe name of the currency used in the transaction.
currencysymbolStringFalseNoThe symbol of the currency used in the transaction.
customercodeStringFalseNoThe customer code associated with the transaction.
customformStringFalseNoThe custom form used for the transaction.
debitcardissuenoStringFalseNoThe issue number of the debit card used in the transaction.
deferredrevenueDecimalFalseNoThe amount of revenue deferred from the transaction.
departmentStringFalseNoThe department associated with the transaction.
discountitemStringFalseNoThe discount item applied to the transaction.
discountrateStringFalseNoThe discount rate applied to the transaction.
discounttotalDecimalFalseNoThe total discount amount deducted from the transaction.
dynamicdescriptorStringFalseNoThe dynamic descriptor used for identifying the transaction.
emailStringFalseNoThe email address associated with the transaction.
entityStringFalseNoThe entity or customer associated with the transaction.
entitynexusStringFalseNoThe nexus associated with the transaction entity.
entitytaxregnumStringFalseNoThe tax registration number of the entity.
estgrossprofitDecimalFalseNoThe estimated gross profit from the transaction.
estgrossprofitpercentStringFalseNoThe estimated gross profit percentage from the transaction.
exchangerateDecimalFalseNoThe exchange rate applied to the transaction.
excludecommissionBooleanFalseNoIndicates whether this transaction is excluded from commission calculations.
externalidStringFalseNoA unique external identifier for referencing the transaction in external systems.
handlingcostDecimalFalseNoThe handling cost applied to the transaction.
handlingmodeStringFalseNoThe handling mode applied, such as standard or express.
handlingtax1rateStringFalseNoThe first tax rate applied to handling costs.
handlingtaxcodeStringFalseNoThe tax code applied to handling costs.
inputauthcodeStringFalseNoThe authorization code entered for the transaction.
inputpnrefnumStringFalseNoThe reference number entered for the payment transaction.
inputreferencecodeStringFalseNoThe reference code entered for the transaction.
isbasecurrencyBooleanFalseNoIndicates whether the transaction is in the base currency.
ispurchasecardStringFalseNoIndicates whether the transaction was processed using a purchase card.
istaxableBooleanFalseNoIndicates whether the transaction is taxable.
lastmodifieddateDatetimeFalseNoThe date and time when the transaction was last modified.
leadsourceStringFalseNoThe lead source associated with the transaction.
locationStringFalseNoThe location where the transaction took place.
memoStringFalseNoA memo or note associated with the transaction.
messageStringFalseNoA message associated with the transaction.
muccpromocodeinstanceStringFalseNoThe MUCC promo code instance applied to the transaction.
nexusStringFalseNoThe tax nexus applied to the transaction.
otherrefnumStringFalseNoAnother reference number associated with the transaction.
outputauthcodeStringFalseNoThe authorization code returned for the transaction.
outputreferencecodeStringFalseNoThe reference code returned for the transaction.
overrideholdBooleanFalseNoIndicates whether the transaction hold is overridden.
overrideholdcheckedBooleanFalseNoIndicates whether the hold override has been checked.
partnerStringFalseNoThe partner associated with the transaction.
paymentcardcscStringFalseNoThe payment card security code used for verification.
paymenteventdateDatetimeFalseNoThe date and time of the payment event.
paymenteventholdreasonStringFalseNoThe reason for placing the payment on hold.
paymenteventpurchasedatasentStringFalseNoIndicates whether purchase data was sent for payment processing.
paymenteventresultStringFalseNoThe result of the payment event.
paymenteventtypeStringFalseNoThe type of payment event.
paymenteventupdatedbyStringFalseNoThe user who last updated the payment event.
paymentmethodStringFalseNoThe method of payment used in the transaction.
paymentoperationStringFalseNoThe payment operation applied, such as authorization or capture.
paymentoptionStringFalseNoThe payment option selected by the customer.
paymentprocessingprofileStringFalseNoThe payment processing profile used for handling the transaction.
paypalauthidStringFalseNoThe PayPal authorization ID for the transaction.
paypalprocessBooleanFalseNoIndicates whether the payment was processed through PayPal.
paypalstatusStringFalseNoThe status of the PayPal transaction.
paypaltranidStringFalseNoThe PayPal transaction ID.
pnrefnumStringFalseNoThe payment reference number.
postingperiodStringFalseNoThe posting period for the transaction.
promocodeStringFalseNoThe promotion code applied to the transaction.
promocodepluginimplStringFalseNoThe implementation plugin for the promotion code.
recognizedrevenueDecimalFalseNoThe recognized revenue from the transaction.
refundcheckBooleanFalseNoIndicates whether a refund check was issued for the transaction.
revenuestatusStringFalseNoThe revenue status of the transaction.
revreconrevcommitmentBooleanFalseNoIndicates whether revenue recognition was committed.
saleseffectivedateDateFalseNoThe date when the sales transaction became effective.
salesgroupStringFalseNoThe sales group associated with the transaction.
salesrepStringFalseNoThe sales representative associated with the transaction.
shipaddressStringFalseNoThe shipping address associated with the transaction.
shipaddresslistStringFalseNoThe list of available shipping addresses.
shipisresidentialStringFalseNoIndicates whether the shipping address is residential.
shipmethodStringFalseNoThe shipping method selected for the transaction.
shipoverrideStringFalseNoIndicates whether shipping charges were overridden.
shippingaddressStringFalseNoThe complete shipping address used in the transaction.
shippingcostDecimalFalseNoThe shipping cost applied to the transaction.
shippingcostoverriddenStringFalseNoIndicates whether shipping costs were manually overridden.
shippingtax1rateStringFalseNoThe first tax rate applied to shipping costs.
shippingtaxcodeStringFalseNoThe tax code applied to shipping charges.
softdescriptorStringFalseNoThe soft descriptor used for payment processing.
sourceStringFalseNoThe source of the transaction, such as an online store or in-person sale.
subsidiaryStringFalseNoThe subsidiary associated with the transaction.
subsidiarytaxregnumStringFalseNoThe tax registration number of the subsidiary.
subtotalDecimalFalseNoThe subtotal amount before taxes and discounts.
syncpartnerteamsBooleanFalseNoIndicates whether partner teams should be synchronized.
syncsalesteamsBooleanFalseNoIndicates whether sales teams should be synchronized.
taxdetailsoverrideBooleanFalseNoIndicates whether tax details were manually overridden.
taxitemStringFalseNoThe tax item applied to the transaction.
taxpointdateDateFalseNoThe date used for determining when tax liability arises for the transaction.
taxpointdateoverrideBooleanFalseNoIndicates whether the tax point date was manually overridden.
taxrateDoubleFalseNoThe tax rate applied to the transaction.
taxregoverrideBooleanFalseNoIndicates whether tax registration details were manually overridden.
taxtotalDecimalFalseNoThe total tax amount applied to the transaction.
tobeemailedBooleanFalseNoIndicates whether the transaction document should be emailed.
tobefaxedBooleanFalseNoIndicates whether the transaction document should be faxed.
tobeprintedBooleanFalseNoIndicates whether the transaction document should be printed.
toprint2BooleanFalseNoIndicates whether a second copy of the transaction document should be printed.
totalDecimalFalseNoThe total amount of the transaction, including taxes and fees.
totalcostestimateDecimalFalseNoThe estimated total cost associated with the transaction.
trandateDateFalseNoThe date when the transaction was recorded.
tranidStringFalseNoThe unique transaction identifier assigned to the record.
tranisvsoebundleBooleanFalseNoIndicates whether the transaction is part of a Vendor-Specific Objective Evidence (VSOE) bundle.
validfromStringFalseNoThe start date from which the transaction or agreement is considered valid.
vsoeautocalcBooleanFalseNoIndicates whether VSOE calculations are automatically applied to the transaction.

Return to Top

cashRefundBillingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique key identifier for the record.
addr1StringFalseNoThe primary address line, typically including street name and number.
addr2StringFalseNoThe secondary address line, used for apartment, suite, or building details.
addr3StringFalseNoThe tertiary address line, if applicable.
addresseeStringFalseNoThe name of the person or business associated with the address.
attentionStringFalseNoThe name of the individual who should receive attention at this address.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country associated with the address.
dropdownstateStringFalseNoThe state or province selected from a dropdown list.
overrideBooleanFalseNoIndicates whether the address details were manually overridden.
stateStringFalseNoThe state or province associated with the address.

Return to Top

cashRefundPartner 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage contribution attributed to the partner.
isprimaryBooleanFalseNoIndicates whether this partner is the primary partner for the transaction.
partnerStringFalseNoThe partner associated with the transaction or record.
partnerroleStringFalseNoThe role of the partner, such as distributor or reseller.

Return to Top

cashRefundSalesTeam 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage contribution attributed to the employee's sales efforts.
employeeStringFalseNoThe employee associated with the transaction or sales activity.
isprimaryBooleanFalseNoIndicates whether this employee is the primary sales representative.
salesroleStringFalseNoThe role of the employee in the sales process, such as account manager or sales executive.

Return to Top

cashRefundShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique key identifier for the record.
addr1StringFalseNoThe primary address line, typically including street name and number.
addr2StringFalseNoThe secondary address line, used for apartment, suite, or building details.
addr3StringFalseNoThe tertiary address line, if applicable.
addresseeStringFalseNoThe name of the recipient or business associated with the address.
attentionStringFalseNoThe name of the person who should receive attention at this address.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country associated with the address.
dropdownstateStringFalseNoThe state or province selected from a dropdown list.
overrideBooleanFalseNoIndicates whether the address details were manually overridden.
stateStringFalseNoThe state or province associated with the address.

Return to Top

cashRefundTranPromotion 

NameTypeReadOnlyReferencesFilterOnlyDescription
couponcodeStringFalseNoThe unique code used to apply a discount or special offer.
promocodeStringFalseNoThe promotion code associated with the transaction or campaign.
promotiontypeStringFalseNoThe type of promotion, such as percentage discount, fixed amount, or free shipping.

Return to Top

cashsale 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the transaction.
allowemptycardsBooleanFalseNoIndicates whether transactions can be processed with empty card details.
althandlingcostDecimalFalseNoThe alternative handling cost applied to the transaction.
altshippingcostDecimalFalseNoThe alternative shipping cost applied to the transaction.
asofdateDateFalseNoThe date as of which the transaction is valid or applicable.
authcodeStringFalseNoThe authorization code for the payment transaction.
billaddressStringFalseNoThe full billing address associated with the transaction.
billaddresslistStringFalseNoThe list of available billing addresses.
billingaccountStringFalseNoThe billing account associated with the transaction.
billingaddressStringFalseNoThe specific billing address selected for the transaction.
billisresidentialStringFalseNoIndicates whether the billing address is residential.
bulkprocsubmissionStringFalseNoReference for bulk processing submission.
canhavestackableBooleanFalseNoIndicates whether multiple promotions or discounts can be stacked.
ccapprovedBooleanFalseNoIndicates whether the credit card transaction was approved.
ccavsstreetmatchStringFalseNoThe address verification service (AVS) match result for the street address.
ccavszipmatchStringFalseNoThe AVS match result for the ZIP code.
ccexpiredateStringFalseNoThe expiration date of the credit card used in the transaction.
ccholdStringFalseNoIndicates whether the credit card transaction is on hold.
ccholdetailsStringFalseNoAdditional details regarding the credit card hold.
cciavsmatchStringFalseNoThe cardholder AVS match result.
ccispurchasecardbinBooleanFalseNoIndicates whether the credit card is a purchase card BIN.
ccnameStringFalseNoThe name on the credit card used in the transaction.
ccnumberStringFalseNoThe masked credit card number used in the transaction.
ccprocessoraccountStringFalseNoThe payment processor account handling the credit card transaction.
ccsecuritycodeStringFalseNoThe security code of the credit card used for verification.
ccsecuritycodematchStringFalseNoThe result of the security code verification.
ccstreetStringFalseNoThe street address associated with the credit card.
cczipcodeStringFalseNoThe ZIP code associated with the credit card billing address.
chargeitBooleanFalseNoIndicates whether the transaction is charged to the credit card.
checknumberStringFalseNoThe check number used for the transaction.
classStringFalseNoThe classification assigned to the transaction, such as department or category.
clearedBooleanFalseNoIndicates whether the transaction has been cleared.
cleareddateDateFalseNoThe date when the transaction was cleared.
couponcodeStringFalseNoThe coupon code applied to the transaction.
createddateDatetimeFalseNoThe date and time when the transaction was created.
createdfromStringFalseNoThe original transaction that this record was created from.
creditcardStringFalseNoThe credit card used for the transaction.
creditcardprocessorStringFalseNoThe credit card processor handling the payment.
currencyStringFalseNoThe currency used for the transaction.
currencynameStringFalseNoThe name of the currency used in the transaction.
currencysymbolStringFalseNoThe symbol of the currency used in the transaction.
customercodeStringFalseNoThe customer code associated with the transaction.
customformStringFalseNoThe custom form used for the transaction.
debitcardissuenoStringFalseNoThe issue number of the debit card used in the transaction.
deferredrevenueDecimalFalseNoThe amount of revenue deferred from the transaction.
departmentStringFalseNoThe department associated with the transaction.
discountitemStringFalseNoThe discount item applied to the transaction.
discountrateStringFalseNoThe discount rate applied to the transaction.
discounttotalDecimalFalseNoThe total discount amount deducted from the transaction.
dynamicdescriptorStringFalseNoThe dynamic descriptor used for identifying the transaction.
emailStringFalseNoThe email address associated with the transaction.
enddateDateFalseNoThe date when the transaction or agreement ends.
entityStringFalseNoThe entity or customer associated with the transaction.
entitynexusStringFalseNoThe tax nexus associated with the entity.
entitytaxregnumStringFalseNoThe tax registration number of the entity.
estgrossprofitDecimalFalseNoThe estimated gross profit from the transaction.
estgrossprofitpercentStringFalseNoThe estimated gross profit percentage from the transaction.
exchangerateDecimalFalseNoThe exchange rate applied to the transaction.
excludecommissionBooleanFalseNoIndicates whether this transaction is excluded from commission calculations.
expcostdiscamountDecimalFalseNoThe discount amount applied to expense costs.
expcostdiscountStringFalseNoThe expense cost discount applied.
expcostdiscprintBooleanFalseNoIndicates whether the expense cost discount should be printed.
expcostdiscrateStringFalseNoThe discount rate applied to expense costs.
expcostdisctaxableBooleanFalseNoIndicates whether the expense cost discount is taxable.
expcosttaxcodeStringFalseNoThe tax code applied to expense costs.
expcosttaxrate1StringFalseNoThe tax rate applied to expense costs.
externalidStringFalseNoA unique external identifier for referencing the transaction in external systems.
fobStringFalseNoThe Free on Board (FOB) shipping terms.
giftcertappliedDecimalFalseNoThe amount applied from a gift certificate towards the transaction.
handlingcostDecimalFalseNoThe handling cost applied to the transaction.
handlingmodeStringFalseNoThe handling mode applied, such as standard or express.
handlingtax1rateStringFalseNoThe first tax rate applied to handling costs.
handlingtaxcodeStringFalseNoThe tax code applied to handling costs.
ignoreavsBooleanFalseNoIndicates whether AVS results are ignored.
ignorecscBooleanFalseNoIndicates whether the card security code (CSC) is ignored.
inputauthcodeStringFalseNoThe authorization code entered for the transaction.
inputpnrefnumStringFalseNoThe reference number entered for the payment transaction.
inputreferencecodeStringFalseNoThe reference code entered for the transaction.
isbasecurrencyBooleanFalseNoIndicates whether the transaction is in the base currency.
ismultishiptoBooleanFalseNoIndicates whether multiple shipping addresses are used.
ispurchasecardStringFalseNoIndicates whether the transaction was processed using a purchase card.
isrecurringpaymentBooleanFalseNoIndicates whether the transaction is part of a recurring payment.
istaxableBooleanFalseNoIndicates whether the transaction is taxable.
itemcostdiscamountDecimalFalseNoThe discount amount applied to item costs.
itemcostdiscountStringFalseNoThe item cost discount applied.
itemcostdiscprintBooleanFalseNoIndicates whether the item cost discount should be printed.
itemcostdiscrateStringFalseNoThe discount rate applied to item costs.
itemcostdisctaxableBooleanFalseNoIndicates whether the item cost discount is taxable.
itemcosttaxcodeStringFalseNoThe tax code applied to item costs.
itemcosttaxrate1StringFalseNoThe tax rate applied to item costs.
lastmodifieddateDatetimeFalseNoThe date and time when the transaction was last modified.
leadsourceStringFalseNoThe lead source associated with the transaction.
linkedtrackingnumbersStringFalseNoThe tracking numbers linked to the transaction.
locationStringFalseNoThe location where the transaction took place.
memoStringFalseNoA memo or note associated with the transaction.
messageStringFalseNoA message associated with the transaction.
messageselStringFalseNoThe message selected for the transaction.
muccpromocodeinstanceStringFalseNoThe MUCC promo code instance applied to the transaction.
nexusStringFalseNoThe tax nexus applied to the transaction.
opportunityStringFalseNoThe sales opportunity linked to the transaction.
otherrefnumStringFalseNoAnother reference number associated with the transaction.
outputauthcodeStringFalseNoThe authorization code returned for the transaction.
outputreferencecodeStringFalseNoThe reference code returned for the transaction.
overrideholdBooleanFalseNoIndicates whether the hold on the transaction has been manually overridden.
overrideholdcheckedBooleanFalseNoIndicates whether the hold override checkbox has been selected.
partnerStringFalseNoThe partner associated with the transaction.
paymentcardcscStringFalseNoThe CSC used for payment verification.
paymenteventdateDatetimeFalseNoThe date and time when the payment event occurred.
paymenteventholdreasonStringFalseNoThe reason the payment event was placed on hold.
paymenteventpurchasedatasentStringFalseNoIndicates whether purchase data was sent for payment processing.
paymenteventresultStringFalseNoThe result of the payment event, such as approved or declined.
paymenteventtypeStringFalseNoThe type of payment event, such as authorization or capture.
paymenteventupdatedbyStringFalseNoThe user who last updated the payment event.
paymentmethodStringFalseNoThe payment method used in the transaction, such as credit card or PayPal.
paymentoperationStringFalseNoThe type of payment operation performed, such as authorization or refund.
paymentoptionStringFalseNoThe payment option selected by the customer.
paymentprocessingprofileStringFalseNoThe payment processing profile used for handling the transaction.
paypalauthidStringFalseNoThe PayPal authorization ID associated with the transaction.
paypalprocessBooleanFalseNoIndicates whether the payment was processed through PayPal.
paypalstatusStringFalseNoThe status of the PayPal transaction.
paypaltranidStringFalseNoThe PayPal transaction ID associated with the payment.
pnrefnumStringFalseNoThe payment reference number associated with the transaction.
postingperiodStringFalseNoThe accounting period in which the transaction was posted.
promocodeStringFalseNoThe promotional code applied to the transaction.
promocodepluginimplStringFalseNoThe plugin implementation used for processing the promo code.
recognizedrevenueDecimalFalseNoThe total amount of revenue recognized from the transaction.
recurringbillBooleanFalseNoIndicates whether the transaction is part of a recurring billing process.
returntrackingnumbersStringFalseNoThe tracking numbers associated with returned items.
revenuestatusStringFalseNoThe revenue recognition status of the transaction.
revreconrevcommitmentBooleanFalseNoIndicates whether revenue recognition was committed.
saleseffectivedateDateFalseNoThe date when the sales transaction became effective.
salesgroupStringFalseNoThe sales group associated with the transaction.
salesrepStringFalseNoThe sales representative responsible for the transaction.
shipaddressStringFalseNoThe shipping address associated with the transaction.
shipaddresslistStringFalseNoThe list of available shipping addresses.
shipdateDateFalseNoThe date when the items were shipped.
shipisresidentialStringFalseNoIndicates whether the shipping address is residential.
shipmethodStringFalseNoThe shipping method used for the transaction.
shipoverrideStringFalseNoIndicates whether shipping charges were manually overridden.
shippingaddressStringFalseNoThe complete shipping address used in the transaction.
shippingcostDecimalFalseNoThe total shipping cost applied to the transaction.
shippingcostoverriddenStringFalseNoIndicates whether the shipping cost was manually overridden.
shippingtax1rateStringFalseNoThe tax rate applied to shipping charges.
shippingtaxcodeStringFalseNoThe tax code applied to shipping charges.
softdescriptorStringFalseNoThe soft descriptor used for payment processing, often seen on statements.
sourceStringFalseNoThe source of the transaction, such as an online store or in-person sale.
startdateDateFalseNoThe start date of the transaction or agreement.
statusStringFalseNoThe current status of the transaction, such as pending, completed, or canceled.
statusrefStringFalseNoA reference to the status of the transaction.
subsidiaryStringFalseNoThe subsidiary associated with the transaction.
subsidiarytaxregnumStringFalseNoThe tax registration number of the subsidiary.
subtotalDecimalFalseNoThe subtotal amount before taxes and discounts.
syncpartnerteamsBooleanFalseNoIndicates whether partner teams should be synchronized.
syncsalesteamsBooleanFalseNoIndicates whether sales teams should be synchronized.
taxdetailsoverrideBooleanFalseNoIndicates whether tax details were manually overridden.
taxitemStringFalseNoThe tax item applied to the transaction.
taxpointdateDateFalseNoThe date used to determine when tax liability arises for the transaction.
taxpointdateoverrideBooleanFalseNoIndicates whether the tax point date was manually overridden.
taxrateDoubleFalseNoThe tax rate applied to the transaction.
taxregoverrideBooleanFalseNoIndicates whether tax registration details were manually overridden.
taxtotalDecimalFalseNoThe total tax amount applied to the transaction.
threedstatuscodeStringFalseNoThe 3D Secure authentication status code for the transaction.
timediscamountDecimalFalseNoThe discount amount applied to time-based charges.
timediscountStringFalseNoThe time-based discount applied to the transaction.
timediscprintBooleanFalseNoIndicates whether the time discount should be printed.
timediscrateStringFalseNoThe discount rate applied to time-based charges.
timedisctaxableBooleanFalseNoIndicates whether the time-based discount is taxable.
timetaxcodeStringFalseNoThe tax code applied to time-based charges.
timetaxrate1StringFalseNoThe tax rate applied to time-based charges.
tobeemailedBooleanFalseNoIndicates whether the transaction document should be emailed.
tobefaxedBooleanFalseNoIndicates whether the transaction document should be faxed.
tobeprintedBooleanFalseNoIndicates whether the transaction document should be printed.
totalDecimalFalseNoThe total amount of the transaction, including taxes and fees.
totalcostestimateDecimalFalseNoThe estimated total cost associated with the transaction.
trackingnumbersStringFalseNoThe tracking numbers associated with the shipment.
trandateDateFalseNoThe date when the transaction was recorded.
tranidStringFalseNoThe unique transaction identifier assigned to the record.
tranisvsoebundleBooleanFalseNoIndicates whether the transaction is part of a Vendor-Specific Objective Evidence (VSOE) bundle.
undepfundsStringFalseNoIndicates whether funds are held in an undeposited account before clearing.
validfromStringFalseNoThe start date from which the transaction or agreement is considered valid.
vsoeautocalcBooleanFalseNoIndicates whether VSOE calculations are automatically applied to the transaction.

Return to Top

cashSaleBillingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique key identifier for the record.
addr1StringFalseNoThe primary address line, typically including the street name and number.
addr2StringFalseNoThe secondary address line, used for apartment, suite, or building details.
addr3StringFalseNoThe tertiary address line, if applicable.
addresseeStringFalseNoThe name of the recipient or business associated with the address.
attentionStringFalseNoThe name of the person who should receive attention at this address.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country associated with the address.
dropdownstateStringFalseNoThe state or province selected from a dropdown list.
overrideBooleanFalseNoIndicates whether the address details were manually overridden.
stateStringFalseNoThe state or province associated with the address.

Return to Top

cashSaleGiftCertRedemption 

NameTypeReadOnlyReferencesFilterOnlyDescription
authcodeStringFalseNoThe authorization code for the gift certificate.
authcodeappliedDecimalFalseNoThe amount applied from the gift certificate to the transaction.

Return to Top

cashSaleItemShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique key identifier for the address record.
addr1StringFalseNoThe primary address line, typically including the street name and number.
addr2StringFalseNoThe secondary address line, used for apartment, suite, or building details.
addr3StringFalseNoThe tertiary address line, if applicable.
addresseeStringFalseNoThe name of the recipient or business associated with the address.
attentionStringFalseNoThe name of the person to whom the address is specifically directed.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country associated with the address.
dropdownstateStringFalseNoThe state or province selected from a dropdown list.
overrideBooleanFalseNoIndicates whether the address details were manually overridden.
stateStringFalseNoThe state or province associated with the address.

Return to Top

cashSalePartner 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage contribution attributed to the partner's role in the transaction.
isprimaryBooleanFalseNoIndicates whether this partner is the primary partner for the transaction.
partnerStringFalseNoThe partner associated with the transaction or deal.
partnerroleStringFalseNoThe role of the partner, such as distributor, reseller, or affiliate.

Return to Top

cashSaleSalesTeam 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage contribution attributed to the employee's role in the sale or transaction.
employeeStringFalseNoThe employee associated with the sale or transaction.
isprimaryBooleanFalseNoIndicates whether this employee is the primary sales representative.
salesroleStringFalseNoThe role of the employee in the sales process, such as account manager or sales executive.

Return to Top

cashSaleShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique key identifier for the address record.
addr1StringFalseNoThe primary address line, typically including the street name and number.
addr2StringFalseNoThe secondary address line, used for apartment, suite, or building details.
addr3StringFalseNoThe tertiary address line, if applicable.
addresseeStringFalseNoThe name of the recipient or business associated with the address.
attentionStringFalseNoThe name of the person to whom the address is specifically directed.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country associated with the address.
dropdownstateStringFalseNoThe state or province selected from a dropdown list.
overrideBooleanFalseNoIndicates whether the address details were manually overridden.
stateStringFalseNoThe state or province associated with the address.

Return to Top

cashSaleTrackingNumberMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
trackingnumberStringFalseNoThe unique tracking number assigned to the shipment or package.

Return to Top

cashSaleTranPromotion 

NameTypeReadOnlyReferencesFilterOnlyDescription
couponcodeStringFalseNoThe unique code used to apply a discount or special offer.
promocodeStringFalseNoThe promotional code associated with the transaction or campaign.
promotiontypeStringFalseNoThe type of promotion applied, such as percentage discount, fixed amount, or free shipping.

Return to Top

category1099misc 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record.
descrStringFalseNoA brief description of the record.
isinactiveBooleanFalseNoIndicates whether the record is inactive.
nameStringFalseNoThe name associated with the record.

Return to Top

CcBccRecipient 

NameTypeReadOnlyReferencesFilterOnlyDescription
bccBooleanFalseNoIndicates whether the email is BCCed to recipients.
ccBooleanFalseNoIndicates whether the email is CCed to recipients.
emailStringFalseNoThe email address of the primary recipient.
messageStringFalseNoThe content or body of the email message.
otherrecipientStringFalseNoAdditional recipients included in the email.

Return to Top

CenterType 

NameTypeReadOnlyReferencesFilterOnlyDescription
centertypeStringFalseNoThe type of center associated with the record, such as customer, vendor, or employee.

Return to Top

ChallengeShopperInput 

NameTypeReadOnlyReferencesFilterOnlyDescription
cardholderauthenticationStringFalseNoThe authentication details used to verify the cardholder's identity during a transaction.
nameStringFalseNoThe name associated with the cardholder or authentication record.

Return to Top

ChallengeShopperResult 

NameTypeReadOnlyReferencesFilterOnlyDescription
cardholderauthenticationStringFalseNoThe authentication method or data used to verify the cardholder's identity during a transaction.
nameStringFalseNoThe name associated with the cardholder or authentication record.

Return to Top

ChallengeWindowSize 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier or key used for referencing the record.

Return to Top

charge 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the billing record.
amountDecimalFalseNoThe total amount of the charge or billing entry.
billdateDateFalseNoThe date when the bill was issued.
billingitemStringFalseNoThe specific item being billed.
billingmodeStringFalseNoThe method used for billing, such as one-time or recurring.
billingscheduleStringFalseNoThe schedule for billing, such as monthly, quarterly, or annual.
billtoStringFalseNoThe customer or project being billed.
chargedateDateFalseNoThe date the charge was applied.
chargetypeStringFalseNoThe type of charge, such as fixed or variable.
classStringFalseNoThe classification associated with the billing record.
createddateDateFalseNoThe date when the billing record was created.
creditmemoStringFalseNoThe credit memo associated with the transaction.
creditmemolineStringFalseNoThe specific item line of the credit memo.
currencyStringFalseNoThe currency used for the billing transaction.
departmentStringFalseNoThe department associated with the billing record.
descriptionStringFalseNoA description of the charge or billing item.
externalidStringFalseNoA unique external identifier for referencing the billing record in external systems.
grouporderIntegerFalseNoThe order of the charge group within the billing process.
invoiceStringFalseNoThe invoice number associated with the billing record.
invoicelineStringFalseNoThe item line on the invoice.
invoicelnStringFalseNoThe specific line on the invoice detailing a charge.
locationStringFalseNoThe location associated with the billing record.
memoStringFalseNoA memo or note related to the billing record.
projecttaskStringFalseNoThe specific task or activity within the project being billed.
quantityDoubleFalseNoThe quantity of the item or service being billed.
rateStringFalseNoThe rate applied to the billing item, such as per hour or per unit.
ruleStringFalseNoThe rule applied to determine the charge, such as usage or flat rate.
runidStringFalseNoThe unique identifier for the billing run process.
salesorderStringFalseNoThe sales order associated with the billing record.
salesorderlineStringFalseNoThe specific line item on the sales order related to the billing.
serviceenddateDateFalseNoThe date when the service associated with the charge ends.
servicestartdateDateFalseNoThe date when the service associated with the charge begins.
stageStringFalseNoThe stage or phase of the transaction or billing process.
subsidiaryStringFalseNoThe subsidiary associated with the billing record.
timerecordStringFalseNoThe time entry associated with the billing record.
transactionStringFalseNoThe transaction identifier associated with the billing record.
transactionlineStringFalseNoThe specific transaction line related to the charge.
useStringFalseNoThe use or purpose for which the charge is applied.

Return to Top

Chargebillingmodetype 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier or key used for referencing the record.

Return to Top

chargerule 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the charge record.
chargeruletypeStringFalseNoThe type of charge rule applied, such as fixed or percentage.
descriptionStringFalseNoA brief description of the charge or rule.
externalidStringFalseNoA unique external identifier for referencing the charge record in external systems.
isinactiveBooleanFalseNoIndicates whether the charge rule is currently inactive.
nameStringFalseNoThe name of the charge or charge rule.

Return to Top

ChargeRun 

NameTypeReadOnlyReferencesFilterOnlyDescription
chargegeneratedIntegerFalseNoThe number of charges generated during the run.
dateendedDateFalseNoThe date when the charge run ended.
datestartedDateFalseNoThe date when the charge run started.
deletestatusStringFalseNoThe status indicating whether charges were deleted during the run.
messageStringFalseNoAny relevant message or notification related to the charge run.
projectStringFalseNoThe project associated with the charge run.
relatedrunidIntegerFalseNoThe ID of the related charge run, if applicable.
runidIntegerFalseNoThe unique identifier for the charge run.
runtypeStringFalseNoThe type of charge run, such as regular, scheduled, or ad-hoc.

Return to Top

Chargestagetype 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier or key used for referencing the record.

Return to Top

chargeType 

NameTypeReadOnlyReferencesFilterOnlyDescription
applytocustomerBooleanFalseNoIndicates whether the charge is applied to customer charges.
applytoprojectBooleanFalseNoIndicates whether the charge is applied to project charges.
externalidStringFalseNoA unique external identifier for referencing the charge type in external systems.
isinactiveBooleanFalseNoIndicates whether the charge type is currently inactive.
nameStringFalseNoThe name of the charge type.
scriptidStringFalseNoThe unique identifier for the script associated with the charge type.

Return to Top

chargeTypeTranslations 

NameTypeReadOnlyReferencesFilterOnlyDescription
labelStringFalseNoThe label or name associated with the record.
languageStringFalseNoThe language associated with the record or transaction.
localeStringFalseNoThe locale or regional setting, typically used for formatting or localization purposes.

Return to Top

Chargeuse 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier or key used to reference the record.

Return to Top

check 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the transaction.
balanceDecimalFalseNoThe current balance of the account or transaction.
billpayBooleanFalseNoIndicates whether the transaction is associated with bill payment.
classStringFalseNoThe classification of the transaction, such as department or category.
clearedBooleanFalseNoIndicates whether the transaction has been cleared.
cleareddateDateFalseNoThe date when the transaction was cleared.
createddateDatetimeFalseNoThe date and time when the transaction was created.
currencyStringFalseNoThe currency used in the transaction.
currencynameStringFalseNoThe name of the currency used in the transaction.
currencysymbolStringFalseNoThe symbol of the currency used in the transaction.
customformStringFalseNoThe custom form used for the transaction.
departmentStringFalseNoThe department associated with the transaction.
entityStringFalseNoThe entity or customer associated with the transaction.
entitynexusStringFalseNoThe tax nexus associated with the entity for the transaction.
exchangerateDecimalFalseNoThe exchange rate used for currency conversion in the transaction.
externalidStringFalseNoA unique external identifier for referencing the transaction.
isbasecurrencyBooleanFalseNoIndicates whether the transaction is in the base currency.
landedcostperlineBooleanFalseNoIndicates whether landed costs are applied per line item.
lastmodifieddateDatetimeFalseNoThe date and time when the transaction was last modified.
locationStringFalseNoThe location associated with the transaction.
memoStringFalseNoA memo or note associated with the transaction.
nexusStringFalseNoThe tax nexus associated with the transaction.
payeeaddressStringFalseNoThe address of the payee in the transaction.
payeeaddresslistStringFalseNoThe list of payee addresses.
postingperiodStringFalseNoThe accounting period in which the transaction was posted.
statusStringFalseNoThe current status of the transaction, such as pending, approved, or completed.
statusrefStringFalseNoA reference for the status of the transaction.
subsidiaryStringFalseNoThe subsidiary associated with the transaction.
tobeprintedBooleanFalseNoIndicates whether the transaction document is to be printed.
totalDecimalFalseNoThe total amount of the transaction, including all charges.
trandateDateFalseNoThe date when the transaction was recorded.
tranidStringFalseNoThe unique identifier assigned to the transaction.
transactionnumberStringFalseNoThe transaction number associated with the transaction.
usertotalDecimalFalseNoThe total amount calculated by the user for the transaction.

Return to Top

CheckExpenseMachine 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the transaction or record.
categoryStringFalseNoThe category assigned to the transaction or record, such as office supplies or utilities.
checkStringFalseNoA reference to the check associated with the transaction.
classStringFalseNoThe classification of the transaction, such as department or project.
customerStringFalseNoThe customer associated with the transaction or record.
departmentStringFalseNoThe department responsible for the transaction or record.
expenseitemIntegerFalseNoThe expense item number associated with the transaction.
grossamtDecimalFalseNoThe total gross amount of the transaction before any deductions.
isbillableBooleanFalseNoIndicates whether the transaction is billable to a customer.
lineIntegerFalseNoThe line number associated with the transaction or record.
locationStringFalseNoThe location where the transaction or record was made.
memoStringFalseNoA memo or note providing additional details about the transaction.

Return to Top

checkPayeeAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique key identifier for the address record.
addr1StringFalseNoThe primary address line, typically including the street name and number.
addr2StringFalseNoThe secondary address line, used for apartment, suite, or building details.
addr3StringFalseNoThe tertiary address line, if applicable.
addresseeStringFalseNoThe name of the recipient or business associated with the address.
attentionStringFalseNoThe name of the person to whom the address is specifically directed.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country associated with the address.
dropdownstateStringFalseNoThe state or province selected from a dropdown list.
overrideBooleanFalseNoIndicates whether the address details were manually overridden.
stateStringFalseNoThe state or province associated with the address.

Return to Top

classification 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the class record.
externalidStringFalseNoA unique external identifier for referencing the class in external systems.
fullnameStringFalseNoThe full name of the class or category.
includechildrenBooleanFalseNoIndicates whether the class includes any child categories or subclasses.
isinactiveBooleanFalseNoIndicates whether the class is currently inactive.
nameStringFalseNoThe name of the class or category.
parentStringFalseNoThe parent class or category to which this subclass belongs.

Return to Top

clientscript 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoA brief description of the script or function.
externalidStringFalseNoA unique external identifier for referencing the script in external systems.
fieldchangedfunctionStringFalseNoThe function triggered when a field value changes in the script.
isinactiveBooleanFalseNoIndicates whether the script is currently inactive.
lineinitfunctionStringFalseNoThe function used to initialize line items in the script.
nameStringFalseNoThe name of the script or function.
notifyadminsBooleanFalseNoIndicates whether administrators should be notified.
notifyemailsStringFalseNoThe email addresses to notify when the script is triggered.
notifygroupStringFalseNoThe group to notify when the script is triggered.
notifyownerBooleanFalseNoIndicates whether the owner should be notified.
notifyuserBooleanFalseNoIndicates whether the user should be notified.
ownerStringFalseNoThe owner of the script or function.
pageinitfunctionStringFalseNoThe function used to initialize the page in the script.
postsourcingfunctionStringFalseNoThe function triggered after sourcing data in the script.
recalcfunctionStringFalseNoThe function used to recalculate values in the script.
saverecordfunctionStringFalseNoThe function triggered when saving a record.
scriptfileStringFalseNoThe file containing the script code.
scriptidStringFalseNoA unique identifier for the script.
scripttypeStringFalseNoThe type of script, such as client or user event.
validatedeletefunctionStringFalseNoThe function triggered to validate before a record is deleted.
validatefieldfunctionStringFalseNoThe function used to validate a field value.
validateinsertfunctionStringFalseNoThe function triggered to validate before a record is inserted.
validatelinefunctionStringFalseNoThe function used to validate each line item.

Return to Top

cmscontent 

NameTypeReadOnlyReferencesFilterOnlyDescription
areanameStringFalseNoThe name of the area associated with the content or page.
changeurlStringFalseNoThe URL used to change or redirect the page.
cmscontenttypeStringFalseNoThe type of content managed in the CMS.
createdbyStringFalseNoThe user who created the content or page.
createddateDateFalseNoThe date when the content or page was created.
descriptionStringFalseNoA brief description of the content or page.
enddateDatetimeFalseNoThe date and time when the content or page is scheduled to end or expire.
externalidStringFalseNoA unique external identifier for referencing the content or page in external systems.
globalStringFalseNoIndicates whether the content or page is global and available across all regions.
hiddenBooleanFalseNoIndicates whether the content or page is hidden from view.
idIntegerFalseNoThe unique internal identifier for the content or page.
internalidIntegerFalseNoThe internal ID used by the system to reference the content or page.
lastmodifiedbyStringFalseNoThe user who last modified the content or page.
lastmodifieddateDateFalseNoThe date when the content or page was last modified.
matchcountIntegerFalseNoThe number of matches or instances associated with the content or page.
matchtypeStringFalseNoThe type of match, such as exact match or partial match.
nameStringFalseNoThe name of the content or page.
pagetypeStringFalseNoThe type of page, such as static, dynamic, or template-based.
pathStringFalseNoThe file path or URL associated with the content or page.
sequencenumberIntegerFalseNoThe sequence number used to determine the order of the content or page.
settingsIntegerFalseNoThe settings associated with the content or page, such as visibility or permissions.
siteStringFalseNoThe site associated with the content or page.
startdateDatetimeFalseNoThe date and time when the content or page becomes active.
templateStringFalseNoThe template used for rendering the content or page.

Return to Top

cmscontenttype 

NameTypeReadOnlyReferencesFilterOnlyDescription
customrecordidStringFalseNoThe unique identifier for the custom record.
customrecordscriptidStringFalseNoThe script ID associated with the custom record.
descriptionStringFalseNoA brief description of the custom record.
externalidStringFalseNoA unique external identifier for referencing the custom record in external systems.
iconimagepathStringFalseNoThe file path or URL to the icon image associated with the custom record.
idIntegerFalseNoThe unique internal identifier for the custom record.
internalidIntegerFalseNoThe internal ID used by the system to reference the custom record.
labelStringFalseNoThe label or name displayed for the custom record.
nameStringFalseNoThe name associated with the custom record.

Return to Top

cmspage 

NameTypeReadOnlyReferencesFilterOnlyDescription
addtoheadStringFalseNoIndicates whether content is added to the head section of the page.
createdbyStringFalseNoThe user who created the page or content.
createddateDateFalseNoThe date when the page or content was created.
enddateDatetimeFalseNoThe date and time when the page or content is scheduled to end or expire.
externalidStringFalseNoA unique external identifier for referencing the page or content in external systems.
idIntegerFalseNoThe unique internal identifier for the page or content.
internalidIntegerFalseNoThe internal ID used by the system to reference the page or content.
lastmodifiedbyStringFalseNoThe user who last modified the page or content.
lastmodifieddateDateFalseNoThe date when the page or content was last modified.
metadescriptionStringFalseNoThe meta description associated with the page for SEO purposes.
metakeywordsStringFalseNoThe meta keywords associated with the page for SEO purposes.
nameStringFalseNoThe name associated with the page or content.
pageheaderStringFalseNoThe header content displayed on the page.
pagetitleStringFalseNoThe title of the page, typically displayed in the browser tab.
pagetypeStringFalseNoThe type of page, such as static, dynamic, or template-based.
siteStringFalseNoThe site associated with the page or content.
startdateDatetimeFalseNoThe date and time when the page or content becomes active.
templateStringFalseNoThe template used for rendering the page or content.
urlStringFalseNoThe URL associated with the page or content.

Return to Top

commercecategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
addtoheadStringFalseNoIndicates whether content is added to the head section of the page.
catalogStringFalseNoThe catalog associated with the page or content.
createdDateFalseNoThe date when the page or content was created.
descriptionStringFalseNoA brief description of the page or content.
displayinsiteStringFalseNoIndicates whether the page or content is displayed on the site.
enddateDatetimeFalseNoThe date and time when the page or content is scheduled to end or expire.
externalidStringFalseNoA unique external identifier for referencing the page or content in external systems.
isinactiveBooleanFalseNoIndicates whether the page or content is inactive.
lastmodifiedDateFalseNoThe date when the page or content was last modified.
lastmodifiedbyStringFalseNoThe user who last modified the page or content.
metadescriptionStringFalseNoThe meta description associated with the page for SEO purposes.
metakeywordsStringFalseNoThe meta keywords associated with the page for SEO purposes.
nameStringFalseNoThe name associated with the page or content.
origbinactiveBooleanFalseNoIndicates whether the page or content was originally inactive.
pagebannerStringFalseNoThe banner image or content displayed on the page.
pageheadingStringFalseNoThe heading or title displayed on the page.
pagetitleStringFalseNoThe title of the page, typically displayed in the browser tab.
primaryparentStringFalseNoThe primary parent page or content associated with the current page.
sequencenumberIntegerFalseNoThe sequence number used to determine the order of the page or content.
sitemappriorityStringFalseNoThe priority of the page in the site map, influencing SEO ranking.
startdateDatetimeFalseNoThe date and time when the page or content becomes active.
thumbnailStringFalseNoThe thumbnail image associated with the page or content.
urlfragmentStringFalseNoThe URL fragment or slug used to access the page.
versionIntegerFalseNoThe version number of the page or content.

Return to Top

CommissionPaymentType 

NameTypeReadOnlyReferencesFilterOnlyDescription
defaultnameStringFalseNoThe default name assigned to the record or entity.
keyStringFalseNoA unique identifier or key used for referencing the record.
nameStringFalseNoThe name associated with the record or entity.

Return to Top

CompanyAddressbook 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoThe unique internal identifier for the record.
addressbookaddressStringFalseNoThe address associated with the address book entry.
defaultbillingBooleanFalseNoIndicates whether this address is set as the default billing address.
defaultshippingBooleanFalseNoIndicates whether this address is set as the default shipping address.
entityStringFalseNoThe entity (such as a customer, vendor, or partner) associated with the address.

Return to Top

CompanyAddressbookEntityAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique key identifier for the address record.
addr1StringFalseNoThe primary address line, typically including the street name and number.
addr2StringFalseNoThe secondary address line, used for apartment, suite, or building details.
addr3StringFalseNoThe tertiary address line, if applicable.
addresseeStringFalseNoThe name of the recipient or business associated with the address.
attentionStringFalseNoThe name of the person to whom the address is specifically directed.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country associated with the address.
dropdownstateStringFalseNoThe state or province selected from a dropdown list.
overrideBooleanFalseNoIndicates whether the address details were manually overridden.
stateStringFalseNoThe state or province associated with the address.

Return to Top

CompanyBulkMerge 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoThe entity (for example, customer, vendor, or partner) associated with the record.
mergedateDateFalseNoThe date and time when the entity was merged.
mergetypeStringFalseNoThe type of merge operation performed, such as manual or automatic.
statusStringFalseNoThe current status of the entity or record, such as active or inactive.
subjectStringFalseNoThe subject associated with the record or communication.
templateStringFalseNoThe template used for generating the content or document.
usernameStringFalseNoThe username associated with the entity or record.

Return to Top

CompanyCampaigns 

NameTypeReadOnlyReferencesFilterOnlyDescription
campaignStringFalseNoThe campaign associated with the response or event.
campaigneventStringFalseNoThe event associated with the campaign.
categoryStringFalseNoThe category of the campaign or event, such as promotional or informational.
contactStringFalseNoThe contact associated with the campaign or response.
datesentDateFalseNoThe date when the campaign or response was sent.
entityStringFalseNoThe entity associated with the campaign or event, such as customer, lead, or partner.
responseStringFalseNoThe details of the response received from the contact or entity.
responsedateDateFalseNoThe date when the response was received.

Return to Top

CompanyCompanyContact 

NameTypeReadOnlyReferencesFilterOnlyDescription
contactStringFalseNoThe contact associated with the record, typically representing a person or entity.

Return to Top

competitor 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record.
descriptionStringFalseNoA brief description of the record or entity.
externalidStringFalseNoA unique external identifier for referencing the record in external systems.
isinactiveBooleanFalseNoIndicates whether the record is currently inactive.
nameStringFalseNoThe name associated with the record or entity.
productserviceStringFalseNoThe products or services associated with the record.
strategyStringFalseNoThe strategy associated with the record or entity.
strengthsStringFalseNoThe strengths or advantages of the entity or record.
weaknessesStringFalseNoThe weaknesses or areas of improvement for the entity or record.

Return to Top

CompetitorOpportunity 

NameTypeReadOnlyReferencesFilterOnlyDescription
competitorStringFalseNoThe competitor associated with the opportunity or record.
notesStringFalseNoAdditional notes or details related to the opportunity.
opportunityStringFalseNoThe name or identifier of the opportunity being tracked.

Return to Top

consolidatedexchangerate 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record.
accountingbookStringFalseNoThe accounting book associated with the transaction or record.
averagerateDecimalFalseNoThe average exchange rate used during the specified period.
currentrateDecimalFalseNoThe current exchange rate for currency conversion.
externalidStringFalseNoA unique external identifier for referencing the record in external systems.
fromcurrencyStringFalseNoThe source currency for the transaction or exchange.
fromsubsidiaryStringFalseNoThe subsidiary from which the transaction or exchange originates.
historicalrateDecimalFalseNoThe historical exchange rate used for past transactions or comparisons.
postingperiodStringFalseNoThe accounting period during which the transaction or exchange is recorded.
tocurrencyStringFalseNoThe target currency for the conversion or exchange.

Return to Top

ConsolidatedRateType 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique identifier for the record.
defaultnameStringFalseNoThe default name assigned to the record, used when no custom name is provided.
nameStringFalseNoThe name associated with the record.

Return to Top

contact 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the contact record.
altemailStringFalseNoThe alternative email address associated with the contact.
assistantStringFalseNoThe assistant or secondary contact associated with the contact.
categoryStringFalseNoThe category assigned to the contact, such as customer, prospect, or partner.
commentsStringFalseNoAdditional comments or notes related to the contact.
companyStringFalseNoThe company or organization associated with the contact.
contactcampaigneventStringFalseNoThe campaign event associated with the contact.
contactsourceStringFalseNoThe source from which the contact was acquired, such as a referral or marketing campaign.
contactsourcecampaigncategoryStringFalseNoThe campaign category associated with the contact source.
datecreatedDateFalseNoThe date when the contact record was created.
defaultbillingaddressStringFalseNoThe default billing address for the contact.
defaultshippingaddressStringFalseNoThe default shipping address for the contact.
duplicateBooleanFalseNoIndicates whether the contact record is a duplicate of another.
emailStringFalseNoThe primary email address associated with the contact.
entityidStringFalseNoThe identifier of the entity (customer, vendor, etc.) associated with the contact.
entitytitleStringFalseNoThe title or name/ID associated with the entity.
externalidStringFalseNoA unique external identifier for referencing the contact in external systems.
firstnameStringFalseNoThe first name of the contact.
globalsubscriptionstatusStringFalseNoThe global subscription status of the contact, indicating whether they are subscribed or unsubscribed.
isinactiveBooleanFalseNoIndicates whether the contact is inactive.
isprivateBooleanFalseNoIndicates whether the contact's information is marked as private.
lastmodifieddateDateFalseNoThe date when the contact record was last modified.
lastnameStringFalseNoThe last name of the contact.
middlenameStringFalseNoThe middle name of the contact.
phoneticnameStringFalseNoThe phonetic version of the contact's name, often used for pronunciation (for example, Furigana).
salutationStringFalseNoThe salutation used for the contact, such as Mr. or Ms.
titleStringFalseNoThe job title or position held by the contact.

Return to Top

ContactAddressbook 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoThe unique internal identifier for the address record.
addressbookaddressStringFalseNoThe address associated with the address book entry.
defaultbillingBooleanFalseNoIndicates whether this address is set as the default billing address.
defaultshippingBooleanFalseNoIndicates whether this address is set as the default shipping address.
entityStringFalseNoThe entity (such as a customer, vendor, or partner) associated with the address.

Return to Top

ContactAddressbookEntityAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique key identifier for the address record.
addr1StringFalseNoThe primary address line, typically including the street name and number.
addr2StringFalseNoThe secondary address line, used for apartment, suite, or building details.
addr3StringFalseNoThe tertiary address line, if applicable.
addresseeStringFalseNoThe name of the recipient or business associated with the address.
attentionStringFalseNoThe name of the person to whom the address is specifically directed.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country associated with the address.
dropdownstateStringFalseNoThe state or province selected from a dropdown list.
overrideBooleanFalseNoIndicates whether the address details were manually overridden.
stateStringFalseNoThe state or province associated with the address.

Return to Top

ContactBulkMerge 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoThe entity (such as customer, lead, or partner) associated with the record.
mergedateDateFalseNoThe date and time when the entity was merged.
mergetypeStringFalseNoThe type of merge operation, such as manual or automatic.
statusStringFalseNoThe current status of the entity or record, such as active or inactive.
subjectStringFalseNoThe subject or title associated with the record or communication.
templateStringFalseNoThe template used for generating the content or document.
usernameStringFalseNoThe username associated with the entity or record.

Return to Top

contactcategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the contact category record.
externalidStringFalseNoA unique external identifier for referencing the contact category in external systems.
isinactiveBooleanFalseNoIndicates whether the contact category is currently inactive.
nameStringFalseNoThe name of the contact category.

Return to Top

ContactContactCampaigns 

NameTypeReadOnlyReferencesFilterOnlyDescription
campaignStringFalseNoThe campaign associated with the response or event.
campaigneventStringFalseNoThe event associated with the campaign.
categoryStringFalseNoThe category of the campaign or event, such as promotional or informational.
contactStringFalseNoThe contact associated with the campaign or response.
datesentDateFalseNoThe date when the campaign or response was sent.
entityorcontactStringFalseNoThe entity or contact associated with the campaign or event.
responseStringFalseNoThe details of the response received from the contact or entity.
responsedateDateFalseNoThe date when the response was received.

Return to Top

ContactContactTypeMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
categoryStringFalseNoThe category associated with the record or item, such as product category or service type.

Return to Top

contactrole 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record.
descriptionStringFalseNoA brief description of the record or entity.
externalidStringFalseNoA unique external identifier for referencing the record in external systems.
isinactiveBooleanFalseNoIndicates whether the record is currently inactive.

Return to Top

ContactSubscriptionMessageHistory 

NameTypeReadOnlyReferencesFilterOnlyDescription
emailStringFalseNoThe email address associated with the message or recipient.
memoStringFalseNoA memo or note associated with the message or communication.
recipientStringFalseNoThe recipient of the message or communication.
senddateDateFalseNoThe date when the message was sent.
senderStringFalseNoThe sender of the message or communication.

Return to Top

ContactSubscriptions 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoThe entity (for example, customer, lead, or partner) associated with the subscription.
lastmodifieddateDateFalseNoThe date when the subscription or record was last modified.
subscriptionStringFalseNoThe specific campaign subscription associated with the entity.

Return to Top

ContactSubsidiaryRelationship 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record.
entityStringFalseNoThe entity associated with the record, such as customer, vendor, or partner.
externalidStringFalseNoA unique external identifier for referencing the record in external systems.
isprimarysubBooleanFalseNoIndicates whether this subsidiary is the primary subsidiary for the entity.
nameStringFalseNoThe name associated with the record.

Return to Top

controlTowerSourceType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier or key used to reference the record.

Return to Top

costcategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the record, such as a customer or vendor account.
externalidStringFalseNoA unique external identifier for referencing the record in external systems.
isinactiveBooleanFalseNoIndicates whether the record is currently inactive.
itemcosttypeStringFalseNoThe type of item cost, such as standard cost or average cost.
nameStringFalseNoThe name associated with the record or item.

Return to Top

CostCategoryType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier used to reference the internal record.

Return to Top

CostEstimateType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier used to reference the record.

Return to Top

CostingMethodType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier used internally to reference the record.

Return to Top

couponcode 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record.
codeStringFalseNoThe code associated with the promotion or record.
datesentDateFalseNoThe date when the promotion or message was sent.
externalidStringFalseNoA unique external identifier for referencing the record in external systems.
promotionStringFalseNoThe promotion associated with the record, typically used for marketing or sales campaigns.

Return to Top

CreditCardCharge 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the transaction or record.
balanceDecimalFalseNoThe current balance of the account or transaction.
classStringFalseNoThe classification or category of the transaction, such as department or project.
clearedBooleanFalseNoIndicates whether the transaction has been cleared.
cleareddateDatetimeFalseNoThe date and time when the transaction was cleared.
createddateDatetimeFalseNoThe date and time when the transaction was created.
currencyStringFalseNoThe currency used in the transaction.
currencynameStringFalseNoThe name of the currency used in the transaction.
currencysymbolStringFalseNoThe symbol of the currency used in the transaction.
customformStringFalseNoThe custom form used for the transaction.
departmentStringFalseNoThe department associated with the transaction.
entityStringFalseNoThe entity (customer, vendor, or partner) associated with the transaction.
entity_nexus_countryStringFalseNoThe country where the entity has a tax nexus.
entitynexusStringFalseNoThe tax nexus associated with the entity.
exchangerateDecimalFalseNoThe exchange rate used for currency conversion in the transaction.
externalidStringFalseNoA unique external identifier for referencing the transaction in external systems.
isbasecurrencyBooleanFalseNoIndicates whether the transaction is in the base currency.
lastmodifieddateDatetimeFalseNoThe date and time when the transaction was last modified.
locationStringFalseNoThe location associated with the transaction.
memoStringFalseNoA memo or note associated with the transaction.
nexusStringFalseNoThe tax nexus associated with the transaction.
nexus_countryStringFalseNoThe country associated with the nexus for tax purposes.
postingperiodStringFalseNoThe accounting period in which the transaction was posted.
subsidiaryStringFalseNoThe subsidiary associated with the transaction.
taxperiodStringFalseNoThe tax period associated with the transaction.
taxpointdateDatetimeFalseNoThe date when tax liability arises for the transaction.
taxpointdateoverrideBooleanFalseNoIndicates whether the tax point date has been manually overridden.
totalDecimalFalseNoThe total amount of the transaction, including taxes and fees.
trandateDatetimeFalseNoThe date when the transaction was recorded.
tranidStringFalseNoThe unique identifier assigned to the transaction.
transactionnumberStringFalseNoThe transaction number associated with the record.
trantypeStringFalseNoThe type of transaction, such as sale, purchase, or refund.
updatecurrencyStringFalseNoThe currency used for updating the transaction.
usertotalDecimalFalseNoThe total amount calculated by the user for the transaction.

Return to Top

CreditCardChargeExpenseMachine 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the transaction or record.
categoryStringFalseNoThe category assigned to the transaction or record, such as office supplies or utilities.
classStringFalseNoThe classification of the transaction, such as department or project.
creditcardchargeStringFalseNoThe charge associated with the credit card transaction.
customerStringFalseNoThe customer associated with the transaction or record.
departmentStringFalseNoThe department responsible for the transaction or record.
expenseitemIntegerFalseNoThe expense item number associated with the transaction.
grossamtDecimalFalseNoThe total gross amount of the transaction before any deductions.
isbillableBooleanFalseNoIndicates whether the transaction is billable to a customer.
lineIntegerFalseNoThe line number associated with the transaction or record.
locationStringFalseNoThe location where the transaction or record was made.
memoStringFalseNoA memo or note providing additional details about the transaction.

Return to Top

CreditCardRefund 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the transaction or record.
balanceDecimalFalseNoThe current balance of the account or transaction.
classStringFalseNoThe classification or category of the transaction, such as department or project.
clearedBooleanFalseNoIndicates whether the transaction has been cleared.
cleareddateDatetimeFalseNoThe date and time when the transaction was cleared.
createddateDatetimeFalseNoThe date and time when the transaction was created.
currencyStringFalseNoThe currency used in the transaction.
currencynameStringFalseNoThe name of the currency used in the transaction.
currencysymbolStringFalseNoThe symbol of the currency used in the transaction.
customformStringFalseNoThe custom form used for the transaction.
departmentStringFalseNoThe department associated with the transaction.
entityStringFalseNoThe entity (customer, vendor, or partner) associated with the transaction.
entity_nexus_countryStringFalseNoThe country where the entity has a tax nexus.
entitynexusStringFalseNoThe tax nexus associated with the entity.
exchangerateDecimalFalseNoThe exchange rate used for currency conversion in the transaction.
externalidStringFalseNoA unique external identifier for referencing the transaction in external systems.
isbasecurrencyBooleanFalseNoIndicates whether the transaction is in the base currency.
lastmodifieddateDatetimeFalseNoThe date and time when the transaction was last modified.
locationStringFalseNoThe location associated with the transaction.
memoStringFalseNoA memo or note associated with the transaction.
nexusStringFalseNoThe tax nexus associated with the transaction.
nexus_countryStringFalseNoThe country associated with the tax nexus for the transaction.
postingperiodStringFalseNoThe accounting period during which the transaction was posted.
subsidiaryStringFalseNoThe subsidiary associated with the transaction.
taxperiodStringFalseNoThe tax period associated with the transaction.
taxpointdateDatetimeFalseNoThe date when tax liability arises for the transaction.
taxpointdateoverrideBooleanFalseNoIndicates whether the tax point date has been manually overridden.
totalDecimalFalseNoThe total amount of the transaction, including taxes and fees.
trandateDatetimeFalseNoThe date when the transaction was recorded.
tranidStringFalseNoThe unique identifier assigned to the transaction.
transactionnumberStringFalseNoThe transaction number associated with the record.
trantypeStringFalseNoThe type of transaction, such as sale, purchase, or refund.
updatecurrencyStringFalseNoThe currency used for updating the transaction.
usertotalDecimalFalseNoThe total amount calculated by the user for the transaction.

Return to Top

CreditCardRefundExpenseMachine 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the transaction or record.
categoryStringFalseNoThe category assigned to the transaction or record, such as office supplies or utilities.
classStringFalseNoThe classification of the transaction, such as department or project.
creditcardrefundStringFalseNoThe refund associated with the credit card transaction.
customerStringFalseNoThe customer associated with the transaction or record.
departmentStringFalseNoThe department responsible for the transaction or record.
expenseitemIntegerFalseNoThe expense item number associated with the transaction.
grossamtDecimalFalseNoThe total gross amount of the transaction before any deductions.
isbillableBooleanFalseNoIndicates whether the transaction is billable to a customer.
lineIntegerFalseNoThe line number associated with the transaction or record.
locationStringFalseNoThe location where the transaction or record was made.
memoStringFalseNoA memo or note providing additional details about the transaction.

Return to Top

Creditholdoverridetype 

NameTypeReadOnlyReferencesFilterOnlyDescription
isinactiveBooleanFalseNoIndicates whether the record is currently inactive.
keyStringFalseNoA unique identifier or key used to reference the record.

Return to Top

creditmemo 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the transaction or record.
althandlingcostDecimalFalseNoThe alternative handling cost applied to the transaction.
altshippingcostDecimalFalseNoThe alternative shipping cost associated with the transaction.
amountpaidDecimalFalseNoThe total amount paid toward the transaction.
amountremainingDecimalFalseNoThe remaining amount to be paid for the transaction.
appliedDecimalFalseNoThe amount that has been applied to the transaction.
autoapplyBooleanFalseNoIndicates whether the transaction is automatically applied to an account.
balanceDecimalFalseNoThe remaining balance of the transaction.
billaddressStringFalseNoThe billing address associated with the transaction.
billaddresslistStringFalseNoA list of billing addresses associated with the transaction.
billingaddressStringFalseNoThe primary billing address used in the transaction.
billisresidentialStringFalseNoIndicates whether the billing address is residential.
bulkprocsubmissionStringFalseNoThe bulk processing submission associated with the transaction.
classStringFalseNoThe classification of the transaction, such as department or project.
consolidatebalanceDecimalFalseNoThe consolidated balance of the transaction.
couponcodeStringFalseNoThe coupon code applied to the transaction.
createddateDatetimeFalseNoThe date and time when the transaction was created.
createdfromStringFalseNoThe origin of the transaction, such as the source or reference.
currencyStringFalseNoThe currency used for the transaction.
currencynameStringFalseNoThe name of the currency used in the transaction.
currencysymbolStringFalseNoThe symbol of the currency used in the transaction.
customformStringFalseNoThe custom form associated with the transaction.
deferredrevenueDecimalFalseNoThe amount of revenue that has been deferred to a later date.
departmentStringFalseNoThe department associated with the transaction.
discountitemStringFalseNoThe discount item applied to the transaction.
discountrateStringFalseNoThe rate of discount applied to the transaction.
discounttotalDecimalFalseNoThe total amount of discount applied to the transaction.
emailStringFalseNoThe email address associated with the transaction.
entityStringFalseNoThe entity (such as customer or vendor) associated with the transaction.
entitynexusStringFalseNoThe tax nexus associated with the entity for the transaction.
entitytaxregnumStringFalseNoThe tax registration number of the entity.
estgrossprofitDecimalFalseNoThe estimated gross profit from the transaction.
estgrossprofitpercentStringFalseNoThe percentage of estimated gross profit for the transaction.
exchangerateDecimalFalseNoThe exchange rate used to convert the transaction into the base currency.
excludecommissionBooleanFalseNoIndicates whether the transaction is excluded from commission calculations.
externalidStringFalseNoA unique external identifier for referencing the transaction in external systems.
handlingcostDecimalFalseNoThe total handling cost associated with the transaction.
handlingtax1rateStringFalseNoThe first handling tax rate applied to the transaction.
handlingtaxcodeStringFalseNoThe handling tax code used for the transaction.
isbasecurrencyBooleanFalseNoIndicates whether the transaction is in the base currency.
ismultishiptoBooleanFalseNoIndicates whether the transaction has multiple shipping addresses.
istaxableBooleanFalseNoIndicates whether the transaction is subject to tax.
lastmodifieddateDatetimeFalseNoThe date and time when the transaction was last modified.
leadsourceStringFalseNoThe source from which the lead for the transaction originated.
locationStringFalseNoThe location associated with the transaction.
memoStringFalseNoA memo or note providing additional details about the transaction.
messageStringFalseNoThe message associated with the transaction.
messageselStringFalseNoThe selected message for the transaction.
muccpromocodeinstanceStringFalseNoThe specific instance of the promotional code applied to the transaction.
nexusStringFalseNoThe tax nexus associated with the transaction.
otherrefnumStringFalseNoAn additional reference number associated with the transaction.
partnerStringFalseNoThe partner associated with the transaction.
postingperiodStringFalseNoThe accounting period in which the transaction is recorded.
promocodeStringFalseNoThe promotional code applied to the transaction.
promocodepluginimplStringFalseNoThe implementation of the promotional code plugin used.
recognizedrevenueDecimalFalseNoThe recognized revenue from the transaction.
revenuestatusStringFalseNoThe status of the revenue recognition for the transaction.
revreconrevcommitmentBooleanFalseNoIndicates whether revenue recognition commitment applies to the transaction.
saleseffectivedateDateFalseNoThe effective date of the sales transaction.
salesgroupStringFalseNoThe sales group associated with the transaction.
salesrepStringFalseNoThe sales representative associated with the transaction.
shipaddressStringFalseNoThe shipping address associated with the transaction.
shipaddresslistStringFalseNoA list of shipping addresses associated with the transaction.
shipisresidentialStringFalseNoIndicates whether the shipping address is residential.
shipmethodStringFalseNoThe shipping method used for the transaction.
shipoverrideStringFalseNoThe override status for shipping instructions.
shippingaddressStringFalseNoThe primary shipping address for the transaction.
shippingcostDecimalFalseNoThe total shipping cost for the transaction.
shippingcostoverriddenStringFalseNoIndicates whether the shipping cost has been overridden.
shippingtax1rateStringFalseNoThe first shipping tax rate applied to the transaction.
shippingtaxcodeStringFalseNoThe shipping tax code used for the transaction.
sourceStringFalseNoThe source of the transaction or order.
statusStringFalseNoThe current status of the transaction.
statusrefStringFalseNoThe reference for the current status of the transaction.
subsidiaryStringFalseNoThe subsidiary associated with the transaction.
subsidiarytaxregnumStringFalseNoThe tax registration number of the subsidiary.
subtotalDecimalFalseNoThe subtotal of the transaction before taxes and discounts.
syncpartnerteamsBooleanFalseNoIndicates whether partner teams are synchronized for the transaction.
syncsalesteamsBooleanFalseNoIndicates whether sales teams are synchronized for the transaction.
taxdetailsoverrideBooleanFalseNoIndicates whether tax details have been overridden for the transaction.
taxitemStringFalseNoThe tax item associated with the transaction.
taxpointdateDateFalseNoThe tax point date for the transaction.
taxpointdateoverrideBooleanFalseNoIndicates whether the tax point date has been manually overridden.
taxrateDoubleFalseNoThe tax rate applied to the transaction.
taxregoverrideBooleanFalseNoIndicates whether tax registration has been overridden for the transaction.
taxtotalDecimalFalseNoThe total tax applied to the transaction.
tobeemailedBooleanFalseNoIndicates whether the transaction is marked to be emailed.
tobefaxedBooleanFalseNoIndicates whether the transaction is marked to be faxed.
tobeprintedBooleanFalseNoIndicates whether the transaction is marked to be printed.
totalDecimalFalseNoThe total amount of the transaction, including taxes and fees.
totalcostestimateDecimalFalseNoThe estimated total cost of the transaction.
trandateDateFalseNoThe date when the transaction was recorded.
tranidStringFalseNoThe unique identifier assigned to the transaction.
tranisvsoebundleBooleanFalseNoIndicates whether the transaction is part of a Vendor-Specific Objective Evidence (VSOE) bundle.
unappliedDecimalFalseNoThe unapplied amount of the transaction.
unbilledordersDecimalFalseNoThe total value of unbilled orders associated with the transaction.
vsoeautocalcBooleanFalseNoIndicates whether the VSOE auto-calculation applies to the transaction.

Return to Top

creditMemoBillingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique key identifier for the address record.
addr1StringFalseNoThe primary address line, typically including the street name and number.
addr2StringFalseNoThe secondary address line, used for apartment, suite, or building details.
addr3StringFalseNoThe tertiary address line, if applicable.
addresseeStringFalseNoThe name of the recipient or business associated with the address.
attentionStringFalseNoThe name of the person to whom the address is specifically directed.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country associated with the address.
dropdownstateStringFalseNoThe state or province selected from a dropdown list.
overrideBooleanFalseNoIndicates whether the address details were manually overridden.
stateStringFalseNoThe state or province associated with the address.

Return to Top

creditMemoItemShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique key identifier for the address record.
addr1StringFalseNoThe primary address line, typically including the street name and number.
addr2StringFalseNoThe secondary address line, used for apartment, suite, or building details.
addr3StringFalseNoThe tertiary address line, if applicable.
addresseeStringFalseNoThe name of the recipient or business associated with the address.
attentionStringFalseNoThe name of the person to whom the address is specifically directed.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country associated with the address.
dropdownstateStringFalseNoThe state or province selected from a dropdown list.
overrideBooleanFalseNoIndicates whether the address details have been manually overridden.
stateStringFalseNoThe state or province associated with the address.

Return to Top

creditMemoPartner 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage contribution of the partner to the transaction or project.
isprimaryBooleanFalseNoIndicates whether the partner is the primary partner in the transaction or project.
partnerStringFalseNoThe name or identifier of the partner associated with the transaction or project.
partnerroleStringFalseNoThe role of the partner in the transaction or project, such as supplier or collaborator.

Return to Top

creditMemoSalesTeam 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage contribution of the employee to the sales or transaction.
employeeStringFalseNoThe name or identifier of the employee associated with the sales or transaction.
isprimaryBooleanFalseNoIndicates whether the employee is the primary contact or representative in the sales or transaction.
salesroleStringFalseNoThe sales role of the employee, such as sales manager, account executive, or support.

Return to Top

creditMemoShipGroup 

NameTypeReadOnlyReferencesFilterOnlyDescription
destinationaddressStringFalseNoThe shipping address where the items are to be delivered (Ship To).
docStringFalseNoThe document associated with the transaction or shipment.
handlingrateDecimalFalseNoThe rate charged for handling the shipment.
shippingmethodStringFalseNoThe method used for shipping, such as ground, air, or express (Ship Via).
shippingrateDecimalFalseNoThe rate charged for shipping the items.
sourceaddressStringFalseNoThe address from which the items are being shipped (Ship From).
uniquekeyIntegerFalseNoA unique identifier used to reference the record or transaction.

Return to Top

creditMemoShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique key identifier for the address record.
addr1StringFalseNoThe primary address line, typically including the street name and number.
addr2StringFalseNoThe secondary address line, used for apartment, suite, or building details.
addr3StringFalseNoThe tertiary address line, if applicable.
addresseeStringFalseNoThe name of the recipient or business associated with the address.
attentionStringFalseNoThe name of the person to whom the address is specifically directed.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country associated with the address.
dropdownstateStringFalseNoThe state or province selected from a dropdown list.
overrideBooleanFalseNoIndicates whether the address details have been manually overridden.
stateStringFalseNoThe state or province associated with the address.

Return to Top

creditMemoTranPromotion 

NameTypeReadOnlyReferencesFilterOnlyDescription
couponcodeStringFalseNoThe unique coupon code applied to the transaction for a discount.
promocodeStringFalseNoThe promotional code associated with the transaction or discount offer.
promotiontypeStringFalseNoThe type of promotion, such as percentage discount, fixed amount off, or free shipping.

Return to Top

CrmTemplateType 

NameTypeReadOnlyReferencesFilterOnlyDescription
defaultdescrStringFalseNoThe default description associated with the record or entity.
defaultmergedescrStringFalseNoThe default merged description, used when multiple records are combined.
defaultnameStringFalseNoThe default name assigned to the record or entity when no custom name is provided.
descrStringFalseNoA brief description of the record or entity.
keyStringFalseNoA unique identifier or key used to reference the record.
mergedescrStringFalseNoThe merged description, used when records are combined into a single entity.
nameStringFalseNoThe name associated with the record or entity.

Return to Top

currency 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the currency record.
currencyprecisionIntegerFalseNoThe precision (number of decimal places) used for the currency.
displaysymbolStringFalseNoThe symbol used to represent the currency.
exchangerateDecimalFalseNoThe default exchange rate for converting this currency to others.
externalidStringFalseNoA unique external identifier for referencing the currency in external systems.
includeinfxrateupdatesBooleanFalseNoIndicates whether the currency should automatically update its exchange rate.
isbasecurrencyBooleanFalseNoIndicates whether the currency is set as the base currency for conversions.
isinactiveBooleanFalseNoIndicates whether the currency record is inactive.
nameStringFalseNoThe name associated with the currency.
overridecurrencyformatBooleanFalseNoIndicates whether the default currency format should be overridden.
symbolStringFalseNoThe ISO code or symbol for the currency, such as USD for US Dollar.
symbolplacementStringFalseNoSpecifies where the currency symbol should appear, such as before or after the amount.

Return to Top

currencyrate 

NameTypeReadOnlyReferencesFilterOnlyDescription
basecurrencyStringFalseNoThe base currency used for conversions in the system.
effectivedateDateFalseNoThe date when the exchange rate becomes effective.
exchangerateDecimalFalseNoThe rate at which one currency can be exchanged for another.
transactioncurrencyStringFalseNoThe currency used in the transaction or record.

Return to Top

CurrencyRateType 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record.
descriptionStringFalseNoA brief description of the record or entity.
externalidStringFalseNoA unique external identifier for referencing the record in external systems.
isdefaultBooleanFalseNoIndicates whether the record is set as the default.
isinactiveBooleanFalseNoIndicates whether the record is currently inactive.

Return to Top

CurrencySymbolPlacement 

NameTypeReadOnlyReferencesFilterOnlyDescription
defaultnameStringFalseNoThe default name assigned to the record or entity when no custom name is provided.
keyIntegerFalseNoA unique identifier or key used to reference the record.

Return to Top

customer 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record.
accountnumberStringFalseNoThe account number associated with the customer or entity.
alcoholrecipienttypeStringFalseNoThe type of recipient for alcohol-related transactions.
altemailStringFalseNoThe alternative email address for the customer or entity.
altnameStringFalseNoAn alternate name for the customer or entity.
assignedwebsiteStringFalseNoThe website assigned to the customer or entity.
balancesearchDecimalFalseNoThe balance associated with the customer or account.
billingratecardStringFalseNoThe billing rate card applied to the customer or account.
billingscheduleStringFalseNoThe billing schedule associated with the customer or account.
billingtransactiontypeStringFalseNoThe type of billing transaction, such as recurring or one-time.
billpayBooleanFalseNoIndicates whether online bill pay is enabled for the customer.
buyingreasonStringFalseNoThe reason for the customer's purchase, such as business need or promotion.
buyingtimeframeStringFalseNoThe time frame in which the customer plans to make a purchase.
campaigneventStringFalseNoThe campaign event associated with the customer or entity.
categoryStringFalseNoThe category assigned to the customer or entity.
clickstreamStringFalseNoThe click-stream data from the first visit of the customer.
commentsStringFalseNoAdditional comments or notes related to the customer or entity.
companynameStringFalseNoThe name of the company associated with the customer.
consolbalancesearchDecimalFalseNoThe consolidated balance across all related entities.
consoldaysoverduesearchIntegerFalseNoThe consolidated days overdue for all related entities.
consoloverduebalancesearchDecimalFalseNoThe consolidated overdue balance across all related entities.
consolunbilledorderssearchDecimalFalseNoThe consolidated unbilled orders across all related entities.
contactStringFalseNoThe primary contact for the customer or entity.
contactlistStringFalseNoA list of all contacts associated with the customer or entity.
creditholdoverrideStringFalseNoIndicates any override to the credit hold status for the customer.
creditlimitDecimalFalseNoThe credit limit associated with the customer or account.
currencyStringFalseNoThe currency associated with the customer or transaction.
datecreatedDateFalseNoThe date the customer or entity record was created.
defaultbankaccountStringFalseNoThe default bank account associated with the customer.
defaultbillingaddressStringFalseNoThe default billing address for the customer.
defaultorderpriorityDoubleFalseNoThe default order priority assigned to the customer.
defaultshippingaddressStringFalseNoThe default shipping address for the customer.
duplicateBooleanFalseNoIndicates whether the customer record is a duplicate.
emailStringFalseNoThe primary email address associated with the customer.
emailpreferenceStringFalseNoThe preferred email communication method for the customer.
emailtransactionsBooleanFalseNoIndicates whether email notifications are sent for transactions.
enddateDateFalseNoThe end date of the customer's current term or contract.
entityidStringFalseNoThe unique identifier for the entity, such as customer ID.
entitynumberIntegerFalseNoThe numerical identifier for the entity.
entitystatusStringFalseNoThe current status of the entity, such as active or inactive.
entitytitleStringFalseNoThe title associated with the entity, such as customer ID.
estimatedbudgetDecimalFalseNoThe estimated budget for the customer or entity.
externalidStringFalseNoThe external identifier for referencing the customer or entity.
faxtransactionsBooleanFalseNoIndicates whether fax notifications are sent for transactions.
firstnameStringFalseNoThe first name of the customer or contact.
firstorderdateDateFalseNoThe date of the customer's first sales order.
firstsaledateDateFalseNoThe date of the customer's first sale.
firstvisitDateFalseNoThe date of the customer's first visit.
giveaccessBooleanFalseNoIndicates whether the customer has access to online portals.
globalsubscriptionstatusStringFalseNoThe global subscription status for the customer.
isbudgetapprovedBooleanFalseNoIndicates whether the customer's budget has been approved.
isinactiveBooleanFalseNoIndicates whether the customer or entity is inactive.
ispersonBooleanFalseNoIndicates whether the entity is an individual person.
keywordsStringFalseNoThe search engine keywords used during the customer's first visit.
lastmodifieddateDateFalseNoThe date the customer or entity record was last modified.
lastnameStringFalseNoThe last name of the customer or contact.
lastorderdateDateFalseNoThe date of the customer's last sales order.
lastpagevisitedStringFalseNoThe last page the customer visited on the website.
lastsaledateDateFalseNoThe date of the customer's most recent sale.
lastvisitDateFalseNoThe date of the customer's most recent visit.
leadsourceStringFalseNoThe source from which the lead originated, such as referral or campaign.
middlenameStringFalseNoThe middle name of the customer or contact.
negativenumberformatStringFalseNoThe format used for displaying negative numbers.
numberformatStringFalseNoThe format used for displaying numbers.
oncreditholdBooleanFalseNoIndicates whether the customer is currently on credit hold.
overduebalancesearchDecimalFalseNoThe overdue balance associated with the customer.
parentStringFalseNoThe parent entity or account associated with the customer.
partnerStringFalseNoThe partner associated with the customer or entity.
phoneticnameStringFalseNoThe phonetic version of the customer's name, often used for pronunciation.
prefccprocessorStringFalseNoThe preferred credit card processing profile for the customer.
pricelevelStringFalseNoThe price level applied to the customer's purchases.
printoncheckasStringFalseNoThe name printed on checks for the customer.
printtransactionsBooleanFalseNoIndicates whether transaction records should be printed.
probabilityDoubleFalseNoThe probability of closing the sale or transaction.
receivablesaccountStringFalseNoThe account used for receivables associated with the customer.
referrerStringFalseNoThe referrer from the customer's first visit to the website.
reminderdaysIntegerFalseNoThe number of days before a reminder is sent to the customer.
resalenumberStringFalseNoThe resale number associated with the customer.
salesreadinessStringFalseNoThe customer's readiness for sales or a transaction.
salesrepStringFalseNoThe sales representative associated with the customer.
salutationStringFalseNoThe salutation used for the customer, such as Mr., Ms., or Dr.
searchstageStringFalseNoThe stage in the search or sales process.
shipcompleteBooleanFalseNoIndicates whether the order should be shipped completely or partially.
shippingcarrierStringFalseNoThe carrier responsible for shipping the items.
shippingitemStringFalseNoThe item being shipped.
sourcewebsiteStringFalseNoThe source website from which the customer originated.
startdateDateFalseNoThe start date of the customer's contract or relationship.
termsStringFalseNoThe payment terms associated with the customer.
territoryStringFalseNoThe sales territory associated with the customer.
thirdpartyacctStringFalseNoThe third-party billing account number associated with the customer.
thirdpartycarrierStringFalseNoThe third-party billing carrier for the customer.
thirdpartycountryStringFalseNoThe third-party billing country associated with the customer.
thirdpartyzipcodeStringFalseNoThe third-party billing zip code for the customer.
titleStringFalseNoThe job title of the customer or contact.
unbilledorderssearchDecimalFalseNoThe unbilled orders associated with the customer.
visitsIntegerFalseNoThe number of visits the customer has made.

Return to Top

customerAddressbook 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoThe unique internal identifier for the address record.
addressbookaddressStringFalseNoThe address associated with the address book entry.
defaultbillingBooleanFalseNoIndicates whether this is the default billing address for the entity.
defaultshippingBooleanFalseNoIndicates whether this is the default shipping address for the entity.
entityStringFalseNoThe entity (for example, customer, vendor, or partner) associated with the address.
labelStringFalseNoThe label or name assigned to the address record for easy identification.

Return to Top

customerAddressbookEntityAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique key identifier for the address record.
addr1StringFalseNoThe primary address line, typically including the street name and number.
addr2StringFalseNoThe secondary address line, used for apartment, suite, or building details.
addr3StringFalseNoThe tertiary address line, if applicable.
addresseeStringFalseNoThe name of the recipient or business associated with the address.
attentionStringFalseNoThe name of the person to whom the address is specifically directed.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country associated with the address.
dropdownstateStringFalseNoThe state or province selected from a dropdown list.
overrideBooleanFalseNoIndicates whether the address details have been manually overridden.
stateStringFalseNoThe state or province associated with the address.
zipStringFalseNoThe postal code (zip code) associated with the address.
addrphoneStringFalseNoThe phone number associated with the address.

Return to Top

customerBulkMerge 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoThe entity associated with the merge, such as customer or lead.
mergedateDateFalseNoThe date and time when the merge was performed.
mergetypeStringFalseNoThe type of merge, such as manual or automatic.
statusStringFalseNoThe current status of the merge, such as pending, completed, or failed.
subjectStringFalseNoThe subject or title associated with the merge.
templateStringFalseNoThe template used for the merge process.
usernameStringFalseNoThe username of the person who initiated the merge.

Return to Top

customerCampaigns 

NameTypeReadOnlyReferencesFilterOnlyDescription
campaignStringFalseNoThe campaign associated with the response.
campaigneventStringFalseNoThe specific event within the campaign related to the response.
categoryStringFalseNoThe category of the response, such as positive, negative, or neutral.
contactStringFalseNoThe contact associated with the response.
datesentDateFalseNoThe date when the response was sent.
entityStringFalseNoThe entity (for example, customer, lead, or partner) associated with the response.
responseStringFalseNoThe detailed content of the response.
responsedateDateFalseNoThe date when the response was received or recorded.

Return to Top

customercategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
externalidStringFalseNoA unique identifier for referencing the customer in external systems.
isinactiveBooleanFalseNoIndicates whether the customer record is inactive.
nameStringFalseNoThe name of the customer or business.

Return to Top

customerCompanyContact 

NameTypeReadOnlyReferencesFilterOnlyDescription
contactStringFalseNoThe primary contact associated with the customer or entity.

Return to Top

customerContactRole 

NameTypeReadOnlyReferencesFilterOnlyDescription
contactStringFalseNoThe list of contacts associated with the customer or entity.
emailStringFalseNoThe email address associated with the contact or entity.
entityStringFalseNoThe entity (for example, customer, lead, partner) associated with the contact.
giveaccessBooleanFalseNoIndicates whether the contact or entity is granted access to a specific system or resource.

Return to Top

customerCurrencyBalance 

NameTypeReadOnlyReferencesFilterOnlyDescription
balanceDecimalFalseNoThe current balance of the account or transaction.
consolbalanceDecimalFalseNoThe consolidated balance, combining all related accounts or transactions.
consoldepositbalanceDecimalFalseNoThe consolidated balance of deposits across all related accounts.
consoloverduebalanceDecimalFalseNoThe consolidated overdue balance, combining all overdue amounts from related accounts.
consolunbilledordersDecimalFalseNoThe total of unbilled orders across all related accounts or entities.
currencyStringFalseNoThe currency used in the transaction or account.
customerStringFalseNoThe customer associated with the account or transaction.
depositbalanceDecimalFalseNoThe balance of deposits in the account.
overduebalanceDecimalFalseNoThe overdue balance that remains unpaid beyond the due date.
overridecurrencyformatBooleanFalseNoIndicates whether the default currency format should be overridden for this record.

Return to Top

customerdeposit 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the transaction or record.
allowemptycardsBooleanFalseNoIndicates whether empty cards are allowed for processing.
authcodeStringFalseNoThe authorization code provided for the transaction.
ccapprovedBooleanFalseNoIndicates whether the credit card transaction is approved.
ccavsstreetmatchStringFalseNoThe address verification service (AVS) street address match status.
ccavszipmatchStringFalseNoThe AVS ZIP code match status.
ccexpiredateStringFalseNoThe expiration date of the credit card.
ccholdStringFalseNoThe status of the credit card hold.
ccholdetailsStringFalseNoDetails regarding the credit card hold.
cciavsmatchStringFalseNoThe result of the credit card issuer AVS check.
ccispurchasecardbinBooleanFalseNoIndicates whether the card is a purchase card (BIN).
ccnameStringFalseNoThe name of the cardholder.
ccnumberStringFalseNoThe credit card number.
ccprocessoraccountStringFalseNoThe account number used by the credit card processor.
ccsecuritycodeStringFalseNoThe credit card security code (CSC).
ccsecuritycodematchStringFalseNoThe result of the CSC match check.
ccstreetStringFalseNoThe street address associated with the credit card.
cczipcodeStringFalseNoThe ZIP code associated with the credit card.
chargeitBooleanFalseNoIndicates whether the charge was successfully processed.
checknumStringFalseNoThe check number associated with the transaction.
checknumberStringFalseNoThe check number used for the payment.
classStringFalseNoThe class or category associated with the transaction.
clearedBooleanFalseNoIndicates whether the transaction has been cleared.
cleareddateDateFalseNoThe date when the transaction was cleared.
createddateDatetimeFalseNoThe date and time when the transaction or record was created.
creditcardStringFalseNoThe credit card type used for the transaction.
creditcardprocessorStringFalseNoThe processor handling the credit card transaction.
currencyStringFalseNoThe currency used in the transaction.
currencynameStringFalseNoThe name of the currency used in the transaction.
currencysymbolStringFalseNoThe symbol of the currency used in the transaction.
customerStringFalseNoThe customer associated with the transaction.
customercodeStringFalseNoThe unique code assigned to the customer.
customformStringFalseNoThe custom form used for the transaction.
debitcardissuenoStringFalseNoThe debit card issue number.
departmentStringFalseNoThe department associated with the transaction.
dynamicdescriptorStringFalseNoA dynamic descriptor used for transaction details.
entitynexusStringFalseNoThe tax nexus related to the entity in the transaction.
exchangerateDecimalFalseNoThe exchange rate applied to the transaction.
externalidStringFalseNoA unique external identifier for the transaction or record.
handlingmodeStringFalseNoThe mode of handling applied to the transaction.
ignoreavsBooleanFalseNoIndicates whether AVS checks are ignored for the transaction.
ignorecscBooleanFalseNoIndicates whether card security code (CSC) checks are ignored for the transaction.
inputauthcodeStringFalseNoThe input authorization code provided for the transaction.
inputpnrefnumStringFalseNoThe input reference number for the transaction.
inputreferencecodeStringFalseNoThe input reference code for the transaction.
isbasecurrencyBooleanFalseNoIndicates whether the transaction is conducted in the base currency.
ispurchasecardStringFalseNoIndicates whether the transaction is processed with a purchase card.
isrecurringpaymentBooleanFalseNoIndicates whether the payment is recurring.
lastmodifieddateDatetimeFalseNoThe date and time when the transaction or record was last modified.
locationStringFalseNoThe location associated with the transaction.
memoStringFalseNoA memo or note associated with the transaction.
nexusStringFalseNoThe tax nexus information for the transaction.
outputauthcodeStringFalseNoThe output authorization code received after processing.
outputreferencecodeStringFalseNoThe output reference code received after processing.
overrideholdBooleanFalseNoIndicates whether the credit hold status has been manually overridden.
overrideholdcheckedBooleanFalseNoIndicates whether the override of credit hold has been checked.
paymentStringFalseNoThe payment type used for the transaction.
paymentcardcscStringFalseNoThe CSC used in the transaction.
paymenteventdateDatetimeFalseNoThe date and time when the payment event occurred.
paymenteventholdreasonStringFalseNoThe reason for holding the payment event.
paymenteventpurchasedatasentStringFalseNoIndicates whether purchase data was sent for the payment event.
paymenteventresultStringFalseNoThe result of the payment event, such as success or failure.
paymenteventtypeStringFalseNoThe type of payment event, such as authorization or capture.
paymenteventupdatedbyStringFalseNoThe user or system that updated the payment event.
paymentmethodStringFalseNoThe method of payment used for the transaction.
paymentoperationStringFalseNoThe operation type for the payment, such as refund or charge.
paymentoptionStringFalseNoThe payment option chosen for the transaction.
paymentprocessingprofileStringFalseNoThe profile used for processing the payment.
pnrefnumStringFalseNoThe reference number associated with the payment transaction.
postingperiodStringFalseNoThe posting period for the transaction.
salesorderStringFalseNoThe sales order associated with the transaction.
salesorderrequireddepositdueStringFalseNoThe required deposit due for the sales order.
softdescriptorStringFalseNoThe soft descriptor used in the transaction's description.
statusStringFalseNoThe current status of the transaction or payment.
statusRefStringFalseNoA reference to the status of the transaction.
subsidiaryStringFalseNoThe subsidiary associated with the transaction.
threedstatuscodeStringFalseNoThe 3D Secure status code for the transaction.
tobeemailedBooleanFalseNoIndicates whether the transaction is marked to be emailed.
trandateDateFalseNoThe date when the transaction occurred.
tranidStringFalseNoThe unique transaction identifier.
undepfundsStringFalseNoThe funds that have not been deposited for the transaction.
validfromStringFalseNoThe date from which the transaction or record is valid.

Return to Top

customerEftAcct 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the bank account record.
accountnumberStringFalseNoThe account number associated with the bank account.
banknameStringFalseNoThe name of the bank holding the account.
customerStringFalseNoThe customer associated with the bank account.
idnumberStringFalseNoThe unique identification number for the bank account, such as a bank identifier.
isinactiveBooleanFalseNoIndicates whether the bank account is inactive.
issavingsBooleanFalseNoIndicates whether the account is a savings account.
limitDecimalFalseNoThe credit or withdrawal limit for the account.
routingnumberStringFalseNoThe routing number of the bank, used for wire transfers and direct deposits.

Return to Top

CustomerGroupPricing 

NameTypeReadOnlyReferencesFilterOnlyDescription
customerStringFalseNoThe customer associated with the record, such as a client, account holder, or business.

Return to Top

customerItemPricing 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencyStringFalseNoThe currency used for the transaction or account.
customerStringFalseNoThe customer associated with the record, such as a client or account holder.
itemStringFalseNoThe item or product associated with the transaction or order.

Return to Top

customermessage 

NameTypeReadOnlyReferencesFilterOnlyDescription
externalidStringFalseNoA unique identifier used to reference the customer message in external systems.
isinactiveBooleanFalseNoIndicates whether the customer message is inactive.
nameStringFalseNoThe name or title of the customer message.

Return to Top

CustomerPartner 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage contribution of the customer or partner to the job or transaction.
customerStringFalseNoThe customer or job associated with the transaction.
partnerStringFalseNoThe partner involved in the job or transaction.
partnerroleStringFalseNoThe role of the partner in the job or transaction, such as supplier or collaborator.

Return to Top

customerpayment 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the transaction.
allowemptycardsBooleanFalseNoIndicates whether empty credit cards are allowed in the transaction.
appliedDecimalFalseNoThe amount that has been applied to the account or transaction.
aracctStringFalseNoThe accounts receivable account associated with the transaction.
authcodeStringFalseNoThe authorization code for the credit card transaction.
autoapplyBooleanFalseNoIndicates whether the system should automatically apply payments.
balanceDecimalFalseNoThe current balance of the account or transaction.
ccapprovedBooleanFalseNoIndicates whether the credit card transaction is approved.
ccavsstreetmatchStringFalseNoThe match status for the address verification service (AVS) street verification.
ccavszipmatchStringFalseNoThe match status for the AVS ZIP code verification.
ccexpiredateStringFalseNoThe expiration date of the credit card.
ccholdStringFalseNoIndicates whether the credit card is on hold.
ccholdetailsStringFalseNoDetails regarding the credit card hold.
cciavsmatchStringFalseNoThe result of the issuer AVS check.
ccispurchasecardbinBooleanFalseNoIndicates whether the card is identified as a purchase card.
ccnameStringFalseNoThe cardholder's name.
ccnumberStringFalseNoThe credit card number used in the transaction.
ccprocessoraccountStringFalseNoThe account number with the credit card processor.
ccsecuritycodeStringFalseNoThe credit card security code (CSC).
ccsecuritycodematchStringFalseNoThe result of the CSC verification.
ccstreetStringFalseNoThe street address associated with the credit card.
cczipcodeStringFalseNoThe ZIP code associated with the credit card.
chargeitBooleanFalseNoIndicates whether the charge was successfully processed.
checknumStringFalseNoThe check number associated with the payment.
checknumberStringFalseNoThe number of the check used for payment.
classStringFalseNoThe class or category associated with the transaction.
clearedBooleanFalseNoIndicates whether the transaction has cleared.
cleareddateDateFalseNoThe date when the transaction was cleared.
consolidatebalanceDecimalFalseNoThe consolidated balance from multiple accounts or transactions.
createddateDatetimeFalseNoThe date and time when the transaction or record was created.
creditcardStringFalseNoThe type of credit card used in the transaction.
creditcardprocessorStringFalseNoThe processor handling the credit card transaction.
currencyStringFalseNoThe currency used in the transaction.
currencynameStringFalseNoThe name of the currency used in the transaction.
currencysymbolStringFalseNoThe symbol of the currency used in the transaction.
customerStringFalseNoThe customer associated with the transaction.
customercodeStringFalseNoThe unique code assigned to the customer.
customformStringFalseNoThe custom form associated with the transaction.
debitcardissuenoStringFalseNoThe issue number of the debit card used in the transaction.
departmentStringFalseNoThe department associated with the transaction.
dynamicdescriptorStringFalseNoA dynamic descriptor describing the transaction for the cardholder.
entitynexusStringFalseNoThe tax nexus associated with the entity in the transaction.
exchangerateDecimalFalseNoThe exchange rate applied to the transaction.
externalidStringFalseNoAn external identifier for referencing the transaction in other systems.
handlingmodeStringFalseNoThe handling mode for the transaction (for example, manual or automatic).
ignoreavsBooleanFalseNoIndicates whether the AVS check is ignored.
ignorecscBooleanFalseNoIndicates whether the CSC check is ignored.
inputauthcodeStringFalseNoThe input authorization code provided for the transaction.
inputpnrefnumStringFalseNoThe input reference number for the transaction.
inputreferencecodeStringFalseNoThe input reference code for the transaction.
isbasecurrencyBooleanFalseNoIndicates whether the transaction is conducted in the base currency.
ispurchasecardStringFalseNoIndicates whether the transaction is processed with a purchase card.
isrecurringpaymentBooleanFalseNoIndicates whether the payment is recurring.
lastmodifieddateDatetimeFalseNoThe date and time when the transaction or record was last modified.
locationStringFalseNoThe location associated with the transaction.
memoStringFalseNoA memo or note associated with the transaction.
nexusStringFalseNoThe tax nexus information for the transaction.
outputauthcodeStringFalseNoThe output authorization code provided after processing.
outputreferencecodeStringFalseNoThe output reference code generated after processing.
overrideholdBooleanFalseNoIndicates whether the credit hold status has been manually overridden.
overrideholdcheckedBooleanFalseNoIndicates whether the override of credit hold has been checked.
paymentStringFalseNoThe type of payment method used in the transaction.
paymentcardcscStringFalseNoThe CSC used in the transaction.
paymenteventdateDatetimeFalseNoThe date and time when the payment event occurred.
paymenteventholdreasonStringFalseNoThe reason for holding the payment event.
paymenteventpurchasedatasentStringFalseNoIndicates whether purchase data was sent during the payment event.
paymenteventresultStringFalseNoThe result of the payment event, such as success or failure.
paymenteventtypeStringFalseNoThe type of payment event (for example, authorization, capture, refund).
paymenteventupdatedbyStringFalseNoThe user or system that updated the payment event.
paymentmethodStringFalseNoThe method of payment used in the transaction (for example, credit card, PayPal).
paymentoperationStringFalseNoThe operation type for the payment (for example, charge, refund).
paymentoptionStringFalseNoThe specific payment option selected by the customer.
paymentprocessingprofileStringFalseNoThe profile used for processing the payment.
pendingDecimalFalseNoThe amount pending for payment or transaction.
pnrefnumStringFalseNoThe reference number associated with the payment.
postingperiodStringFalseNoThe posting period for the transaction.
softdescriptorStringFalseNoA soft descriptor used for the transaction's description.
statusStringFalseNoThe current status of the transaction.
statusrefStringFalseNoA reference to the status of the transaction.
subsidiaryStringFalseNoThe subsidiary associated with the transaction.
threedstatuscodeStringFalseNoThe 3D Secure status code for the transaction.
tobeemailedBooleanFalseNoIndicates whether the transaction is flagged to be emailed.
totalDecimalFalseNoThe total amount for the transaction.
trandateDateFalseNoThe date the transaction occurred.
tranidStringFalseNoThe unique identifier for the transaction.
unappliedDecimalFalseNoThe unapplied amount for the transaction.
undepfundsStringFalseNoThe funds that have not been deposited for the transaction.
validfromStringFalseNoThe date from which the transaction or record is valid.

Return to Top

customerpaymentauthorization 

NameTypeReadOnlyReferencesFilterOnlyDescription
allowemptycardsBooleanFalseNoIndicates whether empty credit cards are allowed in the transaction.
authcodeStringFalseNoThe authorization code for the credit card transaction.
ccapprovedBooleanFalseNoIndicates whether the credit card transaction was approved.
ccavsstreetmatchStringFalseNoThe result of the address verification service (AVS) street address match.
ccavszipmatchStringFalseNoThe result of the AVS ZIP code match.
ccexpiredateStringFalseNoThe expiration date of the credit card.
ccholdStringFalseNoIndicates whether the credit card is on hold.
ccholdetailsStringFalseNoDetails regarding the credit card hold.
cciavsmatchStringFalseNoThe result of the issuer AVS match.
ccnameStringFalseNoThe name of the credit card holder.
ccnumberStringFalseNoThe credit card number.
ccprocessoraccountStringFalseNoThe account number associated with the credit card processor.
ccsecuritycodeStringFalseNoThe credit card security code (CSC).
ccsecuritycodematchStringFalseNoThe result of the CSC match.
ccstreetStringFalseNoThe street address associated with the credit card.
cczipcodeStringFalseNoThe ZIP code associated with the credit card.
classStringFalseNoThe class or category associated with the transaction.
createddateDatetimeFalseNoThe date and time when the transaction or record was created.
creditcardStringFalseNoThe type of credit card used in the transaction.
creditcardprocessorStringFalseNoThe processor handling the credit card transaction.
currencyStringFalseNoThe currency used for the transaction.
currencynameStringFalseNoThe name of the currency used for the transaction.
currencysymbolStringFalseNoThe symbol representing the currency used in the transaction.
customerStringFalseNoThe customer associated with the transaction.
customercodeStringFalseNoThe unique code assigned to the customer.
customformStringFalseNoThe custom form used for the transaction.
debitcardissuenoStringFalseNoThe issue number of the debit card used for the transaction.
departmentStringFalseNoThe department associated with the transaction.
exchangerateDecimalFalseNoThe exchange rate applied to the transaction.
externalidStringFalseNoA unique identifier used to reference the transaction externally.
getauthBooleanFalseNoIndicates whether the transaction requires an authorization code.
ignoreavsBooleanFalseNoIndicates whether the AVS check is ignored.
ignorecscBooleanFalseNoIndicates whether the CSC check is ignored.
isbasecurrencyBooleanFalseNoIndicates whether the transaction is conducted in the base currency.
isrecurringpaymentBooleanFalseNoIndicates whether the payment is part of a recurring payment plan.
lastmodifieddateDatetimeFalseNoThe date and time when the transaction or record was last modified.
locationStringFalseNoThe location associated with the transaction.
memoStringFalseNoA memo or note associated with the transaction.
overrideholdBooleanFalseNoIndicates whether the credit hold status has been manually overridden.
overrideholdcheckedBooleanFalseNoIndicates whether the override of the credit hold has been checked.
paymentStringFalseNoThe type of payment used for the transaction.
paymenteventholdreasonStringFalseNoThe reason for holding the payment event.
paymenteventresultStringFalseNoThe result of the payment event (for example, success, failure).
paymentmethodStringFalseNoThe method of payment used in the transaction (for example, credit card, PayPal).
pnrefnumStringFalseNoThe reference number associated with the payment transaction.
redirecturlStringFalseNoThe URL to which the user is redirected after payment.
returnurlStringFalseNoThe URL to which the user returns after completing the payment process.
salesorderStringFalseNoThe sales order associated with the transaction.
subsidiaryStringFalseNoThe subsidiary associated with the transaction.
threedstatuscodeStringFalseNoThe 3D Secure status code for the transaction.
trandateDateFalseNoThe date on which the transaction occurred.
tranidStringFalseNoThe unique identifier for the transaction.
transactionnumberStringFalseNoThe number associated with the transaction.
updatecurrencyStringFalseNoThe currency to be used for the transaction update.
validfromStringFalseNoThe date from which the transaction or record is valid.

Return to Top

customerrefund 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the transaction or record.
allowemptycardsBooleanFalseNoIndicates whether empty credit cards are allowed in the transaction.
aracctStringFalseNoThe accounts receivable account associated with the transaction.
balanceDecimalFalseNoThe current balance of the account or transaction.
ccapprovedBooleanFalseNoIndicates whether the credit card transaction was approved.
ccexpiredateStringFalseNoThe expiration date of the credit card.
ccholdStringFalseNoIndicates whether the credit card is on hold.
ccholdetailsStringFalseNoDetails regarding the credit card hold.
ccispurchasecardbinBooleanFalseNoIndicates whether the card is identified as a purchase card.
ccnameStringFalseNoThe name of the cardholder associated with the credit card.
ccnumberStringFalseNoThe credit card number.
ccprocessoraccountStringFalseNoThe account number used by the credit card processor.
ccstreetStringFalseNoThe street address associated with the credit card.
cczipcodeStringFalseNoThe ZIP code associated with the credit card.
chargeitBooleanFalseNoIndicates whether the charge was successfully processed.
checknumberStringFalseNoThe check number associated with the payment.
classStringFalseNoThe class or category associated with the transaction.
clearedBooleanFalseNoIndicates whether the transaction has cleared.
cleareddateDateFalseNoThe date when the transaction was cleared.
consolidatebalanceDecimalFalseNoThe consolidated balance from multiple accounts or transactions.
createddateDatetimeFalseNoThe date and time when the transaction or record was created.
creditcardStringFalseNoThe type of credit card used in the transaction.
creditcardprocessorStringFalseNoThe processor handling the credit card transaction.
currencyStringFalseNoThe currency used for the transaction.
currencynameStringFalseNoThe name of the currency used for the transaction.
currencysymbolStringFalseNoThe symbol of the currency used in the transaction.
customerStringFalseNoThe customer associated with the transaction.
customercodeStringFalseNoThe unique code assigned to the customer.
customformStringFalseNoThe custom form used for the transaction.
debitcardissuenoStringFalseNoThe issue number of the debit card used for the transaction.
departmentStringFalseNoThe department associated with the transaction.
dynamicdescriptorStringFalseNoA dynamic descriptor describing the transaction for the cardholder.
entitynexusStringFalseNoThe tax nexus associated with the entity in the transaction.
exchangerateDecimalFalseNoThe exchange rate applied to the transaction.
externalidStringFalseNoA unique identifier used to reference the transaction externally.
handlingmodeStringFalseNoThe handling mode for the transaction (for example, manual or automatic).
inputauthcodeStringFalseNoThe input authorization code provided for the transaction.
inputpnrefnumStringFalseNoThe input reference number for the transaction.
inputreferencecodeStringFalseNoThe input reference code for the transaction.
isbasecurrencyBooleanFalseNoIndicates whether the transaction is conducted in the base currency.
ispurchasecardStringFalseNoIndicates whether the transaction is processed with a purchase card.
lastmodifieddateDatetimeFalseNoThe date and time when the transaction or record was last modified.
locationStringFalseNoThe location associated with the transaction.
memoStringFalseNoA memo or note associated with the transaction.
nexusStringFalseNoThe tax nexus information for the transaction.
outputauthcodeStringFalseNoThe output authorization code received after processing.
outputreferencecodeStringFalseNoThe output reference code received after processing.
overrideholdBooleanFalseNoIndicates whether the credit hold status has been manually overridden.
overrideholdcheckedBooleanFalseNoIndicates whether the override of credit hold has been checked.
payeeaddressStringFalseNoThe address of the payee in the transaction.
payeeaddresslistStringFalseNoThe list of payee addresses associated with the transaction.
paymentcardcscStringFalseNoThe credit card security code (CSC) used in the transaction.
paymenteventdateDatetimeFalseNoThe date and time when the payment event occurred.
paymenteventholdreasonStringFalseNoThe reason for holding the payment event.
paymenteventpurchasedatasentStringFalseNoIndicates whether purchase data was sent during the payment event.
paymenteventresultStringFalseNoThe result of the payment event (for example, success or failure).
paymenteventtypeStringFalseNoThe type of payment event (for example, authorization, capture, refund).
paymenteventupdatedbyStringFalseNoThe user or system that updated the payment event.
paymentmethodStringFalseNoThe method of payment used in the transaction (for example, credit card, PayPal).
paymentoperationStringFalseNoThe operation type for the payment (for example, charge, refund).
paymentoptionStringFalseNoThe payment option chosen for the transaction.
paymentprocessingprofileStringFalseNoThe profile used for processing the payment.
pnrefnumStringFalseNoThe reference number associated with the payment transaction.
postingperiodStringFalseNoThe posting period for the transaction.
softdescriptorStringFalseNoA soft descriptor used in the transaction's description.
statusStringFalseNoThe current status of the transaction.
statusrefStringFalseNoA reference to the status of the transaction.
subsidiaryStringFalseNoThe subsidiary associated with the transaction.
tobeprintedBooleanFalseNoIndicates whether the transaction is flagged to be printed.
totalDecimalFalseNoThe total amount for the transaction.
trandateDateFalseNoThe date when the transaction occurred.
tranidStringFalseNoThe unique identifier for the transaction.
transactionnumberStringFalseNoThe number associated with the transaction.
validfromStringFalseNoThe date from which the transaction or record is valid.

Return to Top

customerRefundPayeeAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoAn internal key or identifier for the address record.
addr1StringFalseNoThe first line of the address, typically the street address.
addr2StringFalseNoThe second line of the address, typically an apartment or suite number.
addr3StringFalseNoThe third line of the address, used for additional address information if needed.
addresseeStringFalseNoThe name of the person or organization receiving the address.
attentionStringFalseNoThe person or department to which the address is directed.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country where the address is located.
dropdownstateStringFalseNoThe state or region associated with the address, selected from a predefined list.
overrideBooleanFalseNoIndicates whether the address override option is enabled.
stateStringFalseNoThe state or province associated with the address.

Return to Top

customerSalesTeam 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage contribution of the customer or employee to the job or project.
customerStringFalseNoThe customer or job associated with the transaction or project.
employeeStringFalseNoThe employee associated with the job or project.
isprimaryBooleanFalseNoIndicates whether this is the primary customer, employee, or role in the transaction or project.

Return to Top

CustomerSegmentCustomer 

NameTypeReadOnlyReferencesFilterOnlyDescription
customerStringFalseNoThe customer associated with the transaction, job, or record.

Return to Top

customerstatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoA detailed description of the lead or opportunity.
externalidStringFalseNoA unique identifier used to reference the lead externally.
includeinleadreportsBooleanFalseNoIndicates whether the lead is included in lead reports.
isinactiveBooleanFalseNoIndicates whether the lead is marked as inactive.
nameStringFalseNoThe name or title of the lead or opportunity.
probabilityStringFalseNoThe likelihood, as a percentage, of the lead converting to a sale.
stageStringFalseNoThe current stage or status of the lead in the sales process.

Return to Top

customerSubscriptionMessageHistory 

NameTypeReadOnlyReferencesFilterOnlyDescription
emailStringFalseNoThe email address of the recipient or sender in the communication.
memoStringFalseNoA note or additional information related to the communication.
recipientStringFalseNoThe name or identifier of the person receiving the email.
senddateDateFalseNoThe date when the email was sent.
senderStringFalseNoThe name or identifier of the person who sent the email.

Return to Top

customerSubscriptions 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoThe entity associated with the campaign subscription (for example, customer, partner, etc.).
lastmodifieddateDateFalseNoThe date when the campaign subscription was last modified.
subscriptionStringFalseNoThe specific campaign subscription associated with the entity.

Return to Top

customersubsidiaryrelationship 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal identifier for the record.
balanceDecimalFalseNoThe total balance associated with the customer or entity.
depositbalanceDecimalFalseNoThe balance of deposits associated with the customer or entity.
entityStringFalseNoThe customer or entity associated with the record.
externalidStringFalseNoThe external identifier used to reference the record.
isprimarysubBooleanFalseNoIndicates whether this is the primary subsidiary for the customer or entity.
nameStringFalseNoThe name associated with the customer or entity.
primarycurrencyStringFalseNoThe primary currency used for transactions related to this customer or entity.
subsidiaryStringFalseNoThe subsidiary associated with the customer or entity.

Return to Top

CustomField 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoThe internal identifier for the record or field.
descriptionStringFalseNoA detailed description of the field or record.
fieldtypeStringFalseNoThe type of field, such as text, number, date, etc.
fieldvaluetyperecordStringFalseNoIndicates whether the field is based on a list or record (for example, reference field).
ismandatoryBooleanFalseNoIndicates whether the field is required to be filled in.
isshowinlistBooleanFalseNoIndicates whether the field is displayed in the list view of the record.
isstoredBooleanFalseNoIndicates whether the value of the field is stored in the database.
nameStringFalseNoThe label or name of the field.
ownerStringFalseNoThe owner of the field, typically a user or group responsible for it.
recordtypeStringFalseNoThe type of record the field belongs to (for example, customer, transaction).
scriptidStringFalseNoThe script identifier associated with the field.

Return to Top

CustomField2 

NameTypeReadOnlyReferencesFilterOnlyDescription
descrStringFalseNoA detailed description or summary of the record or field.

Return to Top

customInstallmentPercent 

NameTypeReadOnlyReferencesFilterOnlyDescription
installmentLineNumIntegerFalseNoThe number representing the installment line, indicating its order in a series of payments.
percentageDoubleFalseNoThe percentage of the total amount allocated to this installment.
termIntegerFalseNoThe term or duration (in months or other units) associated with the installment.

Return to Top

customlist 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoThe internal identifier for the record or item.
descriptionStringFalseNoA detailed description of the record or item.
isinactiveBooleanFalseNoIndicates whether the record or item is marked as inactive.
isorderedBooleanFalseNoIndicates whether the item has been ordered.
nameStringFalseNoThe name or title associated with the record or item.
ownerStringFalseNoThe owner or person responsible for the record or item.

Return to Top

customPluginTypesAction 

NameTypeReadOnlyReferencesFilterOnlyDescription
plugintypeStringFalseNoThe type of custom plug-in used, specifying its functionality or purpose.

Return to Top

customPluginTypesBundleInstallation 

NameTypeReadOnlyReferencesFilterOnlyDescription
plugintypeStringFalseNoThe type of custom plug-in, specifying the functionality or purpose of the plug-in.

Return to Top

customPluginTypesMapReduce 

NameTypeReadOnlyReferencesFilterOnlyDescription
plugintypeStringFalseNoSpecifies the type of custom plug-in, indicating its intended functionality or role within the system.

Return to Top

customPluginTypesPortlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
plugintypeStringFalseNoSpecifies the type or category of a custom plug-in, indicating its function or purpose within the system.

Return to Top

customPluginTypesRestlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
plugintypeStringFalseNoIndicates the specific type or category of a custom plug-in, describing its intended functionality.

Return to Top

customPluginTypesScheduled 

NameTypeReadOnlyReferencesFilterOnlyDescription
plugintypeStringFalseNoSpecifies the type of custom plug-in, describing its functionality or the system feature it is designed to enhance.

Return to Top

customPluginTypesSuitelet 

NameTypeReadOnlyReferencesFilterOnlyDescription
plugintypeStringFalseNoDefines the type of custom plug-in, detailing its specific functionality or role within the system.

Return to Top

customPluginTypesUserEvent 

NameTypeReadOnlyReferencesFilterOnlyDescription
plugintypeStringFalseNoThe type of custom plug-in, specifying its functionality or role in the system.

Return to Top

custompurchase 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the transaction or record.
availablevendorcreditDecimalFalseNoThe amount of available vendor credit for the transaction.
billaddresslistStringFalseNoThe list of billing addresses associated with the transaction.
billingaddressStringFalseNoThe primary billing address for the transaction.
classStringFalseNoThe class associated with the transaction or record, used for categorization.
createddateDatetimeFalseNoThe date and time when the record was created.
currencyStringFalseNoThe currency used for the transaction.
currencynameStringFalseNoThe name of the currency associated with the transaction.
currencysymbolStringFalseNoThe symbol of the currency used in the transaction.
customformStringFalseNoThe custom form associated with the transaction or record.
departmentStringFalseNoThe department responsible for the transaction or record.
discountamountDecimalFalseNoThe amount of discount applied to the transaction.
discountdateDateFalseNoThe date when the discount is applied or valid.
duedateDateFalseNoThe due date for payment or the transaction.
entityStringFalseNoThe entity associated with the transaction, such as a customer or vendor.
exchangerateDecimalFalseNoThe exchange rate used for currency conversion in the transaction.
externalidStringFalseNoThe external identifier associated with the transaction.
incotermStringFalseNoThe Incoterms (International Commercial Terms) used in the transaction.
landedcostmethodStringFalseNoThe method used to calculate the landed cost for the items.
landedcostperlineBooleanFalseNoIndicates whether landed cost is applied per line item.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified.
locationStringFalseNoThe location where the transaction or record is associated.
memoStringFalseNoA memo or note providing additional details about the transaction.
nexusStringFalseNoThe tax nexus associated with the transaction, indicating tax jurisdiction.
overrideinstallmentsBooleanFalseNoIndicates whether installment terms are overridden for the transaction.
paymentholdBooleanFalseNoIndicates whether payment is held for the transaction.
postingperiodStringFalseNoThe posting period associated with the transaction.
statusStringFalseNoThe current status of the transaction or record.
subsidiaryStringFalseNoThe subsidiary associated with the transaction or record.
taxdetailsoverrideBooleanFalseNoIndicates whether tax details have been overridden for the transaction.
taxregoverrideBooleanFalseNoIndicates whether tax registration details have been overridden for the transaction.
taxtotalDecimalFalseNoThe total amount of tax applied to the transaction.
trandateDateFalseNoThe date when the transaction occurred.
tranidStringFalseNoThe unique identifier for the transaction.
transactionnumberStringFalseNoThe transaction number used to track the transaction.
transtatusStringFalseNoThe status of the transaction (for example, pending, completed).
usertotalDecimalFalseNoThe total amount as calculated by the user for the transaction.

Return to Top

customrecordtype 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoThe unique internal identifier for the record.
allowattachmentsBooleanFalseNoIndicates whether attachments are allowed for the record.
allowinlinedeletingBooleanFalseNoIndicates whether inline deletion is permitted for the record.
allowinlineeditingBooleanFalseNoIndicates whether inline editing is enabled for the record.
allowquicksearchBooleanFalseNoIndicates whether quick search is enabled for the record.
descriptionStringFalseNoA detailed description of the record or item.
enablemailmergeBooleanFalseNoIndicates whether mail merge functionality is enabled for the record.
includenameBooleanFalseNoIndicates whether the name field should be included in the record.
isinactiveBooleanFalseNoIndicates whether the record is inactive.
isorderedBooleanFalseNoIndicates whether the record has been ordered.
nameStringFalseNoThe name or title associated with the record.
nopermissionrequiredBooleanFalseNoIndicates whether no permissions are required to access or modify the record.
ownerStringFalseNoThe owner or responsible party for the record.
scriptidStringFalseNoThe script identifier associated with the record.
shownotesBooleanFalseNoIndicates whether notes should be displayed for the record.

Return to Top

customsale 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the transaction.
althandlingcostDecimalFalseNoThe alternative handling cost for the transaction.
altshippingcostDecimalFalseNoThe alternative shipping cost for the transaction.
billaddressStringFalseNoThe billing address associated with the transaction.
billaddresslistStringFalseNoThe list of billing addresses associated with the transaction.
billingaddressStringFalseNoThe primary billing address for the transaction.
billisresidentialStringFalseNoIndicates whether the billing address is residential.
classStringFalseNoThe classification or category associated with the transaction.
couponcodeStringFalseNoThe coupon code applied to the transaction.
createddateDatetimeFalseNoThe date and time when the record was created.
createdfromStringFalseNoThe source record from which this transaction was created.
currencyStringFalseNoThe currency used in the transaction.
currencynameStringFalseNoThe name of the currency used in the transaction.
currencysymbolStringFalseNoThe symbol of the currency used in the transaction.
customformStringFalseNoThe custom form associated with the transaction.
deferredrevenueDecimalFalseNoThe amount of deferred revenue for the transaction.
departmentStringFalseNoThe department responsible for the transaction.
discountamountDecimalFalseNoThe amount of discount applied to the transaction.
discountdateDateFalseNoThe date when the discount becomes applicable.
discountitemStringFalseNoThe item associated with the discount in the transaction.
discountrateStringFalseNoThe rate of the discount applied to the transaction.
discounttotalDecimalFalseNoThe total discount applied to the transaction.
duedateDateFalseNoThe due date for the payment or action required.
emailStringFalseNoThe email address associated with the transaction.
enddateDateFalseNoThe end date of the transaction or contract.
entityStringFalseNoThe entity (for example, customer, vendor) associated with the transaction.
entitytaxregnumStringFalseNoThe tax registration number associated with the entity.
estgrossprofitDecimalFalseNoThe estimated gross profit for the transaction.
estgrossprofitpercentStringFalseNoThe estimated gross profit percentage for the transaction.
exchangerateDecimalFalseNoThe exchange rate used for currency conversion in the transaction.
externalidStringFalseNoThe external identifier for the transaction.
fobStringFalseNoThe free-on-board terms for shipping.
giftcertappliedDecimalFalseNoThe amount of gift certificate applied to the transaction.
handlingcostDecimalFalseNoThe cost of handling the transaction or goods.
isbasecurrencyBooleanFalseNoIndicates whether the transaction uses the base currency.
ismultishiptoBooleanFalseNoIndicates whether the transaction allows multiple shipping addresses.
jobStringFalseNoThe job or project associated with the transaction.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified.
linkedtrackingnumbersStringFalseNoThe linked tracking numbers for the shipment.
locationStringFalseNoThe location associated with the transaction.
memoStringFalseNoA memo providing additional details about the transaction.
messageStringFalseNoA message associated with the transaction.
messageselStringFalseNoThe message selection for the transaction.
muccpromocodeinstanceStringFalseNoThe unique identifier for the promotion code instance.
nexusStringFalseNoThe tax nexus for the transaction, indicating the tax jurisdiction.
opportunityStringFalseNoThe opportunity associated with the transaction.
otherrefnumStringFalseNoAny other reference number related to the transaction.
overrideinstallmentsBooleanFalseNoIndicates whether installments are overridden for the transaction.
partnerStringFalseNoThe partner involved in the transaction.
postingperiodStringFalseNoThe posting period associated with the transaction.
promocodeStringFalseNoThe promotion code applied to the transaction.
recognizedrevenueDecimalFalseNoThe amount of revenue recognized from the transaction.
returntrackingnumbersStringFalseNoThe tracking numbers for any returned items.
revenuestatusStringFalseNoThe revenue status of the transaction.
revreconrevcommitmentBooleanFalseNoIndicates whether the revenue recognition commitment is applied.
salesgroupStringFalseNoThe sales group responsible for the transaction.
salesrepStringFalseNoThe sales representative handling the transaction.
shipaddressStringFalseNoThe shipping address for the transaction.
shipaddresslistStringFalseNoThe list of shipping addresses associated with the transaction.
shipdateDateFalseNoThe date when the items are shipped.
shipisresidentialStringFalseNoIndicates whether the shipping address is residential.
shipmethodStringFalseNoThe shipping method used for the transaction.
shipoverrideStringFalseNoOverrides applied to the shipping method.
shippingaddressStringFalseNoThe address where the items are shipped.
shippingcostDecimalFalseNoThe cost of shipping the items.
shippingcostoverriddenStringFalseNoIndicates whether the shipping cost was overridden.
sourceStringFalseNoThe source of the transaction or order.
startdateDateFalseNoThe start date of the transaction or contract.
statusStringFalseNoThe current status of the transaction.
subsidiaryStringFalseNoThe subsidiary associated with the transaction.
subsidiarytaxregnumStringFalseNoThe tax registration number for the subsidiary.
subtotalDecimalFalseNoThe subtotal amount for the transaction before taxes and discounts.
syncpartnerteamsBooleanFalseNoIndicates whether partner teams are synchronized.
taxdetailsoverrideBooleanFalseNoIndicates whether tax details have been overridden.
taxpointdateDateFalseNoThe date used for calculating tax points.
taxpointdateoverrideBooleanFalseNoIndicates whether the tax point date is overridden.
taxregoverrideBooleanFalseNoIndicates whether the tax registration is overridden.
taxtotalDecimalFalseNoThe total amount of tax applied to the transaction.
termsStringFalseNoThe payment terms for the transaction.
tobeemailedBooleanFalseNoIndicates whether the transaction should be emailed.
tobefaxedBooleanFalseNoIndicates whether the transaction should be faxed.
tobeprintedBooleanFalseNoIndicates whether the transaction should be printed.
totalDecimalFalseNoThe total amount for the transaction including discounts, taxes, and shipping.
totalcostestimateDecimalFalseNoThe estimated total cost for the transaction.
trackingnumbersStringFalseNoThe tracking numbers for the shipment.
trandateDateFalseNoThe date of the transaction.
tranidStringFalseNoThe transaction ID used to identify the transaction.
tranisvsoebundleBooleanFalseNoIndicates whether the transaction is a part of a Vendor-Specific Objective Evidence (VSOE) bundle.
transtatusStringFalseNoThe status of the transaction (for example, pending, completed).
vsoeautocalcBooleanFalseNoIndicates whether VSOE auto-calculation is applied.

Return to Top

customsegment 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoThe unique internal identifier for the record.
balancingBooleanFalseNoIndicates whether the record is balanced in the general ledger.
displayorderIntegerFalseNoThe order in which the record is displayed or sorted.
glimpactBooleanFalseNoIndicates whether the record has an impact on the general ledger.
isinactiveBooleanFalseNoIndicates whether the record is inactive.
nameStringFalseNoThe name or title of the record.
scriptidStringFalseNoThe script identifier associated with the record.

Return to Top

CustomTransactionType 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record.
accountStringFalseNoThe account associated with the transaction or record.
defaultaccountStringFalseNoThe default account to be used for the transaction or record.
filterbyaccounttypeStringFalseNoSpecifies the type of account to filter by.
filterbyaccounttypeallBooleanFalseNoIndicates whether all account types are allowed for filtering.
isclassmandatoryBooleanFalseNoIndicates whether a class is mandatory for the record.
iscreditBooleanFalseNoIndicates whether the record is related to credit.
isdepartmentmandatoryBooleanFalseNoIndicates whether a department is mandatory for the record.
islocationmandatoryBooleanFalseNoIndicates whether a location is mandatory for the record.
ispostingBooleanFalseNoIndicates whether the record is eligible for posting.
isvoidableBooleanFalseNoIndicates whether void transactions are allowed using reversing journals.
nameStringFalseNoThe name or title associated with the record.
scriptidStringFalseNoThe script identifier associated with the record.
showstatusBooleanFalseNoIndicates whether the status field should be displayed.
specifyaccountontransactionBooleanFalseNoIndicates whether the account must be specified on the transaction.

Return to Top

DayOfWeek 

NameTypeReadOnlyReferencesFilterOnlyDescription
idIntegerFalseNoThe unique internal identifier for the record in the DayOfWeek table.

Return to Top

deletedrecord 

NameTypeReadOnlyReferencesFilterOnlyDescription
contextStringFalseNoThe context in which this record is used or associated, such as the specific process or module.
deletedbyStringFalseNoThe name or identifier of the user who marked this record as deleted.
deleteddateDateFalseNoThe date when this record was deleted from the system.
iscustomlistBooleanFalseNoIndicates whether this record is part of a custom list created by the user.
iscustomrecordBooleanFalseNoIndicates whether this record is a custom record type created by the user.
iscustomtransactionBooleanFalseNoIndicates whether this record is a custom transaction type created by the user.
nameStringFalseNoThe name or title associated with this record, typically used for identification.
recordtypeidStringFalseNoThe identifier of the record type, used to classify and differentiate between different types of records.
scriptidStringFalseNoThe identifier for the script associated with this record, used for scripting and automation purposes.

Return to Top

department 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the department record.
externalidStringFalseNoThe external identifier used to reference the department from an external system or source.
fullnameStringFalseNoThe full name of the department, which can include additional details for clarity.
includechildrenBooleanFalseNoIndicates whether child departments (subdepartments) should be included in relevant operations or processes.
isinactiveBooleanFalseNoIndicates whether the department is inactive and should be excluded from active records and processes.
nameStringFalseNoThe name of the department, typically used for display and identification purposes.
parentStringFalseNoThe parent department to which this department belongs, indicating its hierarchical relationship.

Return to Top

departmentSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
departmentStringFalseNoThe department to which this record is assigned, indicating the organizational unit.

Return to Top

deploymentsAction 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique identifier for the deployment, used to track and reference the deployment.
isdeployedBooleanFalseNoIndicates whether the deployment has been successfully completed and is currently active.
istaskStringFalseNoThe type of task associated with the deployment, describing the specific action or process.
loglevelStringFalseNoThe level of logging detail for the deployment, such as 'Info', 'Warning', or 'Error'.
oldrecordtypeStringFalseNoThe previous record type before the deployment, used to track changes to record structures.
ownerStringFalseNoThe individual or system responsible for managing and overseeing the deployment.
primarykeyStringFalseNoThe primary key that uniquely identifies the record within the deployment context.
recordtypeStringFalseNoThe type of record that the deployment applies to, used to categorize and filter relevant records.
scriptidStringFalseNoThe identifier for the script associated with the deployment, used for automation and execution.
seqnumDoubleFalseNoThe sequence number for the deployment, indicating its order in a series of deployments or tasks.
statusStringFalseNoThe current status of the deployment, such as 'Pending', 'In Progress', or 'Completed'.

Return to Top

deploymentsBundleInstallation 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique identifier for the deployment, used to track and reference each deployment.
isdeployedBooleanFalseNoIndicates whether the deployment has been successfully completed and is now live.
loglevelStringFalseNoSpecifies the level of detail for logging information during the deployment, such as 'Debug', 'Info', 'Warning', or 'Error'.
oldrecordtypeStringFalseNoThe type of record that existed prior to the deployment, used to track any changes or updates made.
ownerStringFalseNoThe individual or system that owns or is responsible for managing the deployment process.
primarykeyStringFalseNoThe primary key for identifying the specific record in the deployment process, ensuring uniqueness.
scriptidStringFalseNoThe unique identifier for the script associated with the deployment, often used for automation and execution purposes.
seqnumDoubleFalseNoA sequence number used to order deployments or tasks, ensuring they are processed in the correct sequence.
statusStringFalseNoThe current status of the deployment, such as 'Pending', 'In Progress', or 'Completed'.
titleStringFalseNoThe title or name of the deployment, used to describe or categorize it for easier identification.

Return to Top

deploymentsClient 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique identifier for the deployment, used to track and reference the specific deployment event.
eventtypeStringFalseNoThe type of event associated with the deployment, such as 'Creation', 'Update', or 'Delete'.
isdeployedBooleanFalseNoIndicates whether the deployment has been successfully completed and is now live in the system.
istaskStringFalseNoThe specific task associated with the deployment, which could include actions like 'Initialization' or 'Execution'.
loglevelStringFalseNoThe level of detail for logging during the deployment process, such as 'Info', 'Warning', or 'Error'.
oldrecordtypeStringFalseNoThe previous record type before the deployment, used to track changes to records within the system.
ownerStringFalseNoThe individual or system responsible for the management and oversight of the deployment.
primarykeyStringFalseNoThe primary key that uniquely identifies a record within the deployment context, ensuring distinct identification.
recordtypeStringFalseNoThe type of record the deployment applies to, used for categorization and classification of data.
scriptidStringFalseNoThe identifier of the script associated with the deployment, typically used for automated processes or tasks.
seqnumDoubleFalseNoA sequence number that represents the order of the deployment or tasks within a series of actions.
statusStringFalseNoThe current status of the deployment, such as 'Pending', 'In Progress', or 'Completed'.

Return to Top

deploymentsMapReduce 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique identifier for the deployment, used to track and reference the specific deployment event.
concurrencylimitStringFalseNoThe limit on the number of concurrent processes or tasks that can run during the deployment, ensuring resource management.
isdeployedBooleanFalseNoIndicates whether the deployment has been successfully completed and is now active in the system.
loglevelStringFalseNoThe level of logging detail for the deployment, such as 'Debug', 'Info', 'Warning', or 'Error'.
oldrecordtypeStringFalseNoThe previous record type before the deployment, used for tracking changes or updates to records.
ownerStringFalseNoThe individual or system that owns and manages the deployment process.
primarykeyStringFalseNoThe primary key that uniquely identifies a record in the deployment, ensuring the uniqueness and integrity of the record.
processorpoolStringFalseNoThe pool of processors or servers allocated for handling the deployment, used to manage resources.
scriptidStringFalseNoThe unique identifier for the script associated with the deployment, often used for automation and execution.
seqnumDoubleFalseNoA sequence number indicating the order of the deployment or tasks within a series.
statusStringFalseNoThe current status of the deployment, such as 'Pending', 'In Progress', or 'Completed'.
titleStringFalseNoThe title or name of the deployment, used for categorization and easy identification.

Return to Top

deploymentsMassUpdate 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique identifier for the deployment, used to reference and track each specific deployment instance.
isdeployedBooleanFalseNoIndicates whether the deployment has been successfully completed and is currently active in the system.
istaskStringFalseNoThe task associated with the deployment, such as 'Initialization', 'Execution', or other deployment-related actions.
loglevelStringFalseNoThe level of logging detail for the deployment, which could include 'Debug', 'Info', 'Warning', or 'Error' to manage log verbosity.
oldrecordtypeStringFalseNoThe type of record before the deployment process, used to track any changes or updates made to records.
ownerStringFalseNoThe individual, team, or system responsible for managing the deployment and overseeing its execution.
primarykeyStringFalseNoThe primary key that uniquely identifies each record in the deployment, ensuring data integrity and distinct identification.
recordtypeStringFalseNoThe type of record to which the deployment applies, helping to categorize and associate the deployment with specific data types.
scriptidStringFalseNoThe unique identifier for the script linked to the deployment, used for automation and execution within the deployment process.
seqnumDoubleFalseNoA numerical sequence used to maintain the order of deployments or tasks when multiple actions are involved.
statusStringFalseNoThe current status of the deployment, indicating its state such as 'Pending', 'In Progress', 'Completed', or 'Failed'.

Return to Top

deploymentsPortlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique identifier for the deployment, used to track and reference the specific deployment event.
dashboardappBooleanFalseNoIndicates whether the deployment is associated with a Dashboard SuiteApp, used for visualizing data or managing the dashboard application.
isdeployedBooleanFalseNoIndicates whether the deployment has been successfully completed and is now active in the system.
loglevelStringFalseNoThe level of logging detail for the deployment, such as 'Debug', 'Info', 'Warning', or 'Error', which helps in debugging and monitoring.
oldrecordtypeStringFalseNoThe previous record type before the deployment, used to track changes or modifications made to the records during deployment.
ownerStringFalseNoThe individual or team responsible for managing and overseeing the deployment process and ensuring its success.
primarykeyStringFalseNoThe primary key that uniquely identifies each record within the deployment, ensuring data integrity and uniqueness.
scriptidStringFalseNoThe unique identifier for the script associated with the deployment, typically used to automate tasks or actions within the system.
seqnumDoubleFalseNoA sequence number that helps maintain the order of the deployment or tasks, ensuring processes are executed in the correct sequence.
statusStringFalseNoThe current status of the deployment, such as 'Pending', 'In Progress', 'Completed', or 'Failed', reflecting the deployment's state.
titleStringFalseNoThe title or name of the deployment, used to describe the deployment for easier identification and categorization.

Return to Top

deploymentsRestlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique identifier for the deployment, used to track and reference the specific deployment instance within the system.
isdeployedBooleanFalseNoIndicates whether the deployment has been successfully completed and is currently live or active in the system.
loglevelStringFalseNoSpecifies the level of logging detail for the deployment, such as 'Debug', 'Info', 'Warning', or 'Error', used to manage log verbosity.
oldrecordtypeStringFalseNoThe type of record that existed before the deployment, used to track changes and updates to records during deployment.
ownerStringFalseNoThe individual, team, or system responsible for overseeing and managing the deployment process.
primarykeyStringFalseNoThe primary key that uniquely identifies each record in the deployment, ensuring distinct identification of data.
scriptidStringFalseNoThe unique identifier for the script associated with the deployment, used to automate tasks and processes related to the deployment.
seqnumDoubleFalseNoA sequence number used to organize and maintain the order of deployment tasks or steps when multiple actions are involved.
statusStringFalseNoThe current status of the deployment, which could be 'Pending', 'In Progress', 'Completed', or 'Failed', reflecting the state of the deployment.
titleStringFalseNoThe title or name of the deployment, used for identification and categorization of the deployment within the system.

Return to Top

deploymentsScheduled 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique identifier for the deployment, used to track and reference the specific deployment event within the system.
isdeployedBooleanFalseNoIndicates whether the deployment has been successfully completed and is currently live or active in the system.
loglevelStringFalseNoThe level of detail for logging during the deployment process, such as 'Debug', 'Info', 'Warning', or 'Error', to control the verbosity of logs.
oldrecordtypeStringFalseNoThe type of record that existed before the deployment, used to track and manage changes made during the deployment process.
ownerStringFalseNoThe individual, team, or system responsible for overseeing and managing the deployment from start to finish.
primarykeyStringFalseNoThe primary key used to uniquely identify each record in the deployment, ensuring the integrity and distinctness of the data.
processorpoolStringFalseNoThe pool of processors or resources allocated for handling the deployment tasks, used for efficient resource management during deployment.
queueidStringFalseNoThe identifier for the queue associated with the deployment (deprecated). This field is no longer used for newer deployments.
scriptidStringFalseNoThe unique identifier for the script associated with the deployment, typically used to automate and manage tasks during the deployment process.
seqnumDoubleFalseNoA sequence number used to maintain the order of deployment tasks or actions, ensuring proper execution in a series of steps.
statusStringFalseNoThe current status of the deployment, such as 'Pending', 'In Progress', 'Completed', or 'Failed', which reflects the deployment's progress.
titleStringFalseNoThe title or name of the deployment, used to describe and categorize the deployment for easy identification.

Return to Top

deploymentsScript 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique identifier for the deployment, used to track and reference each specific deployment event in the system.
concurrencylimitStringFalseNoThe limit on the number of concurrent processes or tasks that can run during the deployment, ensuring optimized resource management.
dashboardappBooleanFalseNoIndicates whether the deployment is associated with a Dashboard SuiteApp, which is used for visualizing and managing data on a dashboard interface.
eventtypeStringFalseNoThe type of event related to the deployment, such as 'Creation', 'Update', 'Delete', or other actions triggered during the deployment process.
isdeployedBooleanFalseNoIndicates whether the deployment has been successfully completed and is now active or live in the system.
istaskStringFalseNoThe specific task associated with the deployment, used to describe the action or process, such as 'Initialization' or 'Execution'.
loglevelStringFalseNoThe level of detail for logging during the deployment, such as 'Debug', 'Info', 'Warning', or 'Error', to control the verbosity of deployment logs.
oldrecordtypeStringFalseNoThe type of record before the deployment, helping track changes and updates to records in the system during deployment.
ownerStringFalseNoThe individual, team, or system responsible for overseeing and managing the deployment process, ensuring its execution and success.
primarykeyStringFalseNoThe primary key that uniquely identifies each record in the deployment, ensuring the integrity and distinct identification of data.
processorpoolStringFalseNoThe pool of processors or computing resources allocated to handle the deployment tasks, optimizing the processing workload.
queueidStringFalseNoThe identifier for the deployment queue (deprecated), previously used for managing the order of deployment tasks. This is no longer in use.
recordtypeStringFalseNoThe type of record that the deployment applies to, used for categorizing and associating the deployment with specific data types.
scriptidStringFalseNoThe unique identifier for the script associated with the deployment, which is typically used to automate deployment tasks.
seqnumDoubleFalseNoA sequence number indicating the order of deployment tasks or actions, ensuring tasks are executed in the correct order.
statusStringFalseNoThe current status of the deployment, such as 'Pending', 'In Progress', 'Completed', or 'Failed', reflecting the deployment's progress.
titleStringFalseNoThe title or name of the deployment, used for easier identification, categorization, and reference within the system.

Return to Top

deploymentsSuitelet 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique identifier for the deployment, used to track and reference each specific deployment instance within the system.
eventtypeStringFalseNoThe type of event related to the deployment, such as 'Creation', 'Update', 'Delete', or other actions triggered during the deployment process.
isdeployedBooleanFalseNoIndicates whether the deployment has been successfully completed and is now live or active within the system.
loglevelStringFalseNoThe level of detail for logging during the deployment, such as 'Debug', 'Info', 'Warning', or 'Error', controlling the verbosity of deployment logs.
oldrecordtypeStringFalseNoThe previous record type before the deployment, helping track and manage changes made to records during the deployment process.
ownerStringFalseNoThe individual, team, or system responsible for overseeing and managing the deployment, ensuring its proper execution.
primarykeyStringFalseNoThe primary key that uniquely identifies each record in the deployment process, ensuring data integrity and distinct identification.
scriptidStringFalseNoThe unique identifier for the script associated with the deployment, often used to automate and execute tasks within the deployment.
seqnumDoubleFalseNoA sequence number used to order deployment tasks or actions, ensuring that they are executed in the correct sequence or order.
statusStringFalseNoThe current status of the deployment, such as 'Pending', 'In Progress', 'Completed', or 'Failed', indicating the deployment's progress.
titleStringFalseNoThe title or name of the deployment, used to categorize and describe the deployment for easier identification and reference.

Return to Top

deploymentsUserEvent 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique identifier for the deployment, used to track and reference the specific deployment instance within the system.
eventtypeStringFalseNoThe type of event related to the deployment, such as 'Creation', 'Update', 'Delete', or any other event triggered during the deployment process.
isdeployedBooleanFalseNoIndicates whether the deployment has been successfully completed and is now active within the system.
istaskStringFalseNoDescribes the specific task associated with the deployment, such as 'Initialization', 'Execution', or another task related to the deployment process.
loglevelStringFalseNoThe level of detail for logging during the deployment, including options like 'Debug', 'Info', 'Warning', or 'Error' to control the verbosity of logs.
oldrecordtypeStringFalseNoThe record type that existed before the deployment, allowing tracking and management of any changes made to records during deployment.
ownerStringFalseNoThe individual, team, or system responsible for overseeing and managing the deployment, ensuring its execution and success.
primarykeyStringFalseNoThe primary key used to uniquely identify each record in the deployment, ensuring data integrity and distinct identification.
recordtypeStringFalseNoThe type of record the deployment applies to, used to categorize and associate the deployment with specific data or objects.
scriptidStringFalseNoThe unique identifier for the script associated with the deployment, typically used for automating deployment tasks and processes.
seqnumDoubleFalseNoA sequence number that indicates the order of deployment tasks or actions, ensuring tasks are executed in the correct sequence.
statusStringFalseNoThe current status of the deployment, such as 'Pending', 'In Progress', 'Completed', or 'Failed', reflecting the deployment's progress.

Return to Top

deposit 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the transaction or record, typically used to categorize financial data.
classStringFalseNoThe class associated with the record, used for further classification or categorization of transactions.
clearedBooleanFalseNoIndicates whether the transaction has been cleared or reconciled, typically referring to financial transactions such as payments.
cleareddateDateFalseNoThe date when the transaction was marked as cleared or reconciled, used for financial reporting and tracking.
createddateDatetimeFalseNoThe date and time when the record was created in the system, used for auditing and record-keeping purposes.
creditcardprocessorStringFalseNoThe processor or service handling credit card transactions for this record, used to track payment processing services.
currencyStringFalseNoThe currency used in the transaction or record, typically represented by the ISO currency code (for example, USD, EUR).
currencynameStringFalseNoThe name of the currency, such as 'US Dollar' or 'Euro', providing the full description of the currency used.
customformStringFalseNoThe custom form associated with the record, often used to track specific data entry forms or templates customized by the user.
departmentStringFalseNoThe department associated with the record or transaction, typically used for categorization in an organizational structure.
exchangerateDecimalFalseNoThe exchange rate used to convert between currencies in the transaction, important for multi-currency accounting.
externalidStringFalseNoAn external identifier used to reference the record from external systems, ensuring integration with other platforms.
isbasecurrencyBooleanFalseNoIndicates whether the currency used is the base currency of the system or organization, essential for currency conversion calculations.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified, used for tracking updates and changes made to the record.
locationStringFalseNoThe location associated with the transaction, which could refer to a physical or organizational location for tracking purposes.
memoStringFalseNoA description or note providing additional details about the transaction or record, often used for clarifying the purpose.
postingperiodStringFalseNoThe accounting period in which the transaction or record is posted, used for financial reporting and period management.
subsidiaryStringFalseNoThe subsidiary associated with the record, used for tracking transactions and financial data within a parent organization.
taxperiodStringFalseNoThe period in which the transaction or record is reported for tax purposes, ensuring compliance with tax reporting requirements.
tobeprintedBooleanFalseNoIndicates whether the record is marked to be printed, typically used for documents or invoices that require physical printing.
totalDecimalFalseNoThe total amount for the transaction or record, often representing the sum of the line items or transaction value.
trandateDateFalseNoThe date when the transaction occurred, essential for accounting, financial reporting, and timeline tracking.
tranidStringFalseNoThe unique identifier for the transaction, used to reference and track the specific transaction record.
updatecurrencyStringFalseNoThe currency that will be used to update the record, particularly relevant in scenarios involving currency conversion or updates.

Return to Top

depositapplication 

NameTypeReadOnlyReferencesFilterOnlyDescription
appliedDecimalFalseNoThe amount that has been applied or allocated to the transaction, often used to track payments or credits applied to invoices.
aracctStringFalseNoThe Accounts Receivable account associated with the transaction, used to categorize and track receivables in financial accounting.
classStringFalseNoThe class associated with the transaction or record, used to further classify and categorize the transaction for organizational or reporting purposes.
createddateDatetimeFalseNoThe date and time when the record was created, providing a timestamp for when the transaction or record was entered into the system.
currencyStringFalseNoThe currency used in the transaction, typically represented by the ISO currency code (for example, USD, EUR).
customerStringFalseNoThe customer associated with the transaction, used to identify the party to which the transaction is linked.
departmentStringFalseNoThe department associated with the transaction, helping categorize the transaction based on the organizational structure.
depositStringFalseNoThe deposit associated with the transaction, often used to track prepaid amounts or cash deposits made towards a future transaction.
depositdateDateFalseNoThe date when the deposit was made, important for tracking the timing of payments or advances in financial records.
exchangerateDecimalFalseNoThe exchange rate applied for converting between currencies, used when transactions involve multiple currencies.
externalidStringFalseNoAn external identifier for the record, often used to link or integrate data from external systems into the accounting or financial records.
isbasecurrencyBooleanFalseNoIndicates whether the currency used in the transaction is the base currency of the organization or system, important for currency conversion.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified, important for tracking updates and changes to the record.
locationStringFalseNoThe location associated with the transaction, which can refer to a physical or organizational location for operational purposes.
memoStringFalseNoA note or description providing additional context about the transaction, often used for clarifying the purpose or details.
postingperiodStringFalseNoThe accounting period in which the transaction is posted, used for financial reporting and period-based financial management.
statusStringFalseNoThe current status of the transaction or record, such as 'Pending', 'Completed', 'Failed', indicating the state of the transaction.
statusRefStringFalseNoA reference code or identifier for the status, providing additional context or categorization for the status of the transaction.
subsidiaryStringFalseNoThe subsidiary associated with the record, helping track and categorize transactions within a larger organizational structure.
totalDecimalFalseNoThe total amount of the transaction, often representing the sum of all line items or the full value of the transaction.
trandateDateFalseNoThe date the transaction occurred, important for financial reporting, accounting, and timeline tracking of transactions.
unappliedDecimalFalseNoThe amount that has not yet been applied or allocated to any specific transaction, often representing open balances or unapplied payments.

Return to Top

descriptionitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
availabletopartnersBooleanFalseNoIndicates whether the item is available for selection or use by partners in the system, helping to manage accessibility.
classStringFalseNoThe class associated with the item or record, used for classification or categorization purposes within the system.
createddateDatetimeFalseNoThe date and time when the record was created, providing a timestamp for when the item or record was initially entered.
customformStringFalseNoThe custom form associated with the record, used to manage data entry forms or templates that are customized for specific needs.
departmentStringFalseNoThe department associated with the record or item, used for organizational classification or for tracking departmental responsibilities.
descriptionStringFalseNoA detailed description of the item or record, providing context or additional information about its characteristics or purpose.
externalidStringFalseNoAn external identifier used to reference the record or item from outside systems, facilitating integration with third-party applications.
includechildrenBooleanFalseNoIndicates whether related child records (such as subcategories or components) should be included or processed in relation to this record.
isinactiveBooleanFalseNoIndicates whether the item or record is marked as inactive, meaning it is not currently in use or available for selection in active processes.
issueproductStringFalseNoThe product related to or associated with the issue, often used in contexts involving product management or problem resolution.
itemidStringFalseNoThe unique identifier for the item, often used for referencing or tracking the item within inventory or product catalogs.
itemtypeStringFalseNoThe type of item, such as 'Inventory', 'Non-inventory', or 'Service', used to categorize the item for accounting or inventory purposes.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified, providing an audit trail of when updates or changes were made.
locationStringFalseNoThe location associated with the item, often used to track where the item is stored, sold, or used within the organization.
subsidiaryStringFalseNoThe subsidiary associated with the record, used to categorize and track transactions or items within a larger organizational structure.

Return to Top

descriptionItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe identifier or name of the item, used to reference and track products, services, or other inventory within the system.

Return to Top

descriptionItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
displaynameStringFalseNoThe name displayed for the item or record in the user interface, used for easy identification and visibility.
featureddescriptionStringFalseNoA brief description featured for the item or record, often used to highlight key selling points or special features.
itemStringFalseNoThe identifier or name of the item, used to reference and track products, services, or other inventory within the system.
languageStringFalseNoThe language used for the content or record, important for multi-lingual support in international or region-specific settings.
nopricemessageStringFalseNoThe message displayed when the item does not have a price set, typically used to inform customers about unavailable pricing.
outofstockmessageStringFalseNoThe message displayed when the item is out of stock, typically informing customers that the item is not currently available for purchase.
pagetitleStringFalseNoThe title of the page associated with the item or record, often used for SEO and navigation purposes in the website or system.
salesdescriptionStringFalseNoA description used for sales and marketing purposes, often highlighting the key features and benefits of the item to encourage purchases.
specialsdescriptionStringFalseNoA description highlighting special offers, discounts, or promotions associated with the item, used to attract customer attention.
storedescriptionStringFalseNoThe description of the item or record as it appears in the store or catalog, often including key details for customers.
storedetaileddescriptionStringFalseNoA more detailed description of the item or record, often used for providing in-depth information about features, specifications, or usage.
storedisplaynameStringFalseNoThe name displayed for the item in the store or catalog interface, used for visibility and identification in the shopping environment.

Return to Top

discountitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the record or transaction, typically used for categorizing financial data within the system.
availabletopartnersBooleanFalseNoIndicates whether the record or item is available for selection or use by partners, helping manage access control.
classStringFalseNoThe class associated with the record, used for classification or categorization purposes within the organization or system.
createddateDatetimeFalseNoThe date and time when the record was created, providing a timestamp for when the data was entered into the system.
customformStringFalseNoThe custom form associated with the record, used to manage specific data entry forms or templates tailored to business needs.
departmentStringFalseNoThe department associated with the record or item, used to classify the record within the organization for internal reporting or processing.
descriptionStringFalseNoA detailed description of the record or item, used to provide context, features, or relevant details about the item.
displaynameStringFalseNoThe name displayed for the record or item in the user interface, helping with identification and visibility in the system.
externalidStringFalseNoAn external identifier used to link the record to external systems or processes, aiding in system integration.
includechildrenBooleanFalseNoIndicates whether related child records (such as subcategories or components) should be included in the context of the current record.
isinactiveBooleanFalseNoIndicates whether the record is inactive, meaning it is not currently in use or visible in active processes or reports.
ispretaxBooleanFalseNoIndicates whether the record or item is considered for pre-tax calculations, typically used in tax or accounting settings.
issueproductStringFalseNoThe product related to the issue, often used in contexts involving product management, issues, or customer service.
itemidStringFalseNoThe unique identifier for the item or record, used for tracking and referencing the specific product or service.
itemtypeStringFalseNoThe type of item (for example, 'Inventory', 'Non-inventory', 'Service') that categorizes the record in relation to inventory or services.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified, important for tracking updates and changes made to the data.
locationStringFalseNoThe physical or organizational location associated with the record or item, used for tracking purposes in various business contexts.
nonpostingStringFalseNoIndicates whether the record is non-posting, typically referring to records that do not directly affect financial entries or balances.
parentStringFalseNoThe parent record or category associated with the current record, used to establish hierarchical relationships in the system.
rateStringFalseNoThe rate associated with the item or transaction, such as pricing, tax rates, or exchange rates.
subsidiaryStringFalseNoThe subsidiary to which the record belongs, used to track transactions within the larger organization structure.
taxscheduleStringFalseNoThe tax schedule associated with the record, used to determine the applicable tax rates or rules for the item.
upccodeStringFalseNoThe Universal Product Code (UPC) for the item, used for product identification and barcode scanning.
vendornameStringFalseNoThe name of the vendor associated with the record, typically used for procurement or supplier-related transactions.

Return to Top

discountItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe identifier or name of the item, used to reference and track products, services, or other inventory within the system.

Return to Top

discountItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
displaynameStringFalseNoThe name displayed for the item or record in the user interface, used for easy identification and visibility.
itemStringFalseNoThe identifier or name of the item, used to reference and track products, services, or other inventory within the system.
languageStringFalseNoThe language used for the content or record, providing localization for users in different regions or language preferences.
nopricemessageStringFalseNoThe message displayed when the item does not have a price set, typically used to inform customers about unavailable pricing.
outofstockmessageStringFalseNoThe message displayed when the item is out of stock, typically informing customers that the item is not currently available for purchase.
pagetitleStringFalseNoThe title of the page associated with the item or record, often used for SEO and navigation purposes in the website or system.
salesdescriptionStringFalseNoA description used for sales and marketing purposes, often highlighting the key features and benefits of the item to encourage purchases.
storedescriptionStringFalseNoThe description of the item or record as it appears in the store or catalog, often including key details for customers.
featureddescriptionStringFalseNoA description featured for the item or record, often used to highlight key selling points or special features.
specialsdescriptionStringFalseNoA description highlighting special offers, discounts, or promotions associated with the item, used to attract customer attention.
storedisplaynameStringFalseNoThe name displayed for the item in the store or catalog interface, used for visibility and identification in the shopping environment.
storedetaileddescriptionStringFalseNoA more detailed description of the item or record, often used for providing in-depth information about features, specifications, or usage.

Return to Top

distributionCategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
externalidStringFalseNoAn external identifier used to reference the record from external systems, enabling integration and synchronization across platforms.
isinactiveBooleanFalseNoIndicates whether the record is marked as inactive, meaning it is no longer in use or should be excluded from active processes or reporting.
nameStringFalseNoThe name of the distribution category, used to identify and categorize items or records within a specific group or classification.

Return to Top

distributionNetwork 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record, used to reference and track the distribution network within the system.
externalidStringFalseNoAn external identifier used to link the record to external systems or applications, ensuring integration and synchronization.
isinactiveBooleanFalseNoIndicates whether the distribution network is marked as inactive, meaning it is no longer in use or should be excluded from active processes.
memoStringFalseNoA note or description providing additional context or details about the distribution network, often used for internal tracking or reference.
nameStringFalseNoThe name of the distribution network, used for identification and categorization within the organization or system.

Return to Top

distributionNetworkDistributionCategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
categoryStringFalseNoThe category associated with the distribution network, used to classify and group items or records within a specific distribution structure.

Return to Top

distributionnetworksubsidiary 

NameTypeReadOnlyReferencesFilterOnlyDescription
distributionnetworkStringFalseNoThe name or identifier of the distribution network, used to track and manage the flow of goods or services across different regions or channels.

Return to Top

downloaditem 

NameTypeReadOnlyReferencesFilterOnlyDescription
availabletopartnersBooleanFalseNoIndicates whether the item is available for selection or use by partners in the system, helping manage accessibility.
billingscheduleStringFalseNoThe billing schedule associated with the item or service, used to determine the frequency and timing of billing cycles.
classStringFalseNoThe class associated with the item or transaction, used for categorization or grouping within the system for organizational purposes.
costestimateDecimalFalseNoThe estimated cost associated with the item or transaction, used for budgeting and financial planning.
costestimatetypeStringFalseNoThe type of cost estimate, such as 'Material', 'Labor', or 'Other', providing context for the cost breakdown.
createddateDatetimeFalseNoThe date and time when the record was created, providing a timestamp for when the item or record was entered into the system.
createrevenueplansonStringFalseNoIndicates the revenue plan to be used when creating revenue recognition schedules for the item or transaction.
customformStringFalseNoThe custom form associated with the record, used to tailor the data entry process for specific business needs.
daysbeforeexpirationIntegerFalseNoThe number of days before the item or transaction expires, typically used for time-sensitive offers or contracts.
deferredrevenueaccountStringFalseNoThe account used for tracking deferred revenue, representing income received but not yet recognized.
deferrevrecBooleanFalseNoIndicates whether revenue recognition is deferred, used in accounting for items or transactions where revenue is recognized over time.
departmentStringFalseNoThe department associated with the record or item, used for organizational classification or reporting purposes.
directrevenuepostingBooleanFalseNoIndicates whether revenue from the transaction is posted directly to the general ledger, bypassing traditional recognition processes.
displaynameStringFalseNoThe name displayed for the item or record in the user interface, used for easy identification and visibility.
dontshowpriceBooleanFalseNoIndicates whether the price for the item should be hidden from the user interface, often used for items requiring special pricing.
excludefromsitemapBooleanFalseNoIndicates whether the item or page should be excluded from the website's sitemap, affecting search engine visibility.
externalidStringFalseNoAn external identifier used to link the record to external systems or applications, ensuring integration with third-party services.
featureddescriptionStringFalseNoA brief description featured for the item, often highlighting key selling points or attributes to attract attention.
immediatedownloadBooleanFalseNoIndicates whether the item is available for immediate download after purchase or transaction.
includechildrenBooleanFalseNoIndicates whether related child records (such as subcategories or components) should be included in the context of the current record.
incomeaccountStringFalseNoThe account used for tracking income associated with the item, typically used for financial reporting.
internalidIntegerFalseNoThe unique internal identifier for the record, used for tracking and referencing the item within the system.
isdonationitemBooleanFalseNoIndicates whether the item is a donation item, often used in contexts involving charitable contributions or fundraising.
isfulfillableBooleanFalseNoIndicates whether the item is fulfillable, meaning it can be shipped or provided to customers as part of the transaction.
isgcocompliantBooleanFalseNoIndicates whether the item complies with GCO (Global Compliance Organization) regulations, often relevant for international trade.
isinactiveBooleanFalseNoIndicates whether the item is marked as inactive, meaning it is not available for use or selection in current transactions.
isonlineBooleanFalseNoIndicates whether the item is available for purchase or viewing online, helping manage online product availability.
issueproductStringFalseNoThe product related to the issue, often used in contexts involving product management or issue resolution.
itemidStringFalseNoThe unique identifier for the item, used to track and reference the specific product or service.
itemoptionsStringFalseNoThe options available for the item, such as size, color, or configuration, used to customize the item during purchase.
itemrevenuecategoryStringFalseNoThe revenue category associated with the item, used for categorizing revenue streams and reporting.
itemtypeStringFalseNoThe type of item, such as 'Inventory', 'Non-inventory', 'Service', used for categorization and accounting purposes.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified, providing an audit trail for changes made to the item.
locationStringFalseNoThe location associated with the item, often used for inventory management, fulfillment, or tracking purposes.
maxdonationamountDecimalFalseNoThe maximum donation amount allowed for this item, often relevant for charitable items or donation-based transactions.
metataghtmlStringFalseNoHTML tags used for meta descriptions or SEO purposes, helping optimize the item's visibility in search engines.
mossappliesBooleanFalseNoIndicates whether MOSS (Mini One Stop Shop) applies to the item, relevant for EU tax regulations on digital services.
nopricemessageStringFalseNoThe message displayed when the item does not have a price set, typically informing customers that pricing is unavailable.
numofalloweddownloadsIntegerFalseNoThe number of times the item can be downloaded, typically used for digital products or content with limited access.
offersupportBooleanFalseNoIndicates whether the item comes with support services, such as customer service or technical assistance.
outofstockbehaviorStringFalseNoThe behavior or action taken when the item is out of stock, such as 'Notify customer' or 'Allow backorder'.
outofstockmessageStringFalseNoThe message displayed when the item is out of stock, typically informing customers that the item is unavailable for purchase.
overallquantitypricingtypeStringFalseNoThe type of pricing applied to the overall quantity of items, such as 'Volume Pricing' or 'Bulk Discounts'.
pagetitleStringFalseNoThe title of the page associated with the item or record, often used for SEO and navigation purposes in the website or system.
parentStringFalseNoThe parent record or category associated with the current item, used to establish hierarchical relationships in the system.
pricinggroupStringFalseNoThe pricing group associated with the item, used to manage different pricing tiers or customer segments.
quantitypricingscheduleStringFalseNoThe schedule or structure for quantity-based pricing, used to define price breaks or discounts based on order quantities.
relateditemsdescriptionStringFalseNoA description of related items, often displayed to customers as suggestions for complementary products or services.
revenueallocationgroupStringFalseNoThe group used to allocate revenue across multiple entities or products, ensuring proper financial tracking.
revenuerecognitionruleStringFalseNoThe rule governing when revenue for the item is recognized, important for accounting and compliance purposes.
revrecforecastruleStringFalseNoThe rule used to forecast revenue recognition for the item, typically used in subscription-based or long-term contract scenarios.
revrecscheduleStringFalseNoThe schedule that determines how revenue is recognized over time for the item, used for compliance with accounting standards.
salesdescriptionStringFalseNoA description used for sales and marketing purposes, highlighting the key features and benefits of the item to encourage purchases.
searchkeywordsStringFalseNoKeywords associated with the item, used for improving search engine visibility and helping customers find the item in searches.
showdefaultdonationamountBooleanFalseNoIndicates whether the default donation amount is shown for the item, often used in charitable contributions.
sitemappriorityStringFalseNoThe priority of the item in the sitemap, used for search engine optimization to indicate the importance of the page.
storedescriptionStringFalseNoA description of the item or record as it appears in the store or catalog, often including key details for customers.
storedetaileddescriptionStringFalseNoA more detailed description of the item or record, providing in-depth information about its features, specifications, or uses.
storedisplayimageStringFalseNoThe image used to display the item in the store or catalog, typically used for product listings and visual representation.
storedisplaynameStringFalseNoThe name displayed for the item in the store or catalog, used for visibility and identification in the shopping environment.
storedisplaythumbnailStringFalseNoThe thumbnail image used for previewing the item in the store or catalog, often used for smaller views or grids.
storeitemtemplateStringFalseNoThe template used for displaying the item in the store, often used to ensure consistency across product pages.
subsidiaryStringFalseNoThe subsidiary associated with the record, used to track transactions within the larger organization structure.
subtypeStringFalseNoThe subtype associated with the item or record, used for further categorization or classification based on more specific criteria.
taxscheduleStringFalseNoThe tax schedule associated with the item, used to determine the applicable tax rates or rules for the item.
upccodeStringFalseNoThe Universal Product Code (UPC) for the item, used for product identification and barcode scanning.
urlcomponentStringFalseNoThe URL component associated with the item, used for managing URLs for the product page or item-related links.
usemarginalratesBooleanFalseNoIndicates whether marginal tax rates should be used for the item, relevant for certain tax calculation scenarios.
vsoedeferralStringFalseNoThe deferral rule associated with the item, used for revenue recognition in specific sales or subscription scenarios.
vsoedeliveredBooleanFalseNoIndicates whether the item has been delivered under VSOE (Vendor-Specific Objective Evidence) terms, used in revenue recognition.
vsoepermitdiscountStringFalseNoIndicates whether the item is eligible for discount under VSOE terms, relevant for pricing and revenue recognition.
vsoepriceDecimalFalseNoThe price associated with the item under VSOE terms, used for compliance with accounting standards for revenue recognition.
vsoesopgroupStringFalseNoThe SOP (Sales Order Processing) group associated with the item under VSOE terms, used for tracking sales and revenue recognition.

Return to Top

downloadItemCorrelateditem 

NameTypeReadOnlyReferencesFilterOnlyDescription
correlationfldDoubleFalseNoThe correlation percentage, indicating the strength and direction of the relationship between two variables or items.
countfldIntegerFalseNoThe count of occurrences or instances of a specific item or event, used for tracking frequencies or quantities.
itemStringFalseNoThe identifier or name of the item, used to reference and track products, services, or other inventory within the system.
itemnkeyfldStringFalseNoThe key identifier for the item, used to uniquely reference the item in the system for tracking or relational purposes.
liftfldDoubleFalseNoThe lift percentage, used to measure the effectiveness or impact of a marketing or sales campaign relative to a baseline.

Return to Top

downloadItemItemAccountingBookDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with the record, used for managing financial transactions and reports according to different accounting standards.
itemStringFalseNoThe identifier or name of the item, used to reference and track products, services, or other inventory within the system.

Return to Top

downloadItemItemQuantityPricingDiscount 

NameTypeReadOnlyReferencesFilterOnlyDescription
leveldiscountDoubleFalseNoThe discount percentage or amount applied at a specific price level, used to offer different pricing structures based on customer segments or order volume.
levelpricenameStringFalseNoThe name of the price level associated with the item, used to differentiate between different pricing strategies or customer categories.
parentitemStringFalseNoThe parent item associated with the current record, used to establish a hierarchical relationship between items, such as in kits or bundles.

Return to Top

downloadItemItemQuantityPricingLevel 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe identifier or name of the item, used to reference and track products, services, or other inventory within the system.
leveldiscountDoubleFalseNoThe discount percentage applied to the item at a specific pricing level, used for managing price reductions based on criteria such as volume or customer tier.

Return to Top

downloadItemPresentationItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
basepriceDecimalFalseNoThe base price of the item, typically representing its standard price before any discounts, promotions, or taxes are applied.
descriptionStringFalseNoA detailed description of the item, providing context, features, specifications, or other relevant information about the product.
onlinepriceDecimalFalseNoThe price of the item as listed online, which can differ from the base price due to promotions, discounts, or special pricing for online sales.
presentationitemStringFalseNoA related item that is presented alongside the current item, often used for cross-selling or product bundling.
presitemidIntegerFalseNoThe internal ID used to uniquely identify the related presentation item within the system for tracking or reference purposes.
superitemStringFalseNoThe parent or primary item related to this item, often used for categorization or hierarchical organization of items within the inventory.

Return to Top

downloadItemPrice 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencypageStringFalseNoThe currency associated with the item or transaction, used to indicate the denomination in which the price or amount is expressed.
discountdisplayDoubleFalseNoThe default discount percentage applied to the item, used to indicate the standard discount given across pricing levels or promotions.
isinactiveBooleanFalseNoIndicates whether the item or record is inactive, meaning it is not available for selection or transactions within the system.
itemStringFalseNoThe identifier or name of the item, used to reference and track products, services, or other inventory within the system.
priceDecimalFalseNoThe amount representing the price of the item or service, typically before any taxes or additional fees are applied.

Return to Top

downloadItemQuantity 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe identifier or name of the item, used to reference and track products, services, or other inventory within the system.
maxcountIntegerFalseNoThe maximum count or quantity allowed for the item, typically used to set inventory limits or purchase restrictions.
mincountIntegerFalseNoThe minimum count or quantity required for the item, often used to manage stock levels or enforce minimum order amounts.

Return to Top

downloadItemSiteCategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
categorydescriptionStringFalseNoA description of the category, providing context or additional details to help users understand the purpose or scope of the category.
isdefaultBooleanFalseNoIndicates whether this category is the default or preferred category, typically used to highlight the main category in user interfaces or product listings.
itemStringFalseNoThe identifier or name of the item, used to reference and track products, services, or other inventory within the system.
websiteStringFalseNoThe website or site associated with the item or category, typically used to link to the relevant online store or product page.

Return to Top

downloadItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe identifier or name of the item, used to reference and track products, services, or other inventory within the system.

Return to Top

downloadItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe identifier or name of the item, used to reference and track products, services, or other inventory within the system.
displaynameStringFalseNoThe name displayed for the item or record in the user interface, used for easy identification and visibility in product listings.
languageStringFalseNoThe language in which the content is presented, used to accommodate various customer preferences for localization.
nopricemessageStringFalseNoThe message displayed when the item does not have a price set, informing customers that pricing is unavailable for this item.
outofstockmessageStringFalseNoThe message displayed when the item is out of stock, informing customers that the item is not currently available for purchase.
pagetitleStringFalseNoThe title of the page associated with the item or record, used for SEO and navigation purposes within the website or system.
salesdescriptionStringFalseNoA description used for sales and marketing purposes, highlighting the key features and benefits of the item to encourage purchases.
storedescriptionStringFalseNoThe description of the item or record as it appears in the store or catalog, often including key details for customers.
featureddescriptionStringFalseNoA description featured for the item or record, often used to highlight key selling points, special offers, or unique features.
specialsdescriptionStringFalseNoA description highlighting special offers, discounts, or promotions associated with the item to attract customer attention.
storedisplaynameStringFalseNoThe name displayed for the item in the store or catalog, used to identify the product in the shopping environment.
storedetaileddescriptionStringFalseNoA more detailed description of the item, often used for providing in-depth information about the product’s features, specifications, or usage.

Return to Top

EffectivityBasedOnType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier used to reference or track a specific record or element within the system.

Return to Top

EmailPreferenceType 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalidIntegerFalseNoThe unique internal identifier for the record, used to reference and track it within the system.
idStringFalseNoThe general identifier for the record, often used as a reference in external systems or for data integration purposes.

Return to Top

emailtemplate 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record, used to track and reference it within the system.
addcompanyaddressBooleanFalseNoIndicates whether the company address should be automatically added to the message footer during bulk merges.
addunsubscribelinkBooleanFalseNoIndicates whether an unsubscribe link should be automatically included in the message footer during bulk merges, typically used for email marketing.
contentStringFalseNoThe content or body of the message, often containing the main text, HTML, or other elements that make up the message body.
descriptionStringFalseNoA detailed description of the record or template, providing context or additional information about its purpose or contents.
isautoconvertedBooleanFalseNoIndicates whether the template is automatically converted from another format or system, typically during an import or migration process.
isinactiveBooleanFalseNoIndicates whether the record is marked as inactive, meaning it is not currently in use or visible in active processes.
isprivateBooleanFalseNoIndicates whether the template or record is private, restricting access or visibility to only specific users or roles.
mediaitemStringFalseNoThe media item associated with the record, such as an image, video, or other content used within the template or message.
nameStringFalseNoThe name of the template or record, typically used for identification and referencing in the system.
recordtypeStringFalseNoThe type of record, such as 'Email', 'Template', or other classifications used to categorize and track different record types.
scriptidStringFalseNoThe unique identifier for the script associated with the record, often used in automation or system integration.
subjectStringFalseNoThe subject line of the message, typically used in email templates or communications to summarize the content.

Return to Top

employee 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the employee record, used to track and reference it within the system.
accountnumberStringFalseNoThe account number associated with the employee, typically used for payroll or accounting purposes.
aliennumberStringFalseNoThe alien registration number associated with an employee, typically used for immigration or work authorization tracking.
approvallimitDecimalFalseNoThe maximum amount that the employee is authorized to approve for expenses, typically used for budgeting and expense management.
approverStringFalseNoThe individual responsible for approving the employee's expenses or transactions, typically a manager or supervisor.
authworkdateDateFalseNoThe date until the employee is authorized to work, typically used for managing work authorization or visa status.
billpayBooleanFalseNoIndicates whether the employee is eligible for online bill payments, typically used for payroll or reimbursement systems.
birthdateDateFalseNoThe employee's date of birth, typically used for identity verification or benefits management.
classStringFalseNoThe class associated with the employee, used for categorization and classification within organizational or payroll systems.
commentsStringFalseNoNotes or additional comments about the employee, typically used for internal communication or record-keeping.
currencyStringFalseNoThe currency associated with the employee's pay or expenses, used for reporting and processing payments in the correct currency.
datecreatedDateFalseNoThe date when the employee record was created, important for tracking the employee's tenure within the system.
defaultacctcorpcardexpStringFalseNoThe default account to which corporate card expenses will be charged, typically used for tracking and allocating corporate card spending.
defaultexpensereportcurrencyStringFalseNoThe default currency for the employee's expense reports, ensuring consistency in financial reporting.
defaultjobresourceroleStringFalseNoThe default job resource role for the employee, used for categorizing their responsibilities or function in job-related tasks.
departmentStringFalseNoThe department in which the employee works, used for organizational classification and reporting.
eligibleforcommissionBooleanFalseNoIndicates whether the employee is eligible for commission-based compensation, typically used for sales roles.
emailStringFalseNoThe employee's email address, used for communication within the organization.
employeestatusStringFalseNoThe current status of the employee, such as 'Active', 'On Leave', or 'Terminated', used for HR and reporting purposes.
employeetypeStringFalseNoThe type of employment the individual holds, such as 'Full-Time', 'Part-Time', 'Contractor', or 'Intern'.
entityidStringFalseNoA unique identifier for the employee entity, typically used in systems with multiple entities or business units.
ethnicityStringFalseNoThe employee's ethnicity, used for diversity reporting and compliance purposes.
expenselimitDecimalFalseNoThe maximum amount the employee can expense for a particular period, typically used to control spending within corporate policies.
externalidStringFalseNoAn external identifier used to link the employee record with external systems or third-party services.
firstnameStringFalseNoThe employee's first name, used for personal identification and records.
genderStringFalseNoThe employee's gender, used for personal identification and diversity reporting.
giveaccessBooleanFalseNoIndicates whether the employee is granted access to the system or specific resources, often used for security management.
globalsubscriptionstatusStringFalseNoThe global status of the employee's subscription to benefits, training, or other global programs.
hiredateDateFalseNoThe date the employee was hired, marking the start of their employment with the organization.
i9verifiedBooleanFalseNoIndicates whether the employee's I-9 form has been verified, ensuring compliance with employment eligibility verification laws.
initialsStringFalseNoThe employee's initials, often used for identification in systems where full names are not required.
isinactiveBooleanFalseNoIndicates whether the employee record is marked as inactive, meaning they are no longer active within the organization.
isjobmanagerBooleanFalseNoIndicates whether the employee holds a managerial role, responsible for overseeing job functions or teams.
isjobresourceBooleanFalseNoIndicates whether the employee is considered a job resource, responsible for performing key tasks or functions within the organization.
issalesrepBooleanFalseNoIndicates whether the employee is in a sales representative role, responsible for generating revenue through sales.
issupportrepBooleanFalseNoIndicates whether the employee is in a support representative role, responsible for assisting customers or clients.
jobdescriptionStringFalseNoA detailed description of the employee's job role, outlining their responsibilities and tasks within the organization.
laborcostDecimalFalseNoThe employee's labor cost, often used in accounting for tracking expenses related to labor and compensation.
lastnameStringFalseNoThe employee's last name, used for personal identification and records.
lastreviewdateDateFalseNoThe date of the employee's last performance review, used for tracking performance evaluation history.
locationStringFalseNoThe physical or organizational location of the employee, typically used for office or remote work classification.
maritalstatusStringFalseNoThe employee's marital status, often used for benefits or tax purposes.
middlenameStringFalseNoThe employee's middle name, used for formal identification.
nextreviewdateDateFalseNoThe scheduled date for the employee's next performance review, used for tracking ongoing performance assessments.
purchaseorderapprovallimitDecimalFalseNoThe maximum amount the employee can approve for purchase orders, used for managing spending limits in procurement.
purchaseorderapproverStringFalseNoThe individual responsible for approving the employee's purchase orders, typically a manager or supervisor.
purchaseorderlimitDecimalFalseNoThe maximum value of purchase orders the employee can submit, helping control purchasing within the organization.
releasedateDateFalseNoThe employee's termination or release date, typically used for tracking employee exit from the organization.
residentstatusStringFalseNoThe employee's residency status, such as 'Citizen', 'Permanent Resident', or 'Work Visa', used for legal and tax compliance.
salesroleStringFalseNoThe role of the employee in the sales process, used to categorize sales responsibilities, such as 'Sales Manager' or 'Account Executive'.
salutationStringFalseNoA formal salutation used for the employee, such as 'Mr.', 'Ms.', or 'Dr.', often used in official communications.
subsidiaryStringFalseNoThe subsidiary or business unit within the organization to which the employee belongs.
supervisorStringFalseNoThe name of the employee's supervisor or manager, typically used for organizational hierarchy and reporting purposes.
targetutilizationDoubleFalseNoThe target utilization rate for the employee, often used in resource management to measure the efficiency of time spent on billable tasks.
timeapproverStringFalseNoThe individual responsible for approving the employee's time entries, such as a manager or team lead.
titleStringFalseNoThe job title of the employee, used for classification and role identification within the organization.
visaexpdateDateFalseNoThe expiration date of the employee's visa, used for compliance with immigration and work authorization regulations.
visatypeStringFalseNoThe type of visa the employee holds, relevant for work authorization and compliance purposes.
workcalendarStringFalseNoThe work calendar associated with the employee, used for scheduling, time off management, and holiday tracking.

Return to Top

employeeAccruedTime 

NameTypeReadOnlyReferencesFilterOnlyDescription
accrualmethodStringFalseNoThe method used to accrue hours, such as 'Hourly' or 'Daily', specifying how employee accrual is calculated.
accrualrateDoubleFalseNoThe rate at which hours are accrued for the employee, often expressed as a percentage or number of hours per time period.
accruedhoursDoubleFalseNoThe total number of hours accrued by the employee, typically representing earned time off or leave hours.
effectivedateDateFalseNoThe date on which the accrual method or rate becomes effective, often marking the start of a new accrual period.
employeeStringFalseNoThe identifier or name of the employee associated with the accrual, used to track and manage their earned hours.
expirationdateDateFalseNoThe date when the accrued hours, benefits, or leave expire or must be used, often related to time-sensitive employee benefits.
inactiveBooleanFalseNoIndicates whether the accrual record is inactive, meaning the employee is no longer eligible to accrue hours or benefits.
maximumaccruedhoursDoubleFalseNoThe maximum number of hours an employee can accrue, setting a cap on the total earned hours they can accumulate.
monetaryrateDecimalFalseNoThe monetary rate associated with accrued hours, often used for converting hours into a monetary value (for example, paid time off).
resetaccruedhoursatyearendBooleanFalseNoIndicates whether accrued hours should be reset at the end of the year, often used for annual benefits or leave tracking.

Return to Top

employeeAddressbook 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoThe unique internal identifier for the record, used to track and reference it within the system.
addressbookaddressStringFalseNoThe address associated with the entity, typically used for billing, shipping, or contact purposes.
defaultbillingBooleanFalseNoIndicates whether the address is set as the default billing address for the entity, used for financial transactions.
defaultshippingBooleanFalseNoIndicates whether the address is set as the default shipping address for the entity, used for order fulfillment.
entityStringFalseNoThe identifier or name of the entity associated with the address, such as a customer, supplier, or business unit.

Return to Top

employeeAddressbookEntityAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoThe unique identifier key for the address record, used to track and reference it within the system.
addr1StringFalseNoThe first line of the address, typically used for the street address or primary location information.
addr2StringFalseNoThe second line of the address, often used for suite numbers, apartment numbers, or additional address details.
addr3StringFalseNoThe third line of the address, used for further address details when needed, such as building names or floor numbers.
addresseeStringFalseNoThe name of the recipient or individual to whom the address is associated, often used for delivery or communication purposes.
attentionStringFalseNoThe attention line, typically used to direct the address to a specific department or individual within an organization.
cityStringFalseNoThe city associated with the address, used to identify the location within a specific region.
countryStringFalseNoThe country associated with the address, used for international shipping or tax purposes.
dropdownstateStringFalseNoThe state or province associated with the address, selected from a predefined dropdown list for consistency.
overrideBooleanFalseNoIndicates whether any existing address rules or settings should be overridden, used for exceptions or special cases.
stateStringFalseNoThe state or province associated with the address, often used for region-specific services or tax rates.

Return to Top

employeeBulkMerge 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoThe entity associated with the merge operation, typically referring to the individual or organization being affected by the merge.
mergedateDateFalseNoThe date and time when the merge operation was performed, used for tracking the timing of the merge process.
mergetypeStringFalseNoThe type of merge operation being performed, such as 'Data Merge', 'Record Merge', or other classification based on the operation.
statusStringFalseNoThe current status of the merge operation, such as 'Pending', 'Completed', or 'Failed', used for tracking progress.
subjectStringFalseNoThe subject of the merge operation, typically summarizing the purpose or focus of the merge.
templateStringFalseNoThe template used in the merge operation, often defining the structure and format of the data or records being merged.
usernameStringFalseNoThe username of the individual performing the merge, used for tracking and auditing purposes.

Return to Top

employeeCampaigns 

NameTypeReadOnlyReferencesFilterOnlyDescription
campaignStringFalseNoThe campaign associated with the record, typically used to track marketing or outreach initiatives.
campaigneventStringFalseNoThe event associated with the campaign, used to track specific actions or activities related to the campaign.
categoryStringFalseNoThe category associated with the record, used for classification and organization of campaigns or responses.
contactStringFalseNoThe contact person associated with the record, typically the individual who received communication or is involved in the campaign.
datesentDateFalseNoThe date when the communication or campaign was sent, used for tracking timing and response windows.
entityStringFalseNoThe entity associated with the record, which could refer to the organization, department, or individual involved.
responseStringFalseNoThe details of the response, typically capturing the recipient's reply or action in relation to the campaign.
responsedateDateFalseNoThe date when the response was received, used for tracking engagement and follow-up timing.

Return to Top

employeechangerequest 

NameTypeReadOnlyReferencesFilterOnlyDescription
declinedbyStringFalseNoThe individual or entity who declined the request, typically used for tracking approval or rejection in the system.
decliningreasonStringFalseNoThe reason provided for declining the request, often used for documentation or auditing purposes.
employeeStringFalseNoThe employee associated with the request or record, typically used for identifying the individual involved in the process.
employeechangerequesttypeStringFalseNoThe type of employee change request, such as 'Promotion', 'Leave of Absence', or 'Salary Adjustment', used to categorize requests.
externalidStringFalseNoAn external identifier used to link the record with external systems or services, enabling integration and synchronization.
idIntegerFalseNoThe unique identifier for the record, used to track and reference it within the system.
internalidIntegerFalseNoThe internal identifier for the record, often used for backend tracking and system management.
isinactiveBooleanFalseNoIndicates whether the record is marked as inactive, meaning it is no longer in use or relevant within the active process.
justificationStringFalseNoThe justification provided for the request, often used to explain the need or reason behind the action being requested.
nextapproverStringFalseNoThe individual or role responsible for the next level of approval in the process, ensuring the request moves forward in the approval hierarchy.
origbinactiveBooleanFalseNoIndicates whether the original record or request was inactive before the change was proposed, used for tracking changes over time.
proposeddateDateFalseNoThe date when the change or request was proposed, used for timeline tracking and historical reference.
requesterStringFalseNoThe individual who initiated or submitted the request, typically the person who needs the change or action to be approved.
requeststatusStringFalseNoThe current status of the request, such as 'Pending', 'Approved', 'Denied', or 'Completed', used for tracking the approval process.

Return to Top

employeechangerequesttype 

NameTypeReadOnlyReferencesFilterOnlyDescription
changereasonStringFalseNoThe reason for the change, used to explain the cause or justification behind the update or modification.
descriptionStringFalseNoA detailed description of the record or change, providing context or additional information about its purpose or impact.
externalidStringFalseNoAn external identifier used to link the record with external systems or services, ensuring integration and synchronization.
idIntegerFalseNoThe unique identifier for the record, used to track and reference it within the system.
internalidIntegerFalseNoThe internal identifier for the record, typically used for backend tracking and management within the system.
isinactiveBooleanFalseNoIndicates whether the record is marked as inactive, meaning it is no longer in use or relevant in active processes.
nameStringFalseNoThe name associated with the record, typically used for identification and reference purposes.
origbinactiveBooleanFalseNoIndicates whether the original record was inactive before the change, helping track changes in status over time.

Return to Top

employeeCompanyContribution 

NameTypeReadOnlyReferencesFilterOnlyDescription
effectivedateDateFalseNoThe date when the record or change becomes effective, marking the start of the action or status change.
employeeStringFalseNoThe employee associated with the record, typically used to identify the individual whose payroll or contribution details are being tracked.
expirationdateDateFalseNoThe date when the record or contribution expires or becomes no longer valid, often used for time-sensitive benefits or actions.
inactiveBooleanFalseNoIndicates whether the record is marked as inactive, meaning it is no longer in use or relevant in the current process.
limitDecimalFalseNoThe maximum value or limit associated with the record, often used for financial or benefit thresholds such as contribution caps.
payrollitemStringFalseNoThe item or category related to the company's contribution, often referring to specific payroll deductions or benefits.
rateStringFalseNoThe rate associated with the payroll item or contribution, often expressed as a percentage or fixed amount.

Return to Top

employeeDeduction 

NameTypeReadOnlyReferencesFilterOnlyDescription
effectivedateDateFalseNoThe date when the record or change becomes effective, marking the start of the action or status change.
employeeStringFalseNoThe employee associated with the record, used to identify the individual whose payroll deductions are being tracked.
expirationdateDateFalseNoThe date when the record or deduction expires, indicating when the deduction or benefit is no longer valid.
inactiveBooleanFalseNoIndicates whether the record is marked as inactive, meaning it is no longer in use or relevant in the current payroll cycle.
limitDecimalFalseNoThe maximum value or cap associated with the deduction, often used to control the total amount deducted from an employee's payroll.
payrollitemStringFalseNoThe specific payroll deduction item, often used to reference types of deductions such as taxes, insurance, or retirement contributions.
rateStringFalseNoThe rate associated with the payroll deduction, which could be a percentage of the salary or a fixed amount to be deducted.

Return to Top

employeeEarning 

NameTypeReadOnlyReferencesFilterOnlyDescription
defaultearningBooleanFalseNoIndicates whether the earning is set as the default for the employee, typically used to identify standard earnings.
defaulthoursDoubleFalseNoThe default number of hours associated with the earning, often used for payroll calculations when no other hours are specified.
effectivedateDateFalseNoThe date when the earning record or change becomes effective, marking the start of its application in the payroll cycle.
employeeStringFalseNoThe employee associated with the earning record, used to identify the individual receiving the earnings.
expirationdateDateFalseNoThe date when the earning expires or becomes no longer valid, typically used for time-sensitive earnings or bonuses.
inactiveBooleanFalseNoIndicates whether the earning record is marked as inactive, meaning it is no longer in use or applicable in the current payroll cycle.
payrateDoubleFalseNoThe rate associated with the earning, typically indicating the amount paid per unit (for example, hourly rate or salary rate).
payrollitemStringFalseNoThe specific payroll item associated with the earning, often referring to a type of pay such as 'Bonus' or 'Overtime'.
paytypeStringFalseNoThe type of pay item, used to categorize the earning (for example, 'Hourly', 'Salary', 'Commission').
primaryearningBooleanFalseNoIndicates whether this earning is the primary or most significant earning for the employee, typically used for regular pay.

Return to Top

employeeEmergencyContact 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique identifier for the record, used to track and reference it within the system.
addressStringFalseNoThe emergency address associated with the employee, typically used for contact purposes in case of emergencies.
contactStringFalseNoThe name of the primary contact associated with the emergency address, typically used for emergency situations or notifications.
employeeStringFalseNoThe employee associated with the emergency contact record, used to link the emergency details to the specific individual.

Return to Top

employeeEmpPerms 

NameTypeReadOnlyReferencesFilterOnlyDescription
employeeStringFalseNoThe identifier or name of the employee associated with the record, used to link the data to the individual.
nameStringFalseNoThe name associated with the record, typically used for identification or reference within the system.
permlevel1StringFalseNoThe permission level associated with the employee, used to define their access rights or role within the organization.

Return to Top

EmployeeExpenseReportCurrencies 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencyStringFalseNoThe type of currency associated with the record, typically represented by an ISO code (for example, USD, EUR) for financial transactions.

Return to Top

employeeexpensesourcetype 

NameTypeReadOnlyReferencesFilterOnlyDescription
customformStringFalseNoThe custom form associated with the record, used to manage specific data entry forms or templates tailored for unique business needs.
descriptionStringFalseNoA detailed description of the record, providing context, key features, or relevant information about its purpose or content.
externalidStringFalseNoAn external identifier used to link the record with external systems or services, ensuring integration with other platforms.
idIntegerFalseNoThe unique internal identifier for the record, used to track and reference it within the system.
isinactiveBooleanFalseNoIndicates whether the record is marked as inactive, meaning it is no longer in use or visible in current processes or reports.
nameStringFalseNoThe name associated with the record, typically used for identification and reference purposes within the system.
templatestoredBooleanFalseNoIndicates whether the template is stored, typically used to determine if a specific format or template is saved for reuse.

Return to Top

EmployeeFilingStatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
defaultBooleanFalseNoIndicates whether the record is set as the default, typically used to specify the standard or primary option for the employee or record.
payrollitemIntegerFalseNoThe unique identifier for the payroll item, used to track and reference specific payroll-related items, such as deductions or earnings.
validfilingstatusStringFalseNoThe key representing the valid filing status for the employee, typically used for tax purposes, such as 'Single', 'Married', or 'Head of Household'.

Return to Top

employeeHCMPosition 

NameTypeReadOnlyReferencesFilterOnlyDescription
employeeStringFalseNoThe identifier or name of the employee, used to link the record to the specific individual within the organization.
employmentcategoryStringFalseNoThe category of employment for the employee, such as 'Full-Time', 'Part-Time', or 'Contractor'.
fulltimeequivalentDoubleFalseNoThe full-time equivalent (FTE) for the employee, used to represent the employee's workload as a proportion of a full-time role.
locationStringFalseNoThe location associated with the employee's position, often used to track office assignments or remote work locations.
positionStringFalseNoThe job position or role held by the employee, used to define their responsibilities within the organization.
positionallocationDoubleFalseNoThe allocated FTE for the employee's position, indicating the percentage of a full-time role that the position occupies.
positionidStringFalseNoThe unique identifier for the position, used to track and reference the specific job or role within the organization.
primarypositionBooleanFalseNoIndicates whether this position is the employee's primary role, typically used when the employee holds multiple positions.
reportstoStringFalseNoThe individual or role to whom the employee reports, used to track the employee's supervisor or manager.

Return to Top

employeeHrEducation 

NameTypeReadOnlyReferencesFilterOnlyDescription
degreeStringFalseNoThe degree earned by the employee, such as 'Bachelor's', 'Master's', or 'Doctorate', indicating their educational qualification.
degreedateDateFalseNoThe date on which the employee's degree was conferred or awarded, marking the completion of their education.
educationStringFalseNoThe level of education attained by the employee, such as 'High School', 'Associate's Degree', or 'Bachelor's Degree'.
employeeStringFalseNoThe identifier or name of the employee, used to link the education record to the specific individual within the organization.

Return to Top

employeeListPresItemPresCategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
basepriceDecimalFalseNoThe base price of the item, typically representing its standard price before any discounts, promotions, or taxes are applied.
categoryStringFalseNoThe category to which the item belongs, used to classify and organize items for easier reference and management.
descriptionStringFalseNoA detailed description of the item, providing context, features, or relevant information about the product.
filecabinetStringFalseNoThe file cabinet or storage location where related documents or information about the item are stored, used for organization and easy access.
infoitemStringFalseNoAn item containing additional information or resources related to the product, often used for customer support or documentation.
itemStringFalseNoThe identifier or name of the item, used to reference and track products, services, or other inventory within the system.
nameStringFalseNoThe name of the item, typically used for identification and display purposes in the catalog or product listing.
onlinepriceDecimalFalseNoThe price of the item as listed online, which can be adjusted for online promotions, shipping, or exclusive discounts.

Return to Top

employeeListSiteCategoryTagSubstitution 

NameTypeReadOnlyReferencesFilterOnlyDescription
sectionStringFalseNoThe section to which the record belongs, used for categorizing or grouping related items, data, or content.
valueStringFalseNoThe substitution value, typically used to replace or update a specific data point within a system or template.

Return to Top

employeeListSiteCategoryTranslationEmployeeList 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoA brief description of the category, used to summarize key details or attributes for quick reference.
displaynameStringFalseNoThe name displayed for the category, typically used for identification or labeling within the user interface or catalog.
languageStringFalseNoThe language in which the content is presented, used to support multi-lingual and localized information for various audiences.
pagetitleStringFalseNoThe title of the page associated with the category, often used for SEO and navigation purposes on websites or in the system.
salesdescriptionStringFalseNoA more detailed description of the category, typically used for sales and marketing purposes to provide in-depth information about the offering.

Return to Top

employeeroles 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityIntegerFalseNoThe unique identifier for the entity, used to reference and track it within the system.
centertypeStringFalseNoThe type of center associated with the entity, used to classify or categorize the type of operation or business center.
wsonlyBooleanFalseNoIndicates whether the entity is restricted to Web Services only, typically used for system or access control purposes.
deviceidonlyBooleanFalseNoIndicates whether the entity is restricted to device IDs only, used for security or device-specific configurations.
selectedroleIntegerFalseNoThe role selected for the entity, used to determine the permissions and access levels within the system.
ssoonlyBooleanFalseNoIndicates whether Single Sign-On (SSO) is required for the entity, typically used for authentication and access management.

Return to Top

employeerolesforsearch 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityIntegerFalseNoThe unique identifier for the entity, used to track and reference it within the system, such as a user or group.
roleIntegerFalseNoThe role associated with the entity, used to define the permissions, access rights, and responsibilities within the system.

Return to Top

employeestatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record, used to track and reference it within the system.
categoryStringFalseNoThe category associated with the record, used to classify and organize records based on their characteristics or type.
externalidStringFalseNoAn external identifier used to link the record with external systems or services, enabling integration and synchronization.
isinactiveBooleanFalseNoIndicates whether the record is marked as inactive, meaning it is no longer in use or relevant in current processes or reports.

Return to Top

employeeSubscriptionMessageHistory 

NameTypeReadOnlyReferencesFilterOnlyDescription
emailStringFalseNoThe email address associated with the record, used for communication purposes and sending messages.
memoStringFalseNoA brief note or comment associated with the record, often used for internal communication or reminders.
recipientStringFalseNoThe recipient of the message or record, typically used to indicate the individual or group receiving the communication.
senddateDateFalseNoThe date when the email or message was sent, used for tracking the timing of communication.
senderStringFalseNoThe sender of the email or message, used to identify the individual or system initiating the communication.

Return to Top

employeeSubscriptions 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoThe identifier or name of the entity associated with the record, used to reference and track the specific individual, group, or system involved.
lastmodifieddateDateFalseNoThe date when the record was last modified, used for tracking changes and updates to the entity or campaign.
subscriptionStringFalseNoThe campaign subscription associated with the entity, used to track the specific campaign or subscription the entity is enrolled in.

Return to Top

EmployeeSubsidiaryRelationship 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record, used to track and reference it within the system.
entityStringFalseNoThe identifier or name of the entity associated with the record, used to reference and track the specific individual or organization.
externalidStringFalseNoAn external identifier used to link the record with external systems or services, enabling integration and synchronization.
isprimarysubBooleanFalseNoIndicates whether the subsidiary is marked as the primary subsidiary, typically used for categorizing or reporting purposes.
nameStringFalseNoThe name associated with the record, typically used for identification or reference within the system.

Return to Top

employeeTaxOptions 

NameTypeReadOnlyReferencesFilterOnlyDescription
additionalallowancesIntegerFalseNoThe amount for additional exemptions or allowances, typically used for tax purposes to reduce taxable income.
addlallwncnameStringFalseNoThe name or description of the additional exemption or allowance, used for identification and classification in tax or payroll records.
employeeidStringFalseNoThe unique identifier for the employee, used to link the record to the specific individual within the system.
excreditsnameStringFalseNoThe name or description of the exemptions or allowances applied to the employee's record, often used for tax credits.
exemptBooleanFalseNoIndicates whether the employee is exempt from certain taxes or withholdings, typically used for payroll processing or tax reporting.
exemptioncreditsIntegerFalseNoThe amount of exemption or allowance credits applied to the employee's record, typically used to reduce taxable income.
overrideamountDoubleFalseNoThe amount used to override default calculations, often used to make manual adjustments to payroll or tax-related records.
payrollitemidStringFalseNoThe unique identifier for the payroll item associated with the exemption or allowance, typically used to reference the item in the payroll system.
secndallwncnameStringFalseNoThe name or description of the secondary exemption or allowance, used to identify an additional tax exemption or deduction.
secondaryallowancesIntegerFalseNoThe amount for the secondary exemption or allowance, used to further reduce taxable income or adjust payroll calculations.
statusStringFalseNoThe filing status associated with the employee, such as 'Single', 'Married', or 'Head of Household', typically used for tax calculations.

Return to Top

employeetype 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record, used to track and reference it within the system.
categoryStringFalseNoThe category associated with the record, used for classification or grouping of similar items or records within the system.
exemptBooleanFalseNoIndicates whether the record is exempt from certain rules or requirements, such as tax exemptions or other special cases.
externalidStringFalseNoAn external identifier used to link the record with external systems or services, ensuring integration and synchronization.
includeinkpiBooleanFalseNoIndicates whether the record should be included in key performance indicators (KPI) tracking, typically used for performance reporting.
isinactiveBooleanFalseNoIndicates whether the record is marked as inactive, meaning it is no longer in use or relevant in current processes or reports.

Return to Top

entity 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record, used to track and reference it within the system.
altemailStringFalseNoAn alternative email address for the individual or entity, used for secondary contact options.
altnameStringFalseNoAn alternative name associated with the record, typically used for different naming conventions or additional identities.
altphoneStringFalseNoAn alternative phone number, often used for secondary contact methods or backup communication.
commentsStringFalseNoAdditional comments or notes related to the record, used for internal communication or reference.
contactIntegerFalseNoThe identifier for the contact record associated with the entity, used to reference and track specific contact details.
customerIntegerFalseNoThe identifier for the customer record associated with the entity, used to link the contact to a specific customer.
datecreatedDateFalseNoThe date the record was created, used for tracking the history and age of the record.
emailStringFalseNoThe primary email address associated with the individual or entity, used for official communication.
employeeIntegerFalseNoThe identifier for the employee record associated with the entity, used to link the contact to a specific employee.
entityidStringFalseNoThe unique identifier for the entity, used to track and reference it in external systems or applications.
entitynumberIntegerFalseNoThe numerical identifier for the entity, often used for sorting or categorization purposes.
entitytitleStringFalseNoThe title or name associated with the entity, often used for reference or formal identification.
externalidStringFalseNoAn external identifier used to link the record with external systems or services, enabling integration.
faxStringFalseNoThe fax number associated with the entity, used for document transmission in situations requiring faxing.
firstnameStringFalseNoThe first name of the individual associated with the record, used for personal identification.
genericresourceIntegerFalseNoThe identifier for a generic resource associated with the entity, typically used in resource management systems.
groupIntegerFalseNoThe identifier for the group to which the entity belongs, often used for classification or grouping purposes.
homephoneStringFalseNoThe primary home phone number associated with the entity, used for personal contact.
isinactiveBooleanFalseNoIndicates whether the record is marked as inactive, meaning it is no longer in use or relevant in active processes.
ispersonBooleanFalseNoIndicates whether the entity is an individual person, used to differentiate between individual and organizational entities.
laborcostDecimalFalseNoThe labor cost associated with the entity, typically used in financial or resource planning.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified, used for tracking updates and changes.
lastnameStringFalseNoThe last name of the individual associated with the record, used for personal identification.
middlenameStringFalseNoThe middle name of the individual associated with the record, used for formal identification.
mobilephoneStringFalseNoThe mobile phone number associated with the individual, used for communication via mobile device.
othernameIntegerFalseNoAn identifier for other names associated with the entity, typically used for alternate or nickname references.
parentIntegerFalseNoThe identifier for the parent entity, used to establish hierarchical relationships between entities.
partnerIntegerFalseNoThe identifier for a business partner or affiliated entity, used for partnership tracking.
phoneStringFalseNoThe primary phone number associated with the entity, used for general contact.
phoneticnameStringFalseNoThe phonetic spelling of the name (for example, Furigana), used for pronunciation assistance.
projectIntegerFalseNoThe identifier for the project associated with the entity, used to link the contact to specific projects.
projecttemplateIntegerFalseNoThe identifier for the project template associated with the entity, used for template-based project management.
salutationStringFalseNoThe salutation used for addressing the individual, such as 'Mr.', 'Ms.', or 'Dr.', often used in formal communications.
titleStringFalseNoThe job title or position of the individual, used to identify their role within the organization.
toplevelparentIntegerFalseNoThe identifier for the top-level parent entity in a hierarchical structure, used for organizational management.
vendorIntegerFalseNoThe identifier for the vendor associated with the entity, used for managing supplier relationships.
typeStringFalseNoThe type of the entity, such as 'Customer', 'Vendor', or 'Employee', used for categorization and classification.

Return to Top

entityaccountmapping 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with the record, used for tracking financial transactions and reports according to different accounting standards.
classStringFalseNoThe classification or grouping of the record, often used to categorize transactions or accounts for reporting and analysis purposes.
customformStringFalseNoThe custom form associated with the record, typically used to manage specific data entry forms or templates customized to business needs.
departmentStringFalseNoThe department associated with the record, used for organizational classification and reporting purposes.
destinationaccountStringFalseNoThe account to which funds or transactions are being transferred, often used in journal entries or financial transactions.
effectivedateDateFalseNoThe date when the record or change becomes effective, marking the start of its application in the system.
enddateDateFalseNoThe date when the record or transaction expires or is no longer valid, often used for time-sensitive actions or records.
entityaccountStringFalseNoThe account associated with the entity, used to track the financial activity specific to that entity within the system.
externalidStringFalseNoAn external identifier used to link the record with external systems or services, facilitating integration and synchronization.
locationStringFalseNoThe physical or organizational location associated with the record, used for tracking the geographical or office-specific data.
sourceaccountStringFalseNoThe account from which funds or transactions are being drawn, used in journal entries or financial transactions to indicate the source of funds.
subsidiaryStringFalseNoThe subsidiary associated with the record, used to track and manage transactions or entities within a larger corporate structure.

Return to Top

EntityAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoThe unique identifier key for the address record, used to track and reference it within the system.
addr1StringFalseNoThe first line of the address, typically used for the street address or primary location information.
addr2StringFalseNoThe second line of the address, often used for suite numbers, apartment numbers, or additional address details.
addr3StringFalseNoThe third line of the address, used for further address details when needed, such as building names or floor numbers.
addrtextStringFalseNoAdditional address information, typically used for special instructions or notes about the address.
addrphoneStringFalseNoThe phone number associated with the address, typically used for contact purposes related to the address.
addresseeStringFalseNoThe name of the recipient or individual to whom the address is associated, used for delivery or communication purposes.
attentionStringFalseNoThe attention line, typically used to direct the address to a specific department or individual within an organization.
cityStringFalseNoThe city associated with the address, used to identify the location within a specific region.
countryStringFalseNoThe country associated with the address, used for international shipping or tax purposes.
dropdownstateStringFalseNoThe state or province associated with the address, selected from a predefined dropdown list for consistency.
lastmodifieddateDatetimeFalseNoThe date and time when the address record was last modified, used for tracking updates and changes.
overrideBooleanFalseNoIndicates whether any existing address rules or settings should be overridden, used for exceptions or special cases.
recordownerStringFalseNoThe individual or role responsible for owning or managing the address record, typically used for accountability and tracking.
stateStringFalseNoThe state or province associated with the address, used to classify the location within a specific geographical area.
zipStringFalseNoThe postal code or zip code associated with the address, used to further pinpoint the location for delivery or service.

Return to Top

entityAddressbook 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoThe unique internal identifier for the address record, used to track and reference it within the system.
addressbookaddressStringFalseNoThe address associated with the entity, used for billing, shipping, or contact purposes.
defaultbillingBooleanFalseNoIndicates whether the address is set as the default billing address for the entity, typically used for financial transactions.
defaultshippingBooleanFalseNoIndicates whether the address is set as the default shipping address for the entity, used for order fulfillment.
entityStringFalseNoThe identifier or name of the entity associated with the address, such as a customer, supplier, or business unit.

Return to Top

entityBulkMerge 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoThe entity associated with the merge operation, typically referring to the individual or organization involved in the merge process.
mergedateDateFalseNoThe date and time when the merge operation was performed, used for tracking when the data was merged.
mergetypeStringFalseNoThe type of merge operation being performed, such as 'Data Merge', 'Record Merge', or another type, used to categorize the merge.
statusStringFalseNoThe current status of the merge operation, such as 'Pending', 'Completed', or 'Failed', used for tracking the progress.
subjectStringFalseNoThe subject of the merge operation, typically summarizing the purpose or focus of the merge, used for easy identification.
templateStringFalseNoThe template used in the merge operation, often defining the structure and format of the data or records being merged.
usernameStringFalseNoThe username of the individual performing the merge, used for tracking who initiated the operation.

Return to Top

entitygroup 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record, used to track and reference it within the system.
commentsStringFalseNoAdditional comments or notes associated with the record, often used for internal communication or clarifications.
emailStringFalseNoThe email address associated with the record, typically used for communication purposes.
externalidStringFalseNoAn external identifier used to link the record with external systems or services, facilitating integration.
groupmembershipStringFalseNoThe membership type or classification of the entity within a group, typically used for role-based access or categorization.
groupnameStringFalseNoThe name of the group, used for identification and reference within the system.
groupownerStringFalseNoThe individual or entity that owns or manages the group, typically responsible for overseeing the group’s activities.
grouptypenameStringFalseNoThe type of group, such as 'Sales Group', 'Support Group', or other classifications, used to differentiate between various types of groups.
isinactiveBooleanFalseNoIndicates whether the group or record is marked as inactive, meaning it is no longer in use or relevant.
ismanufacturingworkcenterBooleanFalseNoIndicates whether the group or entity is associated with a manufacturing work center, typically used in production management.
isprivateBooleanFalseNoIndicates whether the group or record is marked as private, restricting access or visibility to certain users.
issalesrepBooleanFalseNoIndicates whether the group is a sales representative group, responsible for generating revenue through sales activities.
issupportrepBooleanFalseNoIndicates whether the group is a support representative group, responsible for assisting customers or clients.
laborresourcesDoubleFalseNoThe number of labor resources allocated to the group or work center, typically used for resource management and planning.
machineresourcesDoubleFalseNoThe number of machine resources allocated to the group or work center, typically used for production or operational planning.
restrictedtoownerBooleanFalseNoIndicates whether editing the group is restricted to the owner, ensuring only authorized individuals can modify the group.
restrictiongroupStringFalseNoThe group to which restrictions apply, used for limiting access or permissions to specific entities or users.
savedsearchStringFalseNoThe saved search or report associated with the group, used for filtering or querying specific records or data.
sizeIntegerFalseNoThe size of the group or record, often used to categorize or manage the scale of the group (for example, number of members).
subsidiaryStringFalseNoThe subsidiary associated with the record or group, used for tracking transactions or activities within a larger organizational structure.

Return to Top

entityGroupBulkMerge 

NameTypeReadOnlyReferencesFilterOnlyDescription
groupStringFalseNoThe group associated with the record, used to classify or organize entities or users within the system.
mergedateDateFalseNoThe date and time when the merge operation occurred, used for tracking the timing of data integration or updates.
mergetypeStringFalseNoThe type of merge operation being performed, such as 'Data Merge', 'Record Merge', or other classification based on the operation.
statusStringFalseNoThe current status of the merge operation, such as 'Pending', 'Completed', 'Failed', indicating the progress or result of the operation.
subjectStringFalseNoThe subject line or focus of the merge operation, often summarizing the purpose or key details of the merge action.
templateStringFalseNoThe template used in the merge operation, often defining the structure and format of the data or records being merged.
usernameStringFalseNoThe username of the individual performing the merge, used for tracking and auditing purposes within the system.

Return to Top

entityGroupCampaigns 

NameTypeReadOnlyReferencesFilterOnlyDescription
campaignStringFalseNoThe campaign associated with the record, typically used to track marketing or outreach initiatives.
campaigneventStringFalseNoThe event related to the campaign, used to track specific actions or activities tied to the campaign.
categoryStringFalseNoThe category associated with the record, used for classification and organization of campaigns or responses.
contactStringFalseNoThe contact person associated with the record, typically the individual who received communication or is involved in the campaign.
datesentDateFalseNoThe date when the communication or campaign was sent, used for tracking timing and response windows.
groupStringFalseNoThe group associated with the campaign or event, used to categorize or organize recipients or participants.
responseStringFalseNoThe details of the response received, typically capturing the recipient's reply or action in relation to the campaign.
responsedateDateFalseNoThe date when the response was received, used for tracking engagement and follow-up timing.

Return to Top

entityGroupMember 

NameTypeReadOnlyReferencesFilterOnlyDescription
accesslevelStringFalseNoThe level of access associated with the record, used to define the permissions and rights granted to users or entities.
bouncedaddressBooleanFalseNoIndicates whether the email address has bounced, typically used for tracking undelivered emails or failed communications.
companyStringFalseNoThe name of the company associated with the record, used for categorization and identification within the system.
contactmemberStringFalseNoThe contact person associated with the record, typically used to identify the individual involved in the transaction or communication.
contributionDoubleFalseNoThe contribution percentage associated with the entity, typically used in sales, marketing, or donation-related activities.
custjobmemberStringFalseNoThe customer associated with the job or project, used to link the record to a specific customer.
emailStringFalseNoThe email address associated with the record, used for communication purposes.
employeememberStringFalseNoThe employee associated with the record, used to link the entity to a specific employee within the organization.
groupStringFalseNoThe group associated with the record, used to categorize or organize entities into relevant classifications.
isinactiveBooleanFalseNoIndicates whether the record is marked as inactive, meaning it is no longer in use or relevant in current processes or reports.
isprimaryBooleanFalseNoIndicates whether this record is considered the primary record, typically used for categorizing important or default entries.
jobmemberStringFalseNoThe project or job associated with the record, used to link the record to a specific project or job function.
nameStringFalseNoThe name associated with the record, typically used for identification or reference purposes.
partnermemberStringFalseNoThe partner associated with the record, used to link the record to a specific business partner or affiliate.
salesrepStringFalseNoThe sales representative associated with the record, typically used to track the salesperson responsible for the transaction.
salesroleStringFalseNoThe sales role assigned to the entity, used to categorize the individual’s responsibilities or position in the sales process.
subscriptionstatusStringFalseNoThe current global subscription status of the entity, used to track the status of their subscription or membership.

Return to Top

entityGroupType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier or reference key used to track and manage the record within the system.

Return to Top

entityListType 

NameTypeReadOnlyReferencesFilterOnlyDescription
defaultnameStringFalseNoThe default name associated with the record, typically used to identify the entity or item in its default state.
entitytypeStringFalseNoThe type of entity associated with the record, such as 'Customer', 'Employee', or 'Vendor', used to classify the record within the system.
keyIntegerFalseNoThe unique identifier key for the record, used to track and reference it within the system, ensuring proper management and organization.

Return to Top

entityRate 

NameTypeReadOnlyReferencesFilterOnlyDescription
employeeStringFalseNoThe identifier or name of the employee associated with the record, used to track and manage employee-specific data.
entitycurrencyStringFalseNoThe currency associated with the entity, used to define the currency in which financial transactions or records are maintained.

Return to Top

EntityStage 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoThe unique identifier for the record, used to track and reference it within the system.

Return to Top

EntityStatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
descrStringFalseNoA detailed description of the record, used to provide additional context or relevant information about the status or stage.
entitytypeStringFalseNoThe type or stage associated with the entity, used to categorize the record into specific stages of a process or workflow.
inactiveBooleanFalseNoIndicates whether the record is marked as inactive, meaning it is no longer in use or relevant in the current process or reporting.
includeinleadreportsBooleanFalseNoIndicates whether the record should be included in lead reports, often used for filtering data in marketing or sales reports.
keyIntegerFalseNoThe unique identifier key for the record, used to track and reference it within the system, often for backend processing.
nameStringFalseNoThe name associated with the status or stage, typically used for display or identification purposes in the system.
readonlyBooleanFalseNoIndicates whether the record is read-only, meaning it cannot be modified or updated by users.

Return to Top

EntitySubsidiaryRelationship 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record, used to track and reference it within the system.
entityStringFalseNoThe identifier or name of the entity associated with the record, such as a customer, employee, or subsidiary.
externalidStringFalseNoAn external identifier used to link the record with external systems or services, facilitating integration and synchronization.
isprimarysubBooleanFalseNoIndicates whether the subsidiary is the primary subsidiary, typically used for categorization or reporting purposes.
nameStringFalseNoThe name associated with the record, typically used for identification or reference within the system.

Return to Top

estimate 

NameTypeReadOnlyReferencesFilterOnlyDescription
althandlingcostDecimalFalseNoThe additional handling cost associated with the transaction, typically used to cover extra charges for handling goods.
altsalestotalDecimalFalseNoThe alternative total sales amount, often used to track sales under different conditions or scenarios.
altshippingcostDecimalFalseNoThe alternative shipping cost, used to track any changes or adjustments to the standard shipping costs.
balanceDecimalFalseNoThe remaining balance on the account, often used in accounting to track outstanding amounts.
billaddressStringFalseNoThe billing address associated with the record, typically used for sending invoices or payment-related correspondence.
billaddresslistStringFalseNoA list of billing addresses associated with the record, often used when multiple addresses are linked to a single account.
billingaddressStringFalseNoThe billing address, used for processing payments or generating invoices.
billingscheduleStringFalseNoThe schedule for billing, typically used to manage recurring payments or billing cycles.
billisresidentialStringFalseNoIndicates whether the billing address is residential, used for shipping and tax purposes.
canhavestackableBooleanFalseNoIndicates whether the items can be stacked for shipping or storage, typically used for logistical purposes.
classStringFalseNoThe classification associated with the record, often used for categorization or organizational purposes.
consolidatebalanceDecimalFalseNoThe consolidated balance, typically used to sum balances across different accounts or entities.
couponcodeStringFalseNoThe code for a coupon, typically used for applying discounts to a transaction.
createddateDatetimeFalseNoThe date and time when the record was created, used for tracking when the record was first entered.
createdfromStringFalseNoThe source or origin of the record, often used to link it to a parent record or prior transaction.
currencyStringFalseNoThe currency associated with the record, used to specify the financial denomination for transactions.
currencynameStringFalseNoThe name of the currency, such as 'USD' or 'EUR', used for clarity in financial records.
currencysymbolStringFalseNoThe symbol of the currency, such as '$' or '€', used for easier identification of the currency.
customformStringFalseNoThe custom form used for the record, typically a template customized to the specific needs of the organization.
departmentStringFalseNoThe department associated with the record, used for categorization or organizational purposes.
discountitemStringFalseNoThe item associated with a discount, often used to apply specific discounts to particular products or services.
discountrateStringFalseNoThe rate at which the discount is applied, often expressed as a percentage of the total price.
discounttotalDecimalFalseNoThe total discount amount applied to the transaction, typically subtracted from the total sale.
duedateDateFalseNoThe due date for payment, delivery, or another event associated with the transaction or record.
emailStringFalseNoThe email address associated with the record, used for communication or notification purposes.
enddateDateFalseNoThe end date for the record, typically used to track the expiration or completion of a contract, subscription, or event.
entityStringFalseNoThe entity associated with the record, such as a customer, employee, or vendor.
entitynexusStringFalseNoThe nexus (legal or tax jurisdiction) associated with the entity, often used for tax purposes.
entitystatusStringFalseNoThe current status of the entity, such as 'Active', 'Inactive', or other classifications used for tracking.
entitytaxregnumStringFalseNoThe tax registration number associated with the entity, used for compliance and tax reporting.
estgrossprofitDecimalFalseNoThe estimated gross profit for the record or transaction, typically calculated as revenue minus cost of goods sold.
estgrossprofitpercentStringFalseNoThe estimated gross profit percentage, used to track the profitability of a transaction or entity.
exchangerateDecimalFalseNoThe exchange rate used to convert between different currencies, typically used in multi-currency transactions.
expectedclosedateDateFalseNoThe expected closing date for a transaction or deal, often used for sales or project tracking.
externalidStringFalseNoAn external identifier used to link the record with external systems or services, facilitating integration.
fobStringFalseNoThe Free On Board (FOB) term for the record, indicating the shipping terms for transportation of goods.
forecasttypeStringFalseNoThe type of forecast associated with the record, often used for sales or financial forecasting.
handlingcostDecimalFalseNoThe cost associated with handling goods or services, often used to cover additional operational expenses.
handlingtax1rateStringFalseNoThe rate of tax applied to the handling cost, typically used for compliance with tax regulations.
handlingtaxcodeStringFalseNoThe tax code associated with the handling cost, used for identifying the appropriate tax category.
includeinforecasthighStringFalseNoIndicates whether the record should be included in high-forecast scenarios, typically used for sales forecasting.
includeinforecastlowStringFalseNoIndicates whether the record should be included in low-forecast scenarios, typically used for sales forecasting.
isbasecurrencyBooleanFalseNoIndicates whether the currency is the base currency, typically used for multi-currency transactions.
ismultishiptoBooleanFalseNoIndicates whether the order can be shipped to multiple addresses, typically used in e-commerce or bulk shipping.
istaxableBooleanFalseNoIndicates whether the record or transaction is subject to tax, typically used for compliance with tax regulations.
jobStringFalseNoThe job associated with the record, typically used to link the record to a specific project or task.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified, used for tracking changes or updates.
leadsourceStringFalseNoThe source of the lead, typically used in sales to track where prospects are coming from.
linkedtrackingnumbersStringFalseNoThe tracking numbers linked to the record, typically used for shipment tracking and delivery updates.
locationStringFalseNoThe physical or operational location associated with the record, used for managing logistics or services.
memoStringFalseNoA note or comment associated with the record, often used for internal communication or clarification.
messageStringFalseNoThe message associated with the record, typically used for communication or notification purposes.
messageselStringFalseNoThe selected message or template, used for communication or notification based on predefined templates.
muccpromocodeinstanceStringFalseNoThe specific instance of a promo code being applied to the record, used for tracking promotions.
nexusStringFalseNoThe legal or tax jurisdiction associated with the record, used for tax calculation and compliance.
onetimeDecimalFalseNoThe one-time charge or fee associated with the record, typically used for non-recurring charges.
opportunityStringFalseNoThe opportunity associated with the record, typically used for sales or project tracking.
otherrefnumStringFalseNoAn alternate reference number associated with the record, often used for cross-referencing in external systems.
partnerStringFalseNoThe business partner associated with the record, used for tracking partnerships or relationships.
probabilityStringFalseNoThe probability of a successful outcome for the record, typically used in sales or opportunity tracking.
promocodeStringFalseNoThe promo code associated with the record, used to apply discounts or promotions to transactions.
promocodepluginimplStringFalseNoThe implementation of a promo code plugin, used for tracking and applying discount logic.
recurannuallyDecimalFalseNoThe annual recurring charge associated with the record, typically used for subscriptions or recurring services.
recurmonthlyDecimalFalseNoThe monthly recurring charge associated with the record, typically used for subscriptions or recurring services.
recurquarterlyDecimalFalseNoThe quarterly recurring charge associated with the record, typically used for subscriptions or recurring services.
recurweeklyDecimalFalseNoThe weekly recurring charge associated with the record, typically used for subscriptions or recurring services.
returntrackingnumbersStringFalseNoThe tracking numbers associated with returns, used for managing the return process.
salesgroupStringFalseNoThe sales group associated with the record, used to track the team responsible for sales.
salesrepStringFalseNoThe sales representative associated with the record, typically used for tracking sales performance.
shipaddressStringFalseNoThe shipping address associated with the record, used for order fulfillment and delivery.
shipaddresslistStringFalseNoA list of shipping addresses associated with the record, often used when multiple addresses are linked to an order.
shipdateDateFalseNoThe date the goods or services are shipped, used for tracking order fulfillment.
shipisresidentialStringFalseNoIndicates whether the shipping address is residential, typically used for shipping and tax purposes.
shipmethodStringFalseNoThe method of shipping used for the record, such as 'Standard', 'Express', or 'Overnight'.
shipoverrideStringFalseNoIndicates whether the shipping method or cost has been overridden, typically used for special cases.
shippingaddressStringFalseNoThe shipping address associated with the record, used for delivery of goods or services.
shippingcostDecimalFalseNoThe cost of shipping associated with the record, used for accounting or logistical purposes.
shippingcostoverriddenStringFalseNoIndicates whether the shipping cost has been overridden, typically used for special pricing or promotions.
shippingtax1rateStringFalseNoThe rate of tax applied to the shipping cost, used for tax compliance.
shippingtaxcodeStringFalseNoThe tax code associated with the shipping cost, used for proper tax classification.
sourceStringFalseNoThe source of the record, such as 'Website', 'Referral', or 'Direct Sales'.
startdateDateFalseNoThe start date for the record, typically used for subscriptions or service agreements.
statusStringFalseNoThe current status of the record, such as 'Pending', 'Completed', 'Shipped', or 'Cancelled'.
statusrefStringFalseNoThe reference status code associated with the record, used for internal tracking or integration purposes.
subsidiaryStringFalseNoThe subsidiary associated with the record, used for tracking entities within a larger corporate structure.
subsidiarytaxregnumStringFalseNoThe tax registration number for the subsidiary, used for tax reporting and compliance.
subtotalDecimalFalseNoThe subtotal for the record, often calculated as the total before taxes or discounts.
syncpartnerteamsBooleanFalseNoIndicates whether partner teams should be synchronized with the record, used for managing external collaborations.
syncsalesteamsBooleanFalseNoIndicates whether sales teams should be synchronized with the record, used for tracking sales and performance.
taxdetailsoverrideBooleanFalseNoIndicates whether tax details have been overridden for the record, typically used for manual adjustments.
taxpointdateDateFalseNoThe date when the tax point for the record is established, typically used for tax calculation purposes.
taxpointdateoverrideBooleanFalseNoIndicates whether the tax point date has been overridden, typically used for special tax scenarios.
taxregoverrideBooleanFalseNoIndicates whether the tax registration has been overridden for the record, used for compliance or custom tax settings.
taxtotalDecimalFalseNoThe total tax amount applied to the record, used for financial and tax reporting.
termsStringFalseNoThe terms of the record, typically used for payment terms or service conditions.
titleStringFalseNoThe title associated with the record, used for categorization or reference purposes.
tobeemailedBooleanFalseNoIndicates whether the record is to be emailed, typically used for communication or document delivery.
tobefaxedBooleanFalseNoIndicates whether the record is to be faxed, typically used for formal communications or paperwork.
tobeprintedBooleanFalseNoIndicates whether the record is to be printed, typically used for document processing or physical records.
totalDecimalFalseNoThe total amount for the record, often representing the sum of all charges including tax and shipping.
totalcostestimateDecimalFalseNoThe estimated total cost for the record, typically used for budgeting or planning purposes.
trackingnumbersStringFalseNoThe tracking numbers associated with the record, used for shipment tracking and delivery updates.
trandateDateFalseNoThe date of the transaction or record entry, typically used for accounting and reporting.
tranidStringFalseNoThe unique identifier for the transaction, often used for reference in accounting systems.
unbilledordersDecimalFalseNoThe total amount for orders that have not yet been billed, typically used for financial tracking.
visibletocustomerBooleanFalseNoIndicates whether the record is visible to the customer, used for customer-facing systems or reports.

Return to Top

estimateBillingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoThe unique identifier key for the address record, used to track and reference it within the system.
addr1StringFalseNoThe first line of the address, typically used for the street address or primary location information.
addr2StringFalseNoThe second line of the address, often used for suite numbers, apartment numbers, or additional address details.
addr3StringFalseNoThe third line of the address, used for further address details when needed, such as building names or floor numbers.
addresseeStringFalseNoThe name of the recipient or individual to whom the address is associated, used for delivery or communication purposes.
attentionStringFalseNoThe attention line, typically used to direct the address to a specific department or individual within an organization.
cityStringFalseNoThe city associated with the address, used to identify the location within a specific region.
countryStringFalseNoThe country associated with the address, used for international shipping or tax purposes.
dropdownstateStringFalseNoThe state or province associated with the address, selected from a predefined dropdown list for consistency.
overrideBooleanFalseNoIndicates whether any existing address rules or settings should be overridden, used for exceptions or special cases.
stateStringFalseNoThe state or province associated with the address, used to classify the location within a specific geographical area.

Return to Top

estimateItemShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoThe unique identifier key for the address record, used to track and reference it within the system.
addr1StringFalseNoThe first line of the address, typically used for the street address or primary location information.
addr2StringFalseNoThe second line of the address, used for suite numbers, apartment numbers, or additional address details.
addr3StringFalseNoThe third line of the address, used for further address details such as building names or floor numbers.
addresseeStringFalseNoThe name of the recipient or individual to whom the address is associated, often used for mailing purposes.
attentionStringFalseNoThe attention line, typically used to direct the address to a specific department or individual within the organization.
cityStringFalseNoThe city associated with the address, used to identify the location within a specific region or municipality.
countryStringFalseNoThe country associated with the address, important for international shipping or tax calculations.
dropdownstateStringFalseNoThe state or province associated with the address, selected from a predefined dropdown list for consistency.
overrideBooleanFalseNoIndicates whether any existing address rules or settings should be overridden, used for exceptions or special cases.
stateStringFalseNoThe state or province associated with the address, used to classify the location within a specific geographical area.

Return to Top

estimatePartner 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage of contribution, typically used to represent the share or involvement of a partner, employee, or entity in a project or initiative.
isprimaryBooleanFalseNoIndicates whether the partner is considered the primary partner, often used to define the lead or most significant partner in a relationship.
partnerStringFalseNoThe name or identifier of the partner, typically used to track external business relationships or collaborations.
partnerroleStringFalseNoThe role of the partner in the collaboration, used to define the specific responsibilities or functions the partner holds in the partnership.

Return to Top

estimateSalesTeam 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage of contribution made by the employee, often used to track their involvement in sales, projects, or team efforts.
employeeStringFalseNoThe identifier or name of the employee, used to link the record to a specific individual within the organization.
isprimaryBooleanFalseNoIndicates whether the employee holds the primary role, often used to identify the lead or key individual in a role or project.
salesroleStringFalseNoThe specific sales role assigned to the employee, such as 'Account Executive', 'Sales Manager', or 'Sales Representative', used to define their responsibilities within the sales process.

Return to Top

estimateShipGroup 

NameTypeReadOnlyReferencesFilterOnlyDescription
destinationaddressStringFalseNoThe address where the items are being shipped to, typically used for delivery or fulfillment purposes.
docStringFalseNoA document associated with the record, often used to track related paperwork, orders, or shipping instructions.
handlingrateDecimalFalseNoThe rate applied for handling the items, typically used to cover additional logistical or processing costs.
shippingmethodStringFalseNoThe method of shipping used for the order, such as 'Standard', 'Express', or 'Overnight', typically selected based on customer preference or urgency.
shippingrateDecimalFalseNoThe rate charged for shipping, typically calculated based on factors like weight, distance, or delivery speed.
sourceaddressStringFalseNoThe address from which the items are being shipped, typically used to track the origin of goods or materials.
uniquekeyIntegerFalseNoThe unique identifier key for the record, used to track and reference it within the system for data management and integrity.

Return to Top

estimateShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoThe unique identifier key for the address record, used to track and reference it within the system.
addr1StringFalseNoThe first line of the address, typically used for the street address or primary location information.
addr2StringFalseNoThe second line of the address, often used for suite numbers, apartment numbers, or additional address details.
addr3StringFalseNoThe third line of the address, used for further address details such as building names or floor numbers.
addresseeStringFalseNoThe name of the recipient or individual to whom the address is associated, often used for mailing or delivery purposes.
attentionStringFalseNoThe attention line, typically used to direct the address to a specific department or individual within an organization.
cityStringFalseNoThe city associated with the address, used to identify the location within a specific region or municipality.
countryStringFalseNoThe country associated with the address, important for international shipping, tax calculations, or service provisioning.
dropdownstateStringFalseNoThe state or province associated with the address, selected from a predefined dropdown list to ensure consistency.
overrideBooleanFalseNoIndicates whether any existing address rules or settings should be overridden, used for special cases or exceptions.
stateStringFalseNoThe state or province associated with the address, used to classify the location within a specific geographical area.

Return to Top

estimateTranPromotion 

NameTypeReadOnlyReferencesFilterOnlyDescription
couponcodeStringFalseNoThe code associated with a coupon, typically used to apply discounts or special offers during transactions.
promocodeStringFalseNoThe promotional code associated with the record, often used to track or apply discounts or promotional offers to transactions.
promotiontypeStringFalseNoThe type of promotion being applied, such as 'Discount', 'Buy One Get One', or 'Free Shipping', used to classify the nature of the promotion.

Return to Top

EventDowim 

NameTypeReadOnlyReferencesFilterOnlyDescription
idIntegerFalseNoThe unique identifier for the record, used to track and reference it within the system.

Return to Top

EventFrequency 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier or reference key used to track and manage the record within the system.

Return to Top

EventPriority 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoThe unique identifier for the record, used to track and reference it within the system.

Return to Top

EventType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier or reference key used to track, manage, and retrieve the record within the system.

Return to Top

excludeLocationRegionItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
locationStringFalseNoThe geographical or organizational location associated with the record, used for tracking or categorizing based on location.
rankingIntegerFalseNoThe ranking associated with the record, used to represent its position or priority in comparison to others.

Return to Top

executionContext 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoThe unique identifier for the record, used to track and reference it within the system.

Return to Top

expenseamortizationevent 

NameTypeReadOnlyReferencesFilterOnlyDescription
amountDecimalFalseNoThe monetary amount associated with the record, typically representing the value of a transaction or charge.
cumulativepercentcompleteStringFalseNoThe percentage indicating the cumulative progress or completion of the event or task, often used in project tracking.
customformStringFalseNoThe custom form associated with the record, often used to manage specific data entry forms or templates tailored for business needs.
eventdateDateFalseNoThe date of the event, used to track when the event took place or is scheduled to take place.
eventpurposeStringFalseNoThe purpose of the event, typically used to describe the reason or goal for organizing the event.
eventtypeStringFalseNoThe type of event, such as 'Meeting', 'Conference', or 'Webinar', used for categorization and reporting.
externalidStringFalseNoAn external identifier used to link the record with external systems or services, enabling integration and synchronization.
quantityDoubleFalseNoThe quantity associated with the record, typically representing the number of units or items involved in the transaction.
transactionlineStringFalseNoThe specific line item within the transaction, used to track details or components of a larger transaction.

Return to Top

expensecategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the record, used to track and reference it within the system.
defaultrateDoubleFalseNoThe default rate associated with the record, typically used to apply a standard rate for charges or transactions.
descriptionStringFalseNoA detailed description of the record, providing additional context or information about its purpose or contents.
expenseacctStringFalseNoThe expense account associated with the record, used for tracking the financial account to which the expense is allocated.
expenseitemStringFalseNoThe specific item or category of expense, used to classify and track different types of expenses.
externalidStringFalseNoAn external identifier used to link the record with external systems or services, ensuring integration and synchronization.
isinactiveBooleanFalseNoIndicates whether the record is marked as inactive, meaning it is no longer in use or relevant in current processes.
nameStringFalseNoThe name associated with the record, typically used for identification or reference purposes within the system.
personalcorporatecardexpenseBooleanFalseNoIndicates whether the expense is associated with a personal corporate card, used for managing card-based expenses.
raterequiredBooleanFalseNoIndicates whether a rate is required for the expense, typically used for transactions that need specific pricing or fee application.

Return to Top

ExpenseCategoryRate 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencyStringFalseNoThe currency associated with the record, used to specify the denomination for financial transactions or accounts.
defaultrateDoubleFalseNoThe default rate applied to the record, often used for pricing or standard charges in the absence of other rate settings.
expensecategoryStringFalseNoThe category of expense associated with the record, used to classify and organize various types of expenditures.

Return to Top

ExpenseCategoryTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoA detailed description of the record, providing additional context or information about its purpose or contents.
expensecategoryStringFalseNoThe category of expense associated with the record, used to classify and organize various types of expenditures for reporting or management.
languageStringFalseNoThe language in which the content or record is presented, enabling localization and multi-lingual support for diverse users.
nameStringFalseNoThe display name of the record, typically used for identification or presentation in user interfaces or reports.

Return to Top

expenseItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe identifier or name of the item, used to reference and track products, services, or other inventory within the system.

Return to Top

expenseItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe identifier or name of the item, used to reference and track products, services, or other inventory within the system.
displaynameStringFalseNoThe name displayed for the item in the user interface or product listing, used for easy identification.
featureddescriptionStringFalseNoA highlighted description of the item, typically used to emphasize key selling points or features.
languageStringFalseNoThe language in which the content is presented, supporting localization and multi-lingual communication.
nopricemessageStringFalseNoThe message displayed when the item does not have a price set, informing customers that pricing is unavailable.
outofstockmessageStringFalseNoThe message displayed when the item is out of stock, informing customers that the item is not currently available.
pagetitleStringFalseNoThe title of the page associated with the item, typically used for SEO and navigation purposes on the website.
salesdescriptionStringFalseNoA description used for sales and marketing, highlighting the features and benefits of the item to encourage purchase.
specialsdescriptionStringFalseNoA description highlighting any special offers, discounts, or promotions associated with the item.
storedescriptionStringFalseNoThe description of the item as it appears in the store, often providing key details for customer reference.
storedetaileddescriptionStringFalseNoA detailed description of the item, providing comprehensive information about its features, specifications, or usage.
storedisplaynameStringFalseNoThe name displayed for the item in the store or catalog, used to identify it in the shopping environment.

Return to Top

expenseMachine 

NameTypeReadOnlyReferencesFilterOnlyDescription
amountDecimalFalseNoThe monetary amount associated with the record, typically representing the value of a transaction or expense.
categoryStringFalseNoThe category associated with the expense, used for classification and organization of different types of expenses.
classStringFalseNoThe classification associated with the record, often used to categorize transactions or accounts for reporting purposes.
corporatecreditcardBooleanFalseNoIndicates whether the expense is charged to a corporate credit card, used to differentiate between personal and corporate expenses.
currencyStringFalseNoThe currency in which the expense is recorded, used for managing multi-currency transactions.
customerStringFalseNoThe customer associated with the expense, used for tracking costs or income related to specific clients or customers.
departmentStringFalseNoThe department associated with the expense, used for organizational classification and reporting purposes.
exchangerateDecimalFalseNoThe exchange rate used to convert between currencies, typically applied in multi-currency transactions.
expenseaccountStringFalseNoThe account associated with the expense, used for tracking and categorizing financial transactions.
expensedateDateFalseNoThe date when the expense occurred, used for reporting and tracking purposes.
expenseitemIntegerFalseNoThe identifier for the specific expense item, typically used to track the type or category of the expense.
expensereportStringFalseNoThe expense report associated with the record, used to group and track multiple related expenses.
foreignamountDecimalFalseNoThe amount of the expense in foreign currency, used for multi-currency transactions and conversions.
grossamtDecimalFalseNoThe total amount of the expense before any deductions, taxes, or discounts.
isbillableBooleanFalseNoIndicates whether the expense is billable to a customer, used for tracking reimbursable costs.
isnonreimbursableBooleanFalseNoIndicates whether the expense is non-reimbursable, typically used to classify expenses that cannot be claimed for reimbursement.
lineStringFalseNoThe line item associated with the expense, often used to track individual components of a larger expense record.
locationStringFalseNoThe location associated with the expense, used for tracking where the expense occurred or where the service was provided.
memoStringFalseNoAdditional notes or comments associated with the expense, often used for internal tracking or explanations.
quantityDoubleFalseNoThe quantity associated with the expense item, typically used for tracking the number of units or amount of service.
raterequiredBooleanFalseNoIndicates whether a rate is required for the expense, often used to ensure that pricing or cost information is included.
receiptBooleanFalseNoIndicates whether a receipt is available for the expense, often used to track documentation for expense validation.
refnumberIntegerFalseNoThe reference number associated with the transaction or expense, used to link it to other records or systems.
taxcodeStringFalseNoThe tax code associated with the expense, used to calculate and apply the appropriate taxes.

Return to Top

expenseplan 

NameTypeReadOnlyReferencesFilterOnlyDescription
amountDecimalFalseNoThe total amount associated with the transaction, typically representing the value of the revenue or expense.
amountsourceStringFalseNoThe source from which the amount is derived, used to track where the revenue or expense originated from.
catchupperiodStringFalseNoThe period during which the revenue or expense is caught up, typically used in scenarios where adjustments or backdating is involved.
commentsStringFalseNoAdditional notes or comments associated with the transaction, used for internal tracking or explanations.
createdfromStringFalseNoThe source or origin of the transaction, often used to link it to a parent record or prior transaction.
creationtriggeredbyStringFalseNoThe event or action that triggered the creation of the record, such as a system process or manual input.
customformStringFalseNoThe custom form used for entering or managing the record, often tailored to specific business needs.
enddatechangeimpactStringFalseNoThe impact of any changes to the end date, typically used to track the effects on related processes or calculations.
externalidStringFalseNoAn external identifier used to link the record with external systems or services, ensuring integration and synchronization.
holdrevenuerecognitionBooleanFalseNoIndicates whether revenue recognition is on hold, often used when the transaction is pending or under review.
initialamountDecimalFalseNoThe original amount associated with the record, used for tracking the starting value before adjustments or changes.
iseliminateBooleanFalseNoIndicates whether the record should be eliminated or excluded, typically used in consolidation or reporting adjustments.
itemStringFalseNoThe identifier or name of the item associated with the transaction, used to track and reference specific products or services.
periodoffsetStringFalseNoThe offset period for the transaction, typically used for adjusting the timing of revenue recognition or expense allocation.
recalcadjustperiodoffsetIntegerFalseNoThe recalculated period offset, used to adjust the timing of the revenue or expense recognition when changes occur.
recognitionmethodStringFalseNoThe method used to recognize revenue, such as 'Percentage of Completion' or 'Straight Line', determining how revenue is recorded over time.
recognitionperiodIntegerFalseNoThe period over which revenue or expenses are recognized, typically used for financial reporting and analysis.
recordnumberStringFalseNoThe unique number associated with the record, often used for reference or tracking in reporting systems.
reforecastmethodStringFalseNoThe method used for reforecasting the transaction, typically used for adjustments or changes to projected financial outcomes.
relatedrevenuearrangementStringFalseNoThe related revenue arrangement linked to the record, used to track the overall deal or contract.
relatedrevenueelementStringFalseNoThe related revenue element, used to track specific components or milestones within a larger revenue arrangement.
remainingdeferredbalanceDecimalFalseNoThe remaining deferred balance, typically used for revenue that has been recognized but not yet earned or invoiced.
residualDecimalFalseNoThe residual amount associated with the transaction, typically used to track remaining value after adjustments or deductions.
revenueplancurrencyStringFalseNoThe currency associated with the revenue plan, used to track the financial denomination for the revenue.
revenueplantypeStringFalseNoThe type of revenue plan, such as 'Recurring' or 'One-Time', used to classify the nature of the revenue recognition.
revenuerecognitionruleStringFalseNoThe rule used to recognize revenue, defining how and when revenue is recorded based on transaction terms.
revenueschedulekeyStringFalseNoThe key used to reference the revenue schedule, used to track the timing and amounts for revenue recognition.
revrecenddateDateFalseNoThe end date for revenue recognition, used to define the period when revenue recognition concludes.
revrecenddatesourceStringFalseNoThe source from which the end date for revenue recognition is derived, often used for tracking adjustments or external factors.
revrecstartdateDateFalseNoThe start date for revenue recognition, marking the beginning of the period during which revenue is recognized.
revrecstartdatesourceStringFalseNoThe source from which the start date for revenue recognition is derived, often used for tracking the impact of changes or adjustments.
startoffsetStringFalseNoThe offset period for the start of revenue recognition, used to adjust the timing when recognizing revenue from the start date.
statusStringFalseNoThe current status of the record, such as 'Pending', 'Approved', or 'Completed', used for tracking progress or approval stages.
termindaysIntegerFalseNoThe number of days until the transaction is terminated or the revenue recognition process concludes.
terminmonthsIntegerFalseNoThe number of months until the transaction is terminated or the revenue recognition process concludes.
totalrecognizedDecimalFalseNoThe total amount of revenue that has been recognized to date, used for tracking progress against projected values.
tranlineuniquekeyStringFalseNoThe unique key associated with the transaction line, used to identify and reference specific transaction entries.
transactionbookStringFalseNoThe transaction book associated with the record, typically used to group or categorize transactions for reporting purposes.
transactiondocStringFalseNoThe document associated with the transaction, such as an invoice or contract, used for reference and record-keeping.
transactionlineStringFalseNoThe specific transaction line associated with the record, used to track individual components of the overall transaction.

Return to Top

expensereport 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the record, typically used to track financial transactions or categories.
accountingapprovalBooleanFalseNoIndicates whether the transaction has been approved by the accounting department, used to track the approval status.
acctcorpcardexpStringFalseNoThe corporate card expense associated with the account, used to track expenses charged to corporate credit cards.
advanceDecimalFalseNoThe advance payment made, typically used to track payments made in advance of receiving goods or services.
amountDecimalFalseNoThe monetary amount associated with the transaction or record, typically representing the value of a payment or charge.
approvalstatusStringFalseNoThe status of the approval process, such as 'Pending', 'Approved', or 'Rejected', used to track the progress of approval.
classStringFalseNoThe classification associated with the record, used to categorize or group related transactions for reporting purposes.
completeBooleanFalseNoIndicates whether the record or transaction is complete, typically used to track whether the process or task has been finished.
createddateDatetimeFalseNoThe date and time when the record was created, used for tracking the history of the record.
customformStringFalseNoThe custom form used to manage or process the record, typically tailored to specific business needs or data entry requirements.
departmentStringFalseNoThe department associated with the record, used for classification and reporting within an organization.
duedateDateFalseNoThe date by which the payment or task is due, used for tracking deadlines or payment schedules.
entityStringFalseNoThe entity associated with the record, such as a customer, supplier, or employee, used for linking transactions to specific entities.
entitynexusStringFalseNoThe nexus (tax jurisdiction) associated with the entity, used to determine tax liability based on geographic location.
expensereportcurrencyStringFalseNoThe currency used for the expense report, typically used in multi-currency transactions for conversion and reporting.
expensereportexchangerateDecimalFalseNoThe exchange rate used to convert the expense report currency to the base currency, typically used for multi-currency financial reporting.
externalidStringFalseNoAn external identifier used to link the record with external systems or services, facilitating integration and synchronization.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified, used for tracking updates or changes to the record.
locationStringFalseNoThe location associated with the record, used for tracking the geographical or operational area related to the transaction.
memoStringFalseNoAdditional notes or comments associated with the record, often used for internal communication or explanations.
nextapproverStringFalseNoThe individual or role responsible for the next level of approval in the process, used to track the approval workflow.
nexusStringFalseNoThe tax jurisdiction associated with the record, used for determining tax obligations based on location.
policyviolatedBooleanFalseNoIndicates whether the transaction or record violates any policies, typically used to track compliance with internal rules.
postingperiodStringFalseNoThe accounting period during which the transaction is posted, typically used for financial reporting and period-end closings.
statusStringFalseNoThe current status of the record, such as 'Pending', 'Approved', or 'Rejected', used to track the stage of processing or approval.
statusRefStringFalseNoA reference code or identifier for the status, used for internal tracking or cross-referencing purposes.
subsidiaryStringFalseNoThe subsidiary associated with the record, used for tracking financial activity and reporting within a larger corporate structure.
subsidiarytaxregnumStringFalseNoThe tax registration number for the subsidiary, used for tax compliance and reporting purposes.
supervisorapprovalBooleanFalseNoIndicates whether the transaction has been approved by the supervisor, used to track the approval workflow.
taxdetailsoverrideBooleanFalseNoIndicates whether tax details have been overridden, typically used for exceptions or adjustments to tax calculations.
taxpointdateDateFalseNoThe date when tax recognition occurs, typically used to determine when tax liability is triggered for the transaction.
taxpointdateoverrideBooleanFalseNoIndicates whether the tax point date has been overridden, used for special cases or adjustments in tax accounting.
totalDecimalFalseNoThe total amount for the transaction or record, typically representing the sum of all charges, taxes, and adjustments.
trandateDateFalseNoThe date of the transaction, used for financial and accounting tracking purposes.
tranidStringFalseNoThe unique identifier for the transaction, often used for reference or cross-referencing in accounting systems.
usemulticurrencyBooleanFalseNoIndicates whether the transaction involves multiple currencies, typically used for global operations or cross-border transactions.

Return to Top

expensereportpolicy 

NameTypeReadOnlyReferencesFilterOnlyDescription
actionStringFalseNoThe action associated with the record, typically representing an operation or process like 'Create', 'Update', or 'Delete'.
customerStringFalseNoThe customer associated with the record, used to link the expense or transaction to a specific client or account.
departmentStringFalseNoThe department associated with the record, used for organizational classification and financial reporting purposes.
descriptionStringFalseNoA brief description of the record, providing context and details about its nature or purpose.
enddateDateFalseNoThe end date for the record or transaction, often used to mark the conclusion of an event, contract, or financial period.
expensecategoryStringFalseNoThe category of the expense, used for classification and reporting within financial or accounting systems.
externalidStringFalseNoAn external identifier used to link the record with external systems or services, ensuring integration and synchronization.
idIntegerFalseNoThe unique internal identifier for the record, used to track and reference it within the system.
isbillableStringFalseNoIndicates whether the expense or record is billable to the customer, used to determine if it can be invoiced.
isinactiveBooleanFalseNoIndicates whether the record is inactive, meaning it is no longer in use or relevant for current processes or transactions.
limittypeStringFalseNoThe type of limit applied to the record, such as 'Amount', 'Quantity', or 'Time', used for constraint management.
locationStringFalseNoThe location associated with the record, typically used for tracking where the transaction or activity took place.
maxamountDecimalFalseNoThe maximum amount associated with the record, used to set thresholds or caps on expenses or allocations.
nameStringFalseNoThe name associated with the record, typically used for identification or reference purposes in the system.
nowarningreqfieldincludedBooleanFalseNoIndicates whether a warning is included when a required field is not filled out, used for data validation.
requiresmemoBooleanFalseNoIndicates whether a memo is required for the record, often used for additional context or internal notes.
requiresreceiptBooleanFalseNoIndicates whether a receipt is required for the record, typically used for expense validation or reimbursement.
startdateDateFalseNoThe start date for the record, often used to track when an event, contract, or transaction begins.
subsidiaryStringFalseNoThe subsidiary associated with the record, used for tracking and reporting within a larger corporate structure.

Return to Top

fairvalueprice 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencyStringFalseNoThe currency associated with this fair value price, determining the monetary unit used for valuation.
customformStringFalseNoThe custom form identifier used to manage this fair value price within NetSuite.
enddateDateFalseNoThe date when this fair value price is no longer valid.
externalidStringFalseNoA unique external identifier for referencing this fair value price from external systems or integrations.
fairvalueDoubleFalseNoThe calculated fair value of the item, typically based on accounting standards.
fairvalueformulaStringFalseNoThe formula used to derive the fair value, if applicable.
fairvaluerangepolicyStringFalseNoThe policy governing the acceptable range for fair value pricing.
highvalueDoubleFalseNoThe upper boundary of the fair value range for this item.
highvaluepercentStringFalseNoThe percentage threshold used to determine the high-end fair value.
isvsoepriceBooleanFalseNoIndicates whether this fair value price is subject to Vendor-Specific Objective Evidence (VSOE) pricing rules.
itemStringFalseNoThe item associated with this fair value price entry.
itemrevenuecategoryStringFalseNoThe revenue category assigned to this item for financial reporting purposes.
lowvalueDoubleFalseNoThe lower boundary of the fair value range for this item.
lowvaluepercentStringFalseNoThe percentage threshold used to determine the low-end fair value.
startdateDateFalseNoThe date when this fair value price becomes effective.
unitsStringFalseNoThe unit of measure associated with this fair value price.
unitstypeStringFalseNoThe type of unit used for measuring this item's fair value.

Return to Top

FairValueRangePolicy 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoThe unique identifier for the fair value range policy, used to distinguish different pricing policies.

Return to Top

FaxTemplate 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal identifier for this fax template within NetSuite.
contentStringFalseNoThe body content of the fax template, which will be used in outgoing faxes.
descriptionStringFalseNoA brief description of the fax template, providing context for its purpose or usage.
isautoconvertedBooleanFalseNoIndicates whether this fax template is automatically converted from another format.
isinactiveBooleanFalseNoSpecifies whether this fax template is inactive and no longer in use.
isprivateBooleanFalseNoIndicates whether this fax template is private and restricted to specific users.
mediaitemStringFalseNoThe associated media item, such as an attachment or linked file, used in the fax template.
nameStringFalseNoThe name assigned to this fax template for identification and selection.
recordtypeStringFalseNoThe type of record this fax template is associated with, defining its usage scope.
subjectStringFalseNoThe subject line that will appear when this fax template is used.

Return to Top

file 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal identifier for this file within NetSuite.
addtimestamptourlBooleanFalseNoIndicates whether a timestamp is appended to the file URL to prevent caching issues.
bundleableBooleanFalseNoSpecifies whether this file can be included in a SuiteBundle for distribution.
createddateDateFalseNoThe date when this file was created in the system.
descriptionStringFalseNoA brief description of the file and its contents.
externalidStringFalseNoA unique external identifier for referencing this file in external systems or integrations.
filesizeIntegerFalseNoThe size of the file in bytes.
filetypeStringFalseNoThe document type or format of the file (such as PDF, CSV, DOCX).
folderStringFalseNoThe folder location where this file is stored within NetSuite.
hideinbundleBooleanFalseNoIndicates whether this file should be hidden when included in a SuiteBundle.
iscompanywidereadaccessBooleanFalseNoSpecifies whether all users in the company can view this file.
isinactiveBooleanFalseNoIndicates whether this file is inactive and no longer in use.
islinkBooleanFalseNoSpecifies whether this file is a link to an external resource rather than an uploaded document.
isonlineBooleanFalseNoIndicates whether this file can be accessed without logging into NetSuite.
lastmodifieddateDateFalseNoThe date when this file was last modified.
nameStringFalseNoThe name assigned to this file in NetSuite.

Return to Top

FileHits 

NameTypeReadOnlyReferencesFilterOnlyDescription
fileidStringFalseNoThe unique identifier of the file being tracked for views.
timesviewedIntegerFalseNoThe total number of times this file has been viewed.

Return to Top

financialinstitution 

NameTypeReadOnlyReferencesFilterOnlyDescription
createdbyStringFalseNoThe user who created this financial institution record in NetSuite.
createddateDateFalseNoThe date when this financial institution record was created.
descriptionStringFalseNoA brief description of the financial institution.
externalidStringFalseNoA unique external identifier for referencing this financial institution in external systems or integrations.
financialinstitutionStringFalseNoThe name of the financial institution.
idIntegerFalseNoThe system-generated unique identifier for this financial institution record.
internalidIntegerFalseNoThe internal identifier used for referencing this financial institution within NetSuite.
isinactiveBooleanFalseNoIndicates whether this financial institution record is inactive and no longer in use.
lastmodifieddateDateFalseNoThe date when this financial institution record was last modified.
modifiedbyStringFalseNoThe user who last modified this financial institution record.

Return to Top

FirstRunTimeSelect 

NameTypeReadOnlyReferencesFilterOnlyDescription
idIntegerFalseNoThe internal identifier for this first runtime selection record in NetSuite.

Return to Top

fixedamountprojectrevenuerule 

NameTypeReadOnlyReferencesFilterOnlyDescription
customformStringFalseNoThe custom form identifier used to manage this fixed amount project revenue rule within NetSuite.
descriptionStringFalseNoA brief description of the fixed amount revenue rule, explaining its purpose or application.
externalidStringFalseNoA unique external identifier for referencing this revenue rule in external systems or integrations.
fixedamounttypeStringFalseNoThe method used to determine the fixed revenue amount for this rule.
fixedscheduletypeStringFalseNoThe schedule type defining how and when the fixed revenue amount is recognized.
isinactiveBooleanFalseNoIndicates whether this revenue rule is inactive and no longer in use.
nameStringFalseNoThe name assigned to this fixed amount revenue rule for identification.
projectStringFalseNoThe project associated with this revenue rule, defining where it applies.
revenuereconciledBooleanFalseNoIndicates whether the revenue from this rule has been reconciled with accounting records.
serviceitemStringFalseNoThe service item linked to this revenue rule, specifying the billable service.

Return to Top

folder 

NameTypeReadOnlyReferencesFilterOnlyDescription
classStringFalseNoThe classification associated with this folder, used for reporting and segmentation.
departmentStringFalseNoThe department linked to this folder, helping categorize files by business unit.
descriptionStringFalseNoA brief description of the folder and its intended use.
externalidStringFalseNoA unique external identifier for referencing this folder in external systems or integrations.
foldertypeStringFalseNoThe type of folder, defining its purpose or access level within NetSuite.
groupStringFalseNoThe group that has access to this folder, specifying shared permissions.
isinactiveBooleanFalseNoIndicates whether this folder is inactive and no longer in use.
isprivateBooleanFalseNoSpecifies whether this folder is private and restricted to certain users.
locationStringFalseNoThe physical or virtual location associated with this folder.
nameStringFalseNoThe name assigned to this folder for identification within NetSuite.
ownerStringFalseNoThe user who owns and manages this folder.
parentStringFalseNoThe parent folder under which this folder is nested, defining its hierarchy.
subsidiaryStringFalseNoThe subsidiary associated with this folder, controlling access and relevance for specific entities.

Return to Top

FolderType 

NameTypeReadOnlyReferencesFilterOnlyDescription
defaultnameStringFalseNoThe default name assigned to this folder type in NetSuite.
keyStringFalseNoThe unique identifier for this folder type, used to classify different folder categories.

Return to Top

Forecast 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal identifier for this sales forecast record in NetSuite.
currencynameStringFalseNoThe currency used for this forecast, determining the monetary unit of projected sales.
enddateDateFalseNoThe date when the forecast period ends.
forecastDecimalFalseNoThe manually overridden forecasted sales amount for the period.
forecasthighDecimalFalseNoThe highest expected forecasted sales amount, representing an optimistic projection.
forecastlowDecimalFalseNoThe lowest expected forecasted sales amount, representing a conservative projection.
quotaDecimalFalseNoThe sales quota set for the forecast period, serving as the target goal.
salesrepStringFalseNoThe sales representative associated with this forecast.
startdateDateFalseNoThe date when the forecast period begins.
subsidiaryStringFalseNoThe subsidiary associated with this forecast, defining its scope within the company.

Return to Top

ForecastType 

NameTypeReadOnlyReferencesFilterOnlyDescription
snameStringFalseNoThe name of the forecast type, used to classify different sales forecasting models or methodologies.

Return to Top

formatprofile 

NameTypeReadOnlyReferencesFilterOnlyDescription
createdbyStringFalseNoThe user who created this format profile in NetSuite.
createddateDateFalseNoThe date when this format profile was created.
customformStringFalseNoThe custom form identifier associated with this format profile.
descriptionStringFalseNoA brief description of the format profile, explaining its purpose or use.
externalidStringFalseNoA unique external identifier for referencing this format profile in external systems or integrations.
financialinstitutionStringFalseNoThe financial institution associated with this format profile, defining its banking or financial relevance.
formatprofileStringFalseNoThe name or identifier of the format profile, used for structuring financial data.
idIntegerFalseNoThe system-generated unique identifier for this format profile record.
internalidIntegerFalseNoThe internal identifier used for referencing this format profile within NetSuite.
isinactiveBooleanFalseNoIndicates whether this format profile is inactive and no longer in use.
lastmodifieddateDateFalseNoThe date when this format profile was last modified.
modifiedbyStringFalseNoThe user who last modified this format profile.
templatestoredBooleanFalseNoIndicates whether a template is stored within this format profile.
transactionparserStringFalseNoThe transaction parser associated with this format profile, defining how financial transactions are processed.

Return to Top

FrequencyType 

NameTypeReadOnlyReferencesFilterOnlyDescription
defaultlongnameStringFalseNoThe default name for this frequency type, used to define recurring intervals or scheduling patterns in NetSuite.

Return to Top

FulfillmentChoice 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoThe unique identifier for this fulfillment choice, used to define different fulfillment options in NetSuite.

Return to Top

FulfillmentExceptionType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoThe unique identifier for this fulfillment exception type, used to categorize different fulfillment-related issues or errors in NetSuite.

Return to Top

fulfillmentrequest 

NameTypeReadOnlyReferencesFilterOnlyDescription
assigneeStringFalseNoThe user or department assigned to handle this fulfillment request.
createdfromStringFalseNoThe source transaction or record from which this fulfillment request was created.
customformStringFalseNoThe custom form identifier associated with this fulfillment request.
entityStringFalseNoThe customer, vendor, or entity associated with this fulfillment request.
expirationdateDateFalseNoThe date when this fulfillment request expires if not processed.
fulfillmenttypeStringFalseNoThe type of fulfillment, such as shipping or in-store pickup.
ispickupemailnotificationsentBooleanFalseNoIndicates whether an email notification has been sent for pickup fulfillment.
locationStringFalseNoThe location or warehouse where this fulfillment request is being processed.
memoStringFalseNoAdditional notes or comments related to this fulfillment request.
pickupholdStringFalseNoIndicates whether this fulfillment request is on hold for pickup.
prevdateDateFalseNoThe previous scheduled date for this fulfillment request, if rescheduled.
statusStringFalseNoThe current status of the fulfillment request (such as Pending, Completed, Canceled).
subsidiaryStringFalseNoThe subsidiary associated with this fulfillment request, defining its organizational scope.
trandateDateFalseNoThe transaction date for this fulfillment request.
tranidStringFalseNoThe transaction identifier assigned to this fulfillment request.
transtatusStringFalseNoThe transaction status, providing further details on fulfillment progress.

Return to Top

FulfillmentRequestType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoThe unique identifier for this fulfillment request type, used to classify different fulfillment request categories in NetSuite.

Return to Top

FXRATEUPDATEZONE 

NameTypeReadOnlyReferencesFilterOnlyDescription
idIntegerFalseNoThe unique identifier for this foreign exchange rate update zone in NetSuite.

Return to Top

gatewayNotification 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal identifier for this gateway notification record in NetSuite.
errorStringFalseNoDetails of any errors encountered during payment processing.
externalidStringFalseNoA unique external identifier for referencing this gateway notification in external systems.
isodateStringFalseNoThe date of the notification in ISO format.
notificationdateDateFalseNoThe date when this gateway notification was received.
paymentprocessingprofileStringFalseNoThe payment processing profile associated with this transaction.
paymentrequestidStringFalseNoThe unique identifier of the payment request related to this notification.
paymentstatusStringFalseNoThe status of the payment transaction (such as Approved, Declined, Pending).
requestStringFalseNoThe request data sent to the payment gateway.
responseStringFalseNoThe response data received from the payment gateway.
transactionStringFalseNoThe transaction record associated with this payment notification.
validatepostbackstatusStringFalseNoThe status of postback validation for this payment notification.

Return to Top

gatewayTokenFamily 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoThe unique identifier for this gateway token family, used to group related payment tokens in NetSuite.

Return to Top

generalAllocationSchedule 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal identifier for this general allocation schedule in NetSuite.
accountingbookStringFalseNoThe accounting book associated with this allocation schedule, defining financial reporting rules.
accountsfromsourceBooleanFalseNoIndicates whether the source or credit account(s) are used for allocation.
creditaccountStringFalseNoThe account to which the allocated amounts will be credited.
creditclassStringFalseNoThe class associated with the credit transaction for classification purposes.
creditentityStringFalseNoThe name of the entity receiving the credit allocation.
creditlocationStringFalseNoThe location associated with the credit allocation, used for financial tracking.
externalidStringFalseNoA unique external identifier for referencing this allocation schedule in external systems.
frequencyStringFalseNoThe frequency of the allocation, such as monthly, quarterly, or annually.
hasremainingremaindersBooleanFalseNoIndicates whether there are remaining amounts left to be allocated.
inactiveBooleanFalseNoSpecifies whether this allocation schedule is inactive and no longer in use.
isintercompanyBooleanFalseNoIndicates whether this allocation involves transactions between subsidiaries (intercompany).
nameStringFalseNoThe name assigned to this allocation schedule for identification.
nextdateDateFalseNoThe next scheduled date when this allocation will occur.
remainingremindersStringFalseNoThe number of remaining allocations yet to be executed.
remindforeverBooleanFalseNoIndicates whether this allocation should continue indefinitely without a set limit.
sourceintercompanyaccountStringFalseNoThe intercompany account used for transactions between subsidiaries.
subsequentdateDateFalseNoThe date when the next subsequent allocation will take place after the next scheduled allocation.
subsidiaryStringFalseNoThe subsidiary associated with this allocation schedule, defining its financial scope.
weightsinpercentageBooleanFalseNoIndicates whether the allocated values are expressed as percentages.

Return to Top

generalAllocationScheduleJournalCreatedByAllocation 

NameTypeReadOnlyReferencesFilterOnlyDescription
allocationdetailidIntegerFalseNoThe unique identifier for the allocation detail related to this journal entry.
journalStringFalseNoThe journal entry created as a result of this allocation schedule.
journalbookStringFalseNoThe accounting book associated with this journal entry, defining financial reporting rules.
parentscheduleStringFalseNoThe allocation schedule from which this journal entry was created.
postingperiodStringFalseNoThe accounting period in which this journal entry is posted.
trandateDateFalseNoThe transaction date of this journal entry.

Return to Top

GeneralDetailDestination 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe destination account where the allocated amount will be recorded.
classStringFalseNoThe classification assigned to this allocation detail for reporting and segmentation.
departmentStringFalseNoThe department associated with this allocation, helping categorize financial transactions.
entityStringFalseNoThe name of the entity receiving the allocated amount.
intercompanyaccountStringFalseNoThe intercompany account used if the allocation involves multiple subsidiaries.
locationStringFalseNoThe location associated with this allocation, used for financial tracking.
parentscheduleStringFalseNoThe allocation schedule from which this destination detail originates.
subsidiaryStringFalseNoThe subsidiary associated with this allocation, defining its financial scope.

Return to Top

GeneralDetailSource 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe source account from which the allocated amount is drawn.
classStringFalseNoThe classification assigned to this allocation source for reporting and segmentation.
departmentStringFalseNoThe department associated with this allocation source, helping categorize financial transactions.
locationStringFalseNoThe location associated with this allocation source, used for financial tracking.
parentscheduleStringFalseNoThe allocation schedule from which this source detail originates.

Return to Top

generalizedItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal identifier for this item within NetSuite.
externalidStringFalseNoA unique external identifier for referencing this item in external systems.
itemtypeStringFalseNoThe type of item, such as inventory, non-inventory, service, or other classifications.
nameStringFalseNoThe name assigned to this item for identification within NetSuite.

Return to Top

GeneralScheduleDestination 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe destination account where the allocated amount will be recorded.
classStringFalseNoThe classification assigned to this allocation destination for reporting and segmentation.
departmentStringFalseNoThe department associated with this allocation destination, helping categorize financial transactions.
entityStringFalseNoThe name of the entity receiving the allocated amount.
intercompanyaccountStringFalseNoThe intercompany account used if the allocation involves multiple subsidiaries.
locationStringFalseNoThe location associated with this allocation, used for financial tracking.
parentscheduleStringFalseNoThe allocation schedule from which this destination detail originates.
subsidiaryStringFalseNoThe subsidiary associated with this allocation, defining its financial scope.

Return to Top

GeneralScheduleSource 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe source account from which the allocated amount is drawn.
classStringFalseNoThe classification assigned to this allocation source for reporting and segmentation.
departmentStringFalseNoThe department associated with this allocation source, helping categorize financial transactions.
locationStringFalseNoThe location associated with this allocation source, used for financial tracking.
parentscheduleStringFalseNoThe allocation schedule from which this source detail originates.

Return to Top

generaltoken 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoThe entity associated with this token, such as a customer or vendor.
externalidStringFalseNoA unique external identifier for referencing this token in external systems.
idIntegerFalseNoThe internal identifier for this token within NetSuite.
instrumenttypeStringFalseNoThe type of payment instrument associated with this token, such as a credit card or bank account.
isdefaultBooleanFalseNoIndicates whether this token is the default payment method for the associated entity.
isinactiveBooleanFalseNoSpecifies whether this token is inactive and no longer in use.
maskStringFalseNoA masked representation of the tokenized payment instrument for security purposes.
memoStringFalseNoAdditional notes or comments related to this token.
paymentmethodStringFalseNoThe payment method associated with this token, such as Visa, MasterCard, or ACH.
preserveonfileBooleanFalseNoIndicates whether this token should be preserved on file for future transactions.
stateStringFalseNoThe current status of this token (such as Active, Expired, Suspended).
supportedoperationsStringFalseNoA list of supported operations for this token, such as authorization or capture.
tokenStringFalseNoThe actual payment token used to process transactions securely.
tokenexpirationdateStringFalseNoThe expiration date of this token, if applicable.
tokenfamilyStringFalseNoThe family or category of this token, grouping related payment instruments.
tokennamespaceStringFalseNoThe namespace associated with this token, defining its scope within NetSuite.

Return to Top

generalTokenPaymentOperationMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
paymentinstrumentStringFalseNoThe payment instrument associated with a tokenized payment operation, such as a credit card or bank account.

Return to Top

genericCampaignEventResponse 

NameTypeReadOnlyReferencesFilterOnlyDescription
bouncedIntegerFalseNoThe total number of emails that bounced and were not successfully delivered.
bouncedratioDoubleFalseNoThe percentage of sent emails that bounced, calculated as (bounced / sent) * 100.
clickedthruIntegerFalseNoThe total number of recipients who clicked a link in the email.
clickedthruratioDoubleFalseNoThe percentage of recipients who clicked a link, calculated as (clicked thru / sent) * 100.
openedIntegerFalseNoThe total number of recipients who opened the email.
openedratioDoubleFalseNoThe percentage of sent emails that were opened, calculated as (opened / sent) * 100.
respondedIntegerFalseNoThe total number of recipients who responded to the campaign.
respondedratioDoubleFalseNoThe percentage of recipients who responded, calculated as (responded / sent) * 100.
sentIntegerFalseNoThe total number of emails sent as part of the campaign.
unsubscribedIntegerFalseNoThe total number of recipients who unsubscribed from future emails.
unsubscribedratioDoubleFalseNoThe percentage of recipients who unsubscribed, calculated as (unsubscribed / sent) * 100.

Return to Top

genericCampaignItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
campaignStringFalseNoThe campaign associated with this item, linking it to a specific marketing effort in NetSuite.

Return to Top

genericresource 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal identifier for this generic resource in NetSuite.
entityidStringFalseNoThe name assigned to this generic resource, used for identification.
externalidStringFalseNoA unique external identifier for referencing this resource in external systems.
isinactiveBooleanFalseNoIndicates whether this resource is inactive and no longer in use.
laborcostDecimalFalseNoThe cost associated with this resource's labor, typically used for project costing or budgeting.

Return to Top

GenericResourceSubsidiaryRelationship 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal identifier for this generic resource subsidiary relationship in NetSuite.
entityStringFalseNoThe entity associated with this subsidiary relationship, typically a resource or employee.
externalidStringFalseNoA unique external identifier for referencing this relationship in external systems.
isprimarysubBooleanFalseNoIndicates whether this subsidiary is the primary subsidiary for the associated entity.
nameStringFalseNoThe name assigned to this subsidiary relationship for identification.

Return to Top

giftcertificate 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe internal identifier for this gift certificate in NetSuite.
amountremainingDecimalFalseNoThe remaining balance available on the gift certificate.
createddateDateFalseNoThe date when the gift certificate was created.
currencyStringFalseNoThe currency in which the gift certificate was issued.
emailStringFalseNoThe recipient's email address where the gift certificate was sent.
expirationdateDateFalseNoThe date when the gift certificate expires, if applicable.
giftcertcodeStringFalseNoThe unique code assigned to the gift certificate, used for redemption.
giftcertitemStringFalseNoThe specific gift certificate item associated with this entry.
lastmodifieddateDateFalseNoThe date when the gift certificate details were last updated.
messageStringFalseNoThe personalized message included with the gift certificate.
originalamountDecimalFalseNoThe original amount loaded onto the gift certificate at the time of purchase.
senderStringFalseNoThe name of the person or entity that issued the gift certificate.

Return to Top

giftcertificateitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
availabletopartnersBooleanFalseNoIndicates whether this gift certificate item is available for partners.
billingscheduleStringFalseNoThe billing schedule associated with this gift certificate item.
classStringFalseNoThe classification assigned to this gift certificate item for categorization and reporting.
costestimateDecimalFalseNoThe estimated cost associated with this gift certificate item.
costestimatetypeStringFalseNoThe type of cost estimation method applied to this item.
createddateDatetimeFalseNoThe date and time when this gift certificate item was created.
customformStringFalseNoThe custom form associated with this gift certificate item in NetSuite.
daysbeforeexpirationIntegerFalseNoThe number of days before the gift certificate expires.
departmentStringFalseNoThe department associated with this gift certificate item.
displaynameStringFalseNoThe display name of the gift certificate item as it appears in the store.
dontshowpriceBooleanFalseNoIndicates whether the price should be hidden when displaying this item.
excludefromsitemapBooleanFalseNoIndicates whether this gift certificate item should be excluded from the sitemap.
externalidStringFalseNoA unique external identifier for referencing this item in external systems.
featureddescriptionStringFalseNoA highlighted description of the gift certificate item for promotions or marketing.
includechildrenBooleanFalseNoIndicates whether child items should be included for this gift certificate.
incomeaccountStringFalseNoThe income account associated with revenue from this gift certificate item.
internalidIntegerFalseNoThe internal identifier for this gift certificate item in NetSuite.
isdonationitemBooleanFalseNoIndicates whether this item is used for donation purposes.
isfulfillableBooleanFalseNoSpecifies whether this gift certificate item requires fulfillment.
isgcocompliantBooleanFalseNoIndicates whether this item complies with gift certificate-related regulations.
isinactiveBooleanFalseNoSpecifies whether this gift certificate item is inactive and no longer available.
isonlineBooleanFalseNoIndicates whether this gift certificate item is available for online purchase.
issueproductStringFalseNoThe product associated with issuing this gift certificate.
itemidStringFalseNoThe unique item identifier assigned to this gift certificate in NetSuite.
itemnumberoptionsStringFalseNoOptions available for different item numbers associated with this gift certificate.
itemoptionsStringFalseNoAdditional options available for this gift certificate item.
itemtypeStringFalseNoThe type of item, such as a gift certificate, inventory item, or service item.
lastmodifieddateDatetimeFalseNoThe date and time when this item was last modified.
liabilityaccountStringFalseNoThe liability account associated with this gift certificate item.
locationStringFalseNoThe physical or virtual location associated with this gift certificate item.
maxdonationamountDecimalFalseNoThe maximum donation amount allowed for this gift certificate item.
metataghtmlStringFalseNoThe meta tag HTML used for SEO optimization on the item’s web page.
nopricemessageStringFalseNoThe message displayed when no price is available for this gift certificate item.
offersupportBooleanFalseNoIndicates whether this item includes customer support services.
outofstockbehaviorStringFalseNoThe behavior defined for when this item is out of stock (such as allow backorders).
outofstockmessageStringFalseNoThe message displayed when this gift certificate item is out of stock.
pagetitleStringFalseNoThe title of the web page for this gift certificate item.
parentStringFalseNoThe parent item, if this gift certificate item is part of a hierarchical structure.
relateditemsdescriptionStringFalseNoA description of related items that can be suggested with this gift certificate.
salesdescriptionStringFalseNoThe sales description of this item, typically shown in purchase-related documents.
searchkeywordsStringFalseNoKeywords associated with this gift certificate item to enhance searchability.
showdefaultdonationamountBooleanFalseNoIndicates whether a default donation amount should be displayed.
sitemappriorityStringFalseNoThe priority of this item in the sitemap for search engines.
storedescriptionStringFalseNoA brief description of this gift certificate item for the online store.
storedetaileddescriptionStringFalseNoA detailed description of this gift certificate item for the online store.
storedisplayimageStringFalseNoThe main image displayed for this gift certificate item in the store.
storedisplaynameStringFalseNoThe name displayed for this gift certificate item in the store.
storedisplaythumbnailStringFalseNoThe thumbnail image displayed for this gift certificate item in the store.
storeitemtemplateStringFalseNoThe template used for displaying this item in the online store.
subsidiaryStringFalseNoThe subsidiary associated with this gift certificate item.
subtypeStringFalseNoThe subtype of this gift certificate item, further categorizing its usage.
taxscheduleStringFalseNoThe tax schedule associated with this gift certificate item.
upccodeStringFalseNoThe Universal Product Code (UPC) assigned to this gift certificate item.
urlcomponentStringFalseNoThe URL component or slug used for this gift certificate item’s web page.

Return to Top

GiftCertificateItemAuthorizationCodes 

NameTypeReadOnlyReferencesFilterOnlyDescription
authcodeStringFalseNoThe authorization code assigned to a gift certificate for validation and redemption.
giftcertificateitemStringFalseNoThe gift certificate item associated with this authorization code.

Return to Top

giftCertificateItemCorrelateditem 

NameTypeReadOnlyReferencesFilterOnlyDescription
correlationfldDoubleFalseNoThe correlation percentage indicating the likelihood of this item being purchased with the gift certificate item.
countfldIntegerFalseNoThe number of times this item has been purchased alongside the gift certificate item.
itemStringFalseNoThe associated item that has been frequently purchased with the gift certificate item.
itemnkeyfldStringFalseNoThe unique identifier of the correlated item.
liftfldDoubleFalseNoThe lift percentage indicating the increased probability of purchasing this item when a gift certificate item is bought.

Return to Top

giftCertificateItemPresentationItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
basepriceDecimalFalseNoThe base price of the related item before any discounts or modifications.
descriptionStringFalseNoA description of the related item presented alongside the gift certificate item.
onlinepriceDecimalFalseNoThe price of the related item when purchased online.
presentationitemStringFalseNoThe related item displayed as an additional purchase option with the gift certificate item.
presitemidIntegerFalseNoThe internal identifier for this related item in NetSuite.
superitemStringFalseNoThe parent or primary item associated with this presentation item.

Return to Top

giftCertificateItemPrice 

NameTypeReadOnlyReferencesFilterOnlyDescription
isinactiveBooleanFalseNoIndicates whether this gift certificate item price is inactive and no longer available.
itemStringFalseNoThe gift certificate item associated with this price entry.
priceDecimalFalseNoThe specified price or amount for the gift certificate item.

Return to Top

giftCertificateItemQuantity 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe gift certificate item associated with the quantity restrictions.
maxcountIntegerFalseNoThe maximum quantity that can be purchased for this gift certificate item.
mincountIntegerFalseNoThe minimum quantity required for purchasing this gift certificate item.

Return to Top

giftCertificateItemSiteCategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
categorydescriptionStringFalseNoA description of the site category associated with this gift certificate item.
isdefaultBooleanFalseNoIndicates whether this is the preferred or default category for the gift certificate item.
itemStringFalseNoThe gift certificate item associated with this site category.
websiteStringFalseNoThe website where this gift certificate item is listed under the specified category.

Return to Top

giftCertificateItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe gift certificate item associated with a specific subsidiary in NetSuite.

Return to Top

giftCertificateItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe gift certificate item associated with this translation entry.
displaynameStringFalseNoThe translated display name for the gift certificate item.
languageStringFalseNoThe language in which this translation is provided.
nopricemessageStringFalseNoThe translated message displayed when no price is available for this gift certificate item.
outofstockmessageStringFalseNoThe translated message displayed when the gift certificate item is out of stock.
pagetitleStringFalseNoThe translated page title for the gift certificate item.
salesdescriptionStringFalseNoThe translated sales description for the gift certificate item.
storedescriptionStringFalseNoThe translated short description displayed in the online store.
featureddescriptionStringFalseNoThe translated featured description for promotional display.
specialsdescriptionStringFalseNoThe translated description used for special offers or promotions.
storedisplaynameStringFalseNoThe translated name displayed in the online store.
storedetaileddescriptionStringFalseNoThe translated detailed description of the gift certificate item for the online store.

Return to Top

glnumberingsequence 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with this numbering sequence, defining financial reporting rules.
dailyrecurringStringFalseNoIndicates whether the numbering sequence recurs on a daily basis.
excludezerotransactionsBooleanFalseNoSpecifies whether transactions with a zero amount should be excluded from the numbering sequence.
externalidStringFalseNoA unique external identifier for referencing this numbering sequence in external systems.
firstrunStringFalseNoDefines the first run of the numbering sequence, specifying when it starts.
hourlyrecurringIntegerFalseNoIndicates whether the numbering sequence recurs on an hourly basis.
idIntegerFalseNoThe internal identifier for this general ledger numbering sequence in NetSuite.
initnumStringFalseNoThe initial number assigned when the sequence starts.
isinactiveBooleanFalseNoSpecifies whether this numbering sequence is inactive and no longer in use.
mindigitsIntegerFalseNoThe minimum number of digits required in the numbering sequence.
numberingtypeStringFalseNoThe type of numbering used, such as sequential or custom-defined.
ordertypeStringFalseNoThe order type associated with this numbering sequence, defining transaction categorization.
periodStringFalseNoThe accounting period to which this numbering sequence applies.
prefixStringFalseNoA prefix added to the numbering sequence for easy identification.
recurringtypeStringFalseNoDefines how often the numbering sequence recurs, such as daily, hourly, or periodically.
sequencenameStringFalseNoThe name assigned to this numbering sequence for identification.
subsidiariesStringFalseNoThe subsidiaries associated with this numbering sequence, defining its financial scope.
suffixStringFalseNoA suffix appended to the numbering sequence for further categorization.

Return to Top

globalaccountmapping 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with this global account mapping, defining financial reporting rules.
classStringFalseNoThe classification assigned to this account mapping for segmentation and reporting.
customdimensionStringFalseNoA custom dimension used for categorization within this global account mapping.
customformStringFalseNoThe custom form associated with this account mapping in NetSuite.
departmentStringFalseNoThe department linked to this account mapping, helping categorize financial transactions.
destinationaccountStringFalseNoThe account where the mapped transactions will be recorded.
effectivedateDateFalseNoThe date when this global account mapping becomes effective.
enddateDateFalseNoThe date when this global account mapping is no longer valid.
externalidStringFalseNoA unique external identifier for referencing this account mapping in external systems.
locationStringFalseNoThe location associated with this account mapping, used for financial tracking.
sourceaccountStringFalseNoThe original account from which transactions are mapped.
subsidiaryStringFalseNoThe subsidiary associated with this global account mapping, defining its financial scope.

Return to Top

globalinventoryrelationship 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal identifier for this global inventory relationship in NetSuite.
alllocationscustomerreturnBooleanFalseNoIndicates whether all locations can be used for customer returns.
alllocationsfulfillmentBooleanFalseNoIndicates whether all locations can be used for order fulfillment.
allowcrosssubcustomerreturnBooleanFalseNoSpecifies whether customer returns can be processed across subsidiaries.
allowcrosssubfulfillmentBooleanFalseNoSpecifies whether order fulfillment can occur across subsidiaries.
externalidStringFalseNoA unique external identifier for referencing this global inventory relationship in external systems.
inventorysubsidiaryStringFalseNoThe subsidiary associated with this inventory relationship, defining stock ownership and management.
isinactiveBooleanFalseNoIndicates whether this global inventory relationship is inactive and no longer in use.

Return to Top

goal 

NameTypeReadOnlyReferencesFilterOnlyDescription
detailsStringFalseNoAdditional details or notes about the goal.
employeeStringFalseNoThe employee associated with this goal.
externalidStringFalseNoA unique external identifier for referencing this goal in external systems.
goalstatusStringFalseNoThe current status of the goal (such as In Progress, Completed, Canceled).
idIntegerFalseNoThe internal identifier for this goal in NetSuite.
internalidIntegerFalseNoThe internal system-generated ID for this goal.
isinactiveBooleanFalseNoIndicates whether this goal is inactive and no longer being tracked.
moodStringFalseNoThe mood or sentiment associated with progress on this goal.
nameStringFalseNoThe name or title assigned to this goal for identification.
targetdateDateFalseNoThe target date for achieving this goal.

Return to Top

Hcmterminationcategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
nameStringFalseNoThe name of the termination category, used to classify different types of employee terminations in NetSuite.

Return to Top

importedemployeeexpense 

NameTypeReadOnlyReferencesFilterOnlyDescription
billedamountDecimalFalseNoThe total amount billed for the expense, representing the full charge amount as it appears in the financial records, including any applicable taxes, discounts, and fees.
billedcurrencyStringFalseNoThe currency in which the billed amount is denominated, indicating the type of currency used for the transaction, such as USD, EUR, or GBP.
billedtaxamountDecimalFalseNoThe total amount of tax applied to the billed amount, representing any applicable taxes on the transaction, including value added tax (VAT) and sales tax.
cardcurrencyStringFalseNoThe currency used by the corporate card during the transaction often different from the billed currency and is important for accurately converting the transaction values.
cardmemberembossednameStringFalseNoThe name of the cardholder is used for identification purposes and ensures that the correct cardholder is associated with the transaction.
categoryStringFalseNoThe category or classification of the expense, corresponding to internal classifications such as 'Travel,' 'Meals,' or 'Supplies,' for reporting and analysis purposes.
chargedateDateFalseNoThe date on which the charge occurred is important for tracking the timing of charges within financial reporting periods.
corporatecardBooleanFalseNoIndicates whether the expense was paid using a corporate credit card, distinguishing between personal and business expenses for card-related transactions.
costcenterStringFalseNoThe department or cost center that is associated with the transaction is used to allocate expenses accurately within the organization, ensuring correct budgeting and reporting.
currencyexchangerateDecimalFalseNoThe exchange rate used to convert the transaction amount from the card's currency to the billed currency, converting multi-currency transactions into the company's base currency.
customformStringFalseNoThe identifier of the custom form used to capture the transaction details, linking the transaction to a specific custom form template.
employeeStringFalseNoThe name or identifier of the employee who made the expense is used to track employee-specific charges, expense reporting, and reimbursement management.
externalidStringFalseNoA unique external identifier assigned to the transaction often used to associate the transaction with an external system or reference number.
formatprofileStringFalseNoThe profile specifies the format for transaction data, including a predefined template or rules for displaying or processing transactions within the system.
idIntegerFalseNoThe unique identifier assigned to the transaction record is used for reference and retrieval of the specific record and ensures that each transaction can be tracked individually.
internalidIntegerFalseNoThe internal system ID for the transaction. It ensures that the transaction is associated with the correct records.
localchargeamountDecimalFalseNoThe amount charged in the local currency, reporting and financial analysis in cases where the transaction occurred in a different currency from the company's base currency.
localtaxamountDecimalFalseNoThe amount of tax charged in the local currency, ensuring that tax amounts are accurately captured and converted for reconciliation purposes.
memoStringFalseNoA brief note or description related to the transaction, providing additional context for the expense, such as any other relevant details for review or approval.
sourcetypeStringFalseNoThe source or origin of the transaction, categorizing transactions for further analysis and reporting.
statusStringFalseNoThe current status of the expense transaction, representing whether the transaction is pending, approved, rejected, or paid.
transactionidStringFalseNoA unique identifier assigned to the transaction in the financial system is important for tracking, auditing, and reconciling financial records.

Return to Top

inboundshipment 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the inbound shipment record.
actualdeliverydateDateFalseNoThe confirmed date when the shipment was delivered to its destination.
actualshippingdateDateFalseNoThe confirmed date when the shipment left the shipping facility.
billofladingStringFalseNoReference number for the bill of lading, a legal document detailing the shipment’s contents, destination, and carrier details.
expecteddeliverydateDateFalseNoThe anticipated date the shipment is expected to arrive at its destination based on scheduling.
expectedshippingdateDateFalseNoThe anticipated date the shipment is scheduled to leave the shipping facility.
externaldocumentnumberStringFalseNoReference number assigned to the shipment from an external system, such as a supplier or logistics provider.
externalidStringFalseNoA unique identifier assigned externally, typically used for integration with third-party systems.
shipmentbasecurrencyStringFalseNoThe currency in which shipment-related transactions and financial values are recorded.
shipmentcreateddateDateFalseNoThe date the inbound shipment record was created in the system.
shipmentmemoStringFalseNoAdditional notes or comments related to the shipment, often used for internal tracking.
shipmentnumberStringFalseNoThe unique identifier assigned to the shipment for tracking and reference.
shipmentstatusStringFalseNoThe current status of the shipment, such as pending, in transit, or delivered.

Return to Top

InboundShipmentItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique identifier for the inbound shipment item record, serving as the primary key.
expectedrateDecimalFalseNoThe anticipated cost per unit of the item in the inbound shipment, based on initial estimates.
inboundshipmentStringFalseNoReference to the associated inbound shipment, indicating the batch or shipment this item belongs to.
incotermStringFalseNoInternational Commercial Term (Incoterm) defining the shipping and delivery responsibilities between buyer and seller.
pocurrencyStringFalseNoThe currency used for the purchase order associated with this inbound shipment item.
porateDecimalFalseNoThe exchange rate applied to the purchase order currency for cost calculations.
purchaseordertransactionStringFalseNoThe purchase order number linked to this inbound shipment item, referencing the procurement transaction.
quantitybilledDoubleFalseNoThe total number of units that have been invoiced for this inbound shipment item.
quantityexpectedDoubleFalseNoThe number of units initially expected to be received in the inbound shipment.
quantityreceivedDoubleFalseNoThe actual number of units received for this item in the inbound shipment.
quantityremainingDoubleFalseNoThe remaining quantity of this item yet to be received, calculated as expected quantity minus received quantity.
receivinglocationStringFalseNoThe warehouse or location where the inbound shipment item is being received and stored.
shipmentitemamountDecimalFalseNoThe total monetary value of this inbound shipment item, calculated based on unit cost and quantity.
shipmentitemdescriptionStringFalseNoDetailed description of the inbound shipment item, including product specifications or additional notes.
shipmentitemeffectivedateDateFalseNoThe date on which this inbound shipment item becomes effective for financial and inventory purposes.
shipmentitemexchangerateDecimalFalseNoThe exchange rate applicable to this shipment item for conversion between purchase currency and base currency.
shipmentitemtransactionStringFalseNoReference to the specific line item within the purchase order transaction related to this inbound shipment.
totalunitcostDecimalFalseNoThe complete cost per unit of the item, including any additional landed costs such as shipping, duties, and taxes.
unitStringFalseNoThe unit of measure for this inbound shipment item, such as pieces, kilograms, or cartons.
unitlandedcostDecimalFalseNoThe total landed cost per unit of this item, incorporating base cost, freight, duties, and other applicable charges.

Return to Top

InboundShipmentLandedCost 

NameTypeReadOnlyReferencesFilterOnlyDescription
landedcostallocationmethodStringFalseNoSpecifies how the landed cost is distributed across the shipment items, such as by weight, quantity, or value.
landedcostamountDecimalFalseNoThe total monetary value of the landed cost applied to the inbound shipment.
landedcostcostcategoryStringFalseNoThe category of the landed cost, such as freight, duty, insurance, or brokerage fees.
landedcostcurrencyStringFalseNoThe currency in which the landed cost is recorded, ensuring accurate financial tracking and reporting.
landedcosteffectivedateDateFalseNoThe date from which the landed cost is considered valid and applicable to the inbound shipment.
landedcostexchangerateDecimalFalseNoThe exchange rate used to convert the landed cost amount into the base currency of the organization.
landedcostidIntegerFalseNoA unique identifier assigned to the specific landed cost entry for tracking and reference purposes.
landedcostshipmentitemssearchStringFalseNoA searchable field that links the landed cost to specific items in the inbound shipment, helping with cost allocation and analysis.

Return to Top

IncoTerm 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier for the Incoterm record, used as the primary key.
descriptionStringFalseNoA detailed explanation of the Incoterm, providing context on its usage and significance in trade agreements.
isinactiveBooleanFalseNoIndicates whether the Incoterm is inactive. A value of 'true' means it is no longer in use, while 'false' signifies an active status.
nameStringFalseNoThe official name of the Incoterm, typically following the International Chamber of Commerce (ICC) standards.

Return to Top

IncoTermType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoUnique identifier for the IncoTermType, serving as the primary key in the table.

Return to Top

intercompallocationschedule 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with the intercompany allocation schedule specifies the financial records used for reporting.
accountsfromsourceBooleanFalseNoIndicates whether accounts are sourced from the originating transaction or predefined within the allocation schedule.
allocationmodeStringFalseNoDefines how allocations are processed, such as fixed or dynamic allocation based on predefined rules.
creditaccountStringFalseNoThe general ledger account to which the credit entry for the allocation is posted.
creditclassStringFalseNoThe classification assigned to the credit side of the allocation, used for reporting and segmentation.
creditdepartmentStringFalseNoThe department responsible for the credited portion of the allocation, aiding in departmental financial tracking.
creditentityStringFalseNoThe business entity receiving the credit entry in the allocation, such as a subsidiary or partner company.
creditlocationStringFalseNoThe physical or virtual location associated with the credit entry of the allocation for regional financial tracking.
datebasisStringFalseNoSpecifies the date basis for allocation calculations, such as transaction date or posting date.
externalidStringFalseNoA unique identifier for external integrations, used to reference this allocation schedule in third-party systems.
frequencyStringFalseNoIndicates how often the allocation schedule runs, such as daily, weekly, or monthly.
inactiveBooleanFalseNoMarks whether the allocation schedule is active or inactive. An inactive schedule will not process allocations.
nameStringFalseNoThe descriptive name of the intercompany allocation schedule for easy identification.
nextdateDateFalseNoThe next scheduled execution date for the allocation process.
remindforeverStringFalseNoIndicates whether reminders for this allocation schedule persist indefinitely until manually disabled.
sourceintercompanyaccountStringFalseNoThe intercompany account from which the allocation originates, ensuring proper financial balancing.
subsequentdateDateFalseNoThe date of the next occurrence of the allocation following the next scheduled execution date.
subsidiaryStringFalseNoThe subsidiary responsible for the allocation, ensuring correct financial attribution within a multi-entity organization.
unitlabelStringFalseNoThe label used to describe the unit of measure associated with the allocation, such as hours or currency.
unitstypeStringFalseNoDefines the type of units used in the allocation, such as percentage-based or fixed-unit allocations.
weightsinpercentageBooleanFalseNoIndicates whether allocation weights are expressed as percentages rather than absolute values.
weightsourceStringFalseNoSpecifies the source of allocation weights, such as historical data, predefined rules, or manual input.

Return to Top

IntercompanyAllocationScheduleAllocationDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier for the allocation detail entry, used for tracking and referencing specific records within the system.
createdjournalsStringFalseNoIndicates whether a journal entry has been generated for this allocation detail. Possible values can represent different statuses of journal creation.
externalidStringFalseNoAn optional external identifier used to reference this record in external systems or integrations which helps with data synchronization across platforms.
parentscheduleStringFalseNoReferences the intercompany allocation schedule that this allocation detail is derived from, establishing a connection between schedules and their details.
trandateDateFalseNoThe transaction date associated with this allocation detail, representing when the allocation was recorded in the system.

Return to Top

IntercompanyAllocationScheduleAllocationDetailGeneralDetailDestination 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account associated with this allocation detail.
classStringFalseNoThe classification category used for tracking and reporting transactions.
departmentStringFalseNoThe department to which this allocation detail applies, aiding in financial tracking.
entityStringFalseNoThe name of the entity involved in this allocation, such as a vendor or customer.
intercompanyaccountStringFalseNoThe intercompany account used for recording transactions between subsidiaries.
locationStringFalseNoThe physical or business location associated with this allocation detail.
parentscheduleStringFalseNoThe schedule from which this allocation detail was generated.
subsidiaryStringFalseNoThe subsidiary responsible for this allocation detail within the company.

Return to Top

IntercompanyAllocationScheduleAllocationDetailGeneralDetailSource 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account associated with this allocation entry. This defines where the allocated amounts will be recorded.
classStringFalseNoThe classification used for tracking transactions, typically for reporting and segmentation purposes within NetSuite.
departmentStringFalseNoThe department associated with this allocation, helping to categorize financial data by business unit or functional area.
locationStringFalseNoThe physical or operational location tied to this allocation, useful for regional financial reporting.
parentscheduleStringFalseNoIndicates the originating allocation schedule from which this entry was generated, providing traceability in intercompany allocations.

Return to Top

IntercompanyDestination 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account associated with this intercompany transaction.
classStringFalseNoThe classification category used for reporting and segmentation of this transaction.
departmentStringFalseNoThe department responsible for this intercompany transaction, useful for cost allocation and reporting.
entityStringFalseNoThe name of the entity involved in the intercompany transaction, such as a vendor or customer.
intercompanyaccountStringFalseNoThe specific intercompany account used to track due-to and due-from balances between subsidiaries.
locationStringFalseNoThe physical or operational location tied to this transaction, aiding in regional reporting.
parentscheduleStringFalseNoIndicates the schedule from which this intercompany transaction was created, providing traceability.
subsidiaryStringFalseNoThe subsidiary associated with this transaction, ensuring proper financial consolidation.

Return to Top

intercompanyjournalentry 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe specific accounting book used for financial reporting in the intercompany journal entry.
approvalstatusStringFalseNoThe current approval status of the intercompany journal entry, indicating whether it is pending, approved, or rejected.
approvedBooleanFalseNoIndicates whether the intercompany journal entry has been fully approved. If the value is 'true', it means it is approved; if not, the value is 'false'.
classStringFalseNoThe classification category associated with the journal entry for reporting and tracking purposes.
createddateDatetimeFalseNoThe timestamp indicating when the intercompany journal entry was initially created.
createdfromStringFalseNoReference to the transaction or document from which this journal entry was created.
credittotalDecimalFalseNoThe total amount of credits recorded in this intercompany journal entry.
currencyStringFalseNoThe currency in which the intercompany journal entry is denominated.
customformStringFalseNoThe custom form used for this journal entry, if applicable.
debittotalDecimalFalseNoThe total amount of debits recorded in this intercompany journal entry.
departmentStringFalseNoThe department associated with this journal entry, used for internal tracking and reporting.
entitynexusStringFalseNoThe nexus (tax jurisdiction) associated with the entity involved in this transaction.
exchangerateDecimalFalseNoThe exchange rate applied to convert foreign currency values within the journal entry.
expenseallocjournalcountStringFalseNoThe number of expense allocation journal entries linked to this transaction.
externalidStringFalseNoA unique identifier for the journal entry assigned by an external system.
isbasecurrencyBooleanFalseNoIndicates whether the journal entry is in the company's base currency. The value is 'true' if recorded in the base currency and 'false' if recorded in the foreign currency.
lastmodifieddateDatetimeFalseNoThe timestamp indicating when the journal entry was last modified.
memoStringFalseNoA brief description or note explaining the purpose of the intercompany journal entry.
nextapproverStringFalseNoThe user or role designated as the next approver in the journal entry approval workflow.
nexusStringFalseNoThe tax jurisdiction relevant to this intercompany transaction.
parentexpenseallocStringFalseNoReference to the parent expense allocation entry, if this journal entry is related to an expense allocation.
postingperiodStringFalseNoThe accounting period in which this journal entry is posted for financial reporting.
reversaldateDateFalseNoThe date on which this journal entry is scheduled to be reversed, if applicable.
reversaldeferBooleanFalseNoIndicates whether the reversal of this journal entry is deferred to a later period. If the value is 'true,' it is deferred, and if the value is 'false,' it is not deferred.
statusStringFalseNoThe current processing status of the intercompany journal entry, such as pending, posted, or voided.
subsidiaryStringFalseNoThe subsidiary entity that recorded this journal entry.
tosubsidiaryStringFalseNoThe subsidiary entity receiving the transaction in this intercompany journal entry.
trandateDateFalseNoThe transaction date of the intercompany journal entry.
tranidStringFalseNoA unique identifier assigned to this journal entry for tracking and reference purposes.

Return to Top

IntercompanySource 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the intercompany transaction, representing the general ledger account impacted by this entry.
classStringFalseNoThe classification assigned to the transaction, used for categorizing and segmenting financial data for reporting purposes.
departmentStringFalseNoThe department within the organization responsible for the transaction, enabling financial tracking and allocation by business unit.
locationStringFalseNoThe physical or virtual location linked to the transaction, used for geographical financial reporting and inventory management.
parentscheduleStringFalseNoIndicates the schedule from which this transaction was generated, providing traceability for intercompany processes.

Return to Top

intercompanytransferorder 

NameTypeReadOnlyReferencesFilterOnlyDescription
altshippingcostDecimalFalseNoThe alternative shipping cost for the intercompany transfer order, typically used for custom shipping calculations.
classStringFalseNoThe classification category associated with this transfer order, often used for financial reporting and segmentation.
createddateDatetimeFalseNoThe date and time when this intercompany transfer order was created in NetSuite.
createdfromStringFalseNoThe source record from which this transfer order was generated, such as a purchase order or sales order.
currencyStringFalseNoThe currency code used for this transfer order, referencing the monetary unit applied to transactions.
currencynameStringFalseNoThe full name of the currency associated with this transfer order, such as 'US Dollar' or 'Euro'.
currencysymbolStringFalseNoThe symbol of the currency used in the transaction, such as '$' for USD or '€' for EUR.
customformStringFalseNoThe custom form template used for this transfer order, allowing for organization-specific formatting.
departmentStringFalseNoThe department assigned to this transfer order, typically used for tracking expenses and budgeting.
employeeStringFalseNoThe employee associated with this transfer order, often the person responsible for processing it.
entityStringFalseNoThe entity such as a customer, vendor, or subsidiary linked to this transfer order.
exchangerateDecimalFalseNoThe exchange rate applied to convert the transaction currency into the base currency of the company.
externalidStringFalseNoA unique identifier assigned externally to track this transfer order in integrated systems.
firmedBooleanFalseNoIndicates whether this transfer order has been confirmed as final, preventing further modifications.
fobStringFalseNoThe Free on Board (FOB) term specifying when the ownership and liability of goods transfer between buyer and seller.
incotermStringFalseNoThe International Commercial Terms (Incoterms) defining shipping responsibilities between the parties involved.
isbasecurrencyBooleanFalseNoIndicates whether the currency used in this transaction is the base currency of the company.
lastmodifieddateDatetimeFalseNoThe date and time when this transfer order was last updated.
linkedtrackingnumbersStringFalseNoA list of tracking numbers associated with shipments related to this transfer order.
locationStringFalseNoThe physical location or subsidiary associated with this transfer order, used for inventory and fulfillment tracking.
memoStringFalseNoA free-text field for additional notes or details about this transfer order.
nexusStringFalseNoThe tax jurisdiction applicable to this transaction based on the business entity’s presence in that region.
oldrevenuecommitmentStringFalseNoA reference to a prior revenue commitment linked to this transfer order, if applicable.
orderstatusStringFalseNoThe current status of this transfer order, such as Pending, Approved, or Shipped.
otherrefnumStringFalseNoAn alternative reference number used to track this transfer order, often an external or legacy system ID.
returntrackingnumbersStringFalseNoTracking numbers for returned shipments associated with this transfer order.
shipaddressStringFalseNoThe destination shipping address where the transferred goods are being sent.
shipaddresslistStringFalseNoA predefined list of shipping addresses available for selection for this transfer order.
shipcompleteBooleanFalseNoIndicates whether the order should be shipped only when all items are available. If set to true, partial shipments are not allowed.
shipdateDateFalseNoThe scheduled date when the transfer order is set to be shipped from the source location.
shipisresidentialStringFalseNoSpecifies whether the shipping destination is a residential address. Possible values are 'true' or 'false.'
shipmethodStringFalseNoThe shipping method used for this intercompany transfer order, specifying the carrier or service level.
shipoverrideStringFalseNoIndicates whether the default shipping method is overridden for this order, allowing for a custom selection.
shippingaddressStringFalseNoThe designated shipping address where the transferred items will be delivered, including recipient details.
shippingcostDecimalFalseNoThe total cost associated with shipping the intercompany transfer order, including carrier fees and handling charges.
shippingcostoverriddenStringFalseNoIndicates whether the shipping cost has been manually adjusted from the system-calculated value. Possible values are 'true' or 'false.'
sourceStringFalseNoIndicates the origin of the intercompany transfer order, specifying the entity or location initiating the transfer.
statusStringFalseNoRepresents the current state of the intercompany transfer order, such as pending, approved, or fulfilled.
statusRefStringFalseNoA reference identifier for the status of the intercompany transfer order, used for internal tracking and system processing.
subsidiaryStringFalseNoThe originating subsidiary for the intercompany transfer order, representing the company entity initiating the transfer.
subtotalDecimalFalseNoThe total value of items being transferred before taxes and additional charges are applied.
tosubsidiaryStringFalseNoThe destination subsidiary receiving the intercompany transfer order, representing the company entity that will receive the goods.
totalDecimalFalseNoThe final cost of the intercompany transfer order, including all applicable taxes, fees, and adjustments.
trackingnumbersStringFalseNoTracking numbers associated with the shipment of the intercompany transfer order. If multiple tracking numbers exist, they are separated by commas.
trandateDateFalseNoThe date the intercompany transfer order was created. This represents when the transfer request was initiated.
tranidStringFalseNoThe unique identifier assigned to the intercompany transfer order within NetSuite. This helps track the specific transaction.
transactionnumberStringFalseNoThe transaction number associated with the intercompany transfer order. This is an additional reference for tracking the transfer.
transferlocationStringFalseNoThe destination location where the inventory is being transferred. This helps determine the receiving warehouse or facility.
updatecurrencyStringFalseNoIndicates whether currency values should be updated for the transfer order. This is relevant when dealing with multi-currency transactions
useitemcostastransfercostBooleanFalseNoSpecifies whether the item cost should be used as the transfer cost for the intercompany transfer order. This affects cost calculations and financial reporting.

Return to Top

intercompanyTransferOrderLinkedTrackingNumberMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
trackingnumberStringFalseNoThe unique tracking number assigned to a shipment in an intercompany transfer order, typically used to trace the package's journey across different locations and ensures accurate delivery tracking.

Return to Top

intercompanyTransferOrderShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoUnique identifier for the shipping address record. This key is used internally and does not have a user-facing label.
addr1StringFalseNoPrimary street address for the shipping location, typically including a house number and street name.
addr2StringFalseNoSecondary street address field for additional location details, such as an apartment, suite, or unit number.
addr3StringFalseNoTertiary street address field for further address details when needed, such as building or floor information.
addresseeStringFalseNoName of the recipient or business associated with the shipping address.
attentionStringFalseNoOptional field used to specify a particular person or department within the recipient organization.
cityStringFalseNoName of the city component of the destination address where the inventory is being transferred.
countryStringFalseNoCountry associated with the shipping address, stored as a standardized country code.
dropdownstateStringFalseNoState or province of the shipping address, typically selected from a predefined list.
overrideBooleanFalseNoIndicates whether the default shipping address should be overridden with this address.
stateStringFalseNoFull name or code representing the state or province of the shipping address.

Return to Top

intercompanyTransferOrderTrackingNumberMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
trackingnumberStringFalseNoRepresents the unique tracking number assigned to an intercompany transfer order, allowing users to monitor shipment and delivery status across business entities.

Return to Top

inventoryadjustment 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account associated with the inventory adjustment, typically an asset or expense account.
adjlocationStringFalseNoThe location where the inventory adjustment takes place, such as a warehouse or retail store.
classStringFalseNoThe classification category assigned to the inventory adjustment, often used for tracking and reporting purposes.
clearedBooleanFalseNoIndicates whether the inventory adjustment has been marked as cleared in financial reconciliation.
cleareddateDateFalseNoThe date when the inventory adjustment was marked as cleared in the system.
createddateDatetimeFalseNoThe timestamp when the inventory adjustment record was first created in NetSuite.
customerStringFalseNoThe customer associated with this inventory adjustment, if applicable, typically used in cases involving customer-related stock movements.
customformStringFalseNoThe custom form template used for this inventory adjustment transaction, if a non-standard form is applied.
departmentStringFalseNoThe department linked to this inventory adjustment, useful for cost allocation and financial tracking.
estimatedtotalvalueDecimalFalseNoThe estimated total value of the inventory adjustment, based on item costs or valuations at the time of adjustment.
externalidStringFalseNoAn optional external identifier assigned to the inventory adjustment, often used for integrations with other systems.
lastmodifieddateDatetimeFalseNoThe timestamp of the most recent modification made to this inventory adjustment record.
memoStringFalseNoA freeform text field for entering additional notes or details about the inventory adjustment.
postingperiodStringFalseNoThe financial reporting period in which this inventory adjustment is recorded, ensuring proper accounting alignment.
subsidiaryStringFalseNoThe subsidiary entity within the organization to which this inventory adjustment belongs, relevant in multi-entity accounting.
trandateDateFalseNoThe transaction date of the inventory adjustment, indicating when the change in inventory occurred.
tranidStringFalseNoThe unique transaction ID assigned to the inventory adjustment, used for tracking and reference purposes.

Return to Top

inventoryAssignment 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for this inventory assignment entry. This value is automatically generated by the system and is used for referencing specific records.
binStringFalseNoThe designated storage location within a warehouse or distribution center where the inventory item is stored. Bin numbers help track and manage stock efficiently.
inventorynumberStringFalseNoThe unique serial or lot number assigned to a specific inventory item is used for tracking purposes and ensures the traceability of stock movements.
inventorystatusStringFalseNoThe current status of the inventory item, indicating its availability or restriction. Possible statuses may include 'Available,' 'On Hold,' or 'Reserved.'
quantityDecimalFalseNoThe total number of units for the specified inventory item allocated to a transaction, reflecting the exact amount taken from stock.
transactionStringFalseNoThe transaction record associated with this inventory assignment, such as a sales order, transfer order, or work order, helps track inventory movement.

Return to Top

InventoryBalance 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]IntegerFalseNoThe unique identifier for an inventory item within the system, including stock items, non-inventory items, kits, and more.
quantityavailableFloatFalseNoThe total quantity of the item currently available for allocation or sale.
binnumberIntegerFalseNoThe specific bin or storage location where the item is physically stored within a warehouse.
committedqtyperlocationFloatFalseNoThe quantity of the item that has been allocated to orders at a specific location but not yet shipped.
committedqtyperseriallotnumberFloatFalseNoThe quantity of the item that has been allocated to orders based on its serial or lot number.
committedqtyperseriallotnumberlocationFloatFalseNoThe quantity of the item allocated to orders based on both its serial/lot number and warehouse location.
inventorystatusIntegerFalseNoThe current status of the inventory, which can indicate availability, damage, or restrictions.
locationIntegerFalseNoThe identifier of the warehouse or facility where the item is stored is essential for effective inventory management.
quantityonhandFloatFalseNoThe total quantity of the item physically present in inventory, including allocated and unallocated stock.
quantitypickedFloatFalseNoThe quantity of the item that has been selected for fulfillment but not yet shipped from inventory locations.
inventorynumberIntegerFalseNoThe serial or lot number associated with a specific inventory item for tracking and compliance purposes.

Return to Top

inventorycostrevaluation 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account associated with this inventory cost revaluation, typically representing the asset or expense account affected.
classStringFalseNoThe classification category assigned to this transaction, used for tracking and reporting financial data by groups.
createddateDatetimeFalseNoThe timestamp indicating when this inventory cost revaluation record was initially created in the system.
customformStringFalseNoThe custom form template used for this transaction, which can define additional fields or workflows specific to business needs.
departmentStringFalseNoThe department associated with this inventory cost revaluation, providing organizational context for financial reporting and analysis.
externalidStringFalseNoA unique identifier assigned externally, often used for integrating data with third-party systems or legacy applications.
inventoryvalueDecimalFalseNoThe total inventory value after revaluation, reflecting cost adjustments based on updated pricing, market value, or internal changes.
itemStringFalseNoThe specific inventory item affected by this cost revaluation, typically identified by its SKU, name, or internal ID.
lastmodifieddateDatetimeFalseNoThe timestamp of the most recent update to this record, indicating when changes were last made.
locationStringFalseNoThe physical or logical location where the inventory adjustment applies, useful for multi-location inventory tracking.
memoStringFalseNoA freeform text field allowing users to enter additional notes or context regarding this inventory cost revaluation.
postingperiodStringFalseNoThe designated financial period during which this transaction is recorded, ensuring proper accounting period alignment.
subsidiaryStringFalseNoThe subsidiary within the corporate hierarchy to which this transaction belongs, relevant for multi-entity accounting.
taxperiodStringFalseNoThe tax reporting period applicable to this transaction, ensuring compliance with tax filing and regulatory requirements.
totalDecimalFalseNoThe overall financial impact of this inventory cost revaluation, including adjustments to unit cost and total inventory value.
trandateDateFalseNoThe date when this transaction is considered effective, which can differ from the creation date.
tranidStringFalseNoThe unique transaction ID assigned by NetSuite to identify this inventory cost revaluation record.
unitcostDecimalFalseNoThe adjusted cost per unit of the inventory item after revaluation, reflecting any recalculations in cost basis.

Return to Top

InventoryCostTemplate 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the inventory cost template, generated automatically by the system for referencing in scripts and integrations.
isinactiveBooleanFalseNoIndicates whether the inventory cost template is inactive. If set to 'true', this template is not available for selection or use.
memoStringFalseNoOptional field for adding notes or additional details about the inventory cost template. Can be used for internal documentation purposes.
nameStringFalseNoThe designated name of the inventory cost template. This name is used to identify and differentiate templates within the system.

Return to Top

InventoryCostTemplateCostDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
costcategoryStringFalseNoThe category assigned to the cost, which helps classify and track different types of expenses related to inventory items.
inventorycosttemplateStringFalseNoThe template used to define the cost structure for inventory items, specifying how different cost components are calculated.
itemStringFalseNoThe specific inventory item associated with this cost detail, linking the cost breakdown to a particular product or stock unit.
overheadamountDecimalFalseNoThe total overhead cost applied to this inventory item, represented as a fixed monetary amount.
overheadpercentageDoubleFalseNoThe percentage of overhead applied to the item's cost, calculated based on predefined costing rules.

Return to Top

inventorycount 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account associated with this inventory count. This helps track financial impacts and categorizations within the chart of accounts.
classStringFalseNoThe classification of the inventory count, which can be used for reporting and segmentation purposes.
createddateDatetimeFalseNoThe date and time when this inventory count record was initially created in the system.
departmentStringFalseNoThe department associated with this inventory count. This can help with financial reporting and cost allocation.
externalidStringFalseNoA unique identifier assigned to this record by an external system, facilitating data integration and synchronization.
lastmodifieddateDatetimeFalseNoThe date and time when this inventory count record was last updated or modified.
locationStringFalseNoThe physical or logical location where the inventory count took place. This helps track inventory levels across multiple locations.
memoStringFalseNoA free-form text field for adding additional notes or details related to this inventory count.
statusStringFalseNoThe current status of the inventory count, indicating whether it is pending, in progress, completed, or otherwise.
statusRefStringFalseNoA reference code associated with the status of the inventory count, often used for internal processing or API integrations.
subsidiaryStringFalseNoThe subsidiary to which this inventory count belongs. This is relevant for multi-entity organizations that track inventory separately by subsidiary.
trandateDateFalseNoThe transaction date of the inventory count, which represents when the count was conducted or recorded.
tranidStringFalseNoA unique identifier or transaction number assigned to this inventory count within the system.

Return to Top

inventorydetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
customformStringFalseNoThe custom form for inventory details determines the layout and structure used for entering or displaying inventory information.
externalidStringFalseNoA unique external identifier for this inventory detail used for integration with external systems or for data synchronization.
itemStringFalseNoThe specific item linked to this inventory detail referencing an inventory item, product, or material being tracked.
itemdescriptionStringFalseNoA textual description of the item in this inventory detail, which typically includes the product name, attributes, or any relevant information to identify the item.
locationStringFalseNoThe physical or logical location where the inventory is stored, representing a warehouse, store, or any other inventory-holding location.
quantityDoubleFalseNoThe number of units for the specified inventory item, capturing the amount being tracked, moved, or adjusted.
tolocationStringFalseNoThe destination location for inventory transfer. If an inventory transfer is occurring, this field indicates where the inventory is being moved to.
unitStringFalseNoThe unit of measure for the inventory item, such as 'each,' 'box,' or 'pound,' ensures consistency in tracking inventory quantities.

Return to Top

inventoryitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
alternatedemandsourceitemStringFalseNoThe item used as an alternative source to meet demand when the primary item is unavailable, which helps optimize inventory management and fulfillment.
assetaccountStringFalseNoThe general ledger account used to track the value of this inventory item as an asset, which is essential for financial reporting and balance sheet accuracy.
atpmethodStringFalseNoThe method used to calculate Available-to-Promise (ATP), which determines the quantity of inventory available for future orders based on supply and demand.
auctionquantityStringFalseNoThe total quantity of this inventory item listed in an auction. Helps in managing auction-based sales and ensuring stock availability.
auctiontypeStringFalseNoThe type of auction used for selling this item, such as standard, reserve, or Dutch auction. This is important for e-commerce and marketplace sales.
autoleadtimeBooleanFalseNoIndicates whether the lead time for this item is automatically calculated based on historical purchase or production data. Helps optimize inventory planning.
autopreferredstocklevelBooleanFalseNoIndicates whether the preferred stock level for this item is automatically determined based on historical demand and sales trends.
autoreorderpointBooleanFalseNoDetermines whether the reorder point for this item is automatically adjusted based on demand patterns, ensuring timely restocking to avoid stockouts.
availabletopartnersBooleanFalseNoIndicates whether this item is available for sales and transactions with business partners, such as vendors or distributors.
averagecostDecimalFalseNoThe average cost of acquiring or producing this item, calculated based on inventory valuation methods. Useful for financial and cost accounting.
billexchratevarianceacctStringFalseNoThe general ledger account used to record variances in exchange rates when billing transactions occur in foreign currencies.
billingscheduleStringFalseNoThe billing schedule associated with this item, defining how and when invoices are generated. Useful for subscription-based or installment billing.
billpricevarianceacctStringFalseNoThe account used to track variances between the expected and actual bill prices. Helps monitor and manage cost discrepancies.
billqtyvarianceacctStringFalseNoThe account used to track differences between expected and billed quantities. Helps in identifying discrepancies and managing procurement accuracy.
buyitnowpriceDecimalFalseNoThe price at which this item can be purchased immediately in an auction setting, bypassing the bidding process. Commonly used in e-commerce.
classStringFalseNoThe classification or category assigned to this inventory item, often used for financial reporting and organization. Helps in grouping items for analysis.
cogsaccountStringFalseNoThe general ledger account used to track the cost of goods sold (COGS) for this item. Essential for profit margin calculations and financial reporting.
conditionenabledStringFalseNoIndicates whether condition-based logic is enabled for this item, which can define custom rules for pricing, availability, or categorization.
conditionhelpurlStringFalseNoA URL providing additional guidance or documentation about item conditions. Useful for ensuring compliance with condition-based business rules.
consumptionunitStringFalseNoThe unit of measure used when consuming this inventory item, such as kilograms, liters, or pieces, which is essential for accurate stock tracking and cost calculation.
contingentrevenuehandlingBooleanFalseNoIndicates whether revenue recognition for this item is subject to contingent conditions, such as service delivery or customer acceptance.
conversionrateStringFalseNoThe rate at which this item converts into another unit of measure. Essential for inventory management when multiple units are involved.
copydescriptionBooleanFalseNoIndicates whether the item description should be automatically copied to related transactions or records.
costDecimalFalseNoThe base cost of this item, typically representing the purchase or production cost. This is important for pricing strategies and profitability analysis.
costcategoryStringFalseNoThe category assigned to this item for cost tracking purposes, such as raw materials, finished goods, or overhead.
costestimateDecimalFalseNoAn estimated cost for this item, often used in quoting, budgeting, or planning scenarios before actual cost determination.
costestimatetypeStringFalseNoThe methodology used to estimate the cost of this item, such as standard, average, or last purchase cost.
costingmethodStringFalseNoThe inventory valuation method applied to this item, such as FIFO, LIFO, or weighted average, determines how inventory costs are recorded and reported.
costingmethoddisplayStringFalseNoA user-friendly display of the costing method applied to this item, showing the selected valuation approach for clarity in reports and transactions.
costunitsStringFalseNoSpecifies the unit of measurement used for cost calculations, such as pieces, boxes, or kilograms.
countryofmanufactureStringFalseNoIndicates the country where the item was manufactured, which useful for compliance, reporting, and sourcing purposes.
createddateDatetimeFalseNoThe timestamp when the inventory item record was initially created in the system, which helps in tracking changes and auditing.
createrevenueplansonStringFalseNoDetermines whether revenue plans should be automatically generated for this item, useful for revenue recognition and financial forecasting.
currencyStringFalseNoRepresents the currency in which the item is priced and transactions are recorded, which is essential for multinational businesses.
customformStringFalseNoIdentifies the custom form associated with the inventory item, which can include user-defined fields and layouts for specific business needs.
custreturnvarianceaccountStringFalseNoSpecifies the account used to track variances in customer returns, ensuring accurate financial reconciliation.
deferredrevenueaccountStringFalseNoIndicates the general ledger account used for recording deferred revenue related to this item, which helps in proper revenue recognition.
deferrevrecBooleanFalseNoDefines whether revenue recognition should be deferred for this item. When set to 'true', revenue will be recognized over time rather than at the point of sale.
demandmodifierStringFalseNoAn adjustment factor applied to the item's demand forecast, allowing for manual corrections based on business insights.
demandtimefenceIntegerFalseNoSpecifies the number of days within which demand planning changes are restricted to avoid disruptions in supply chain management.
departmentStringFalseNoThe department associated with this inventory item, helping in cost allocation and reporting across different business units.
directrevenuepostingBooleanFalseNoIndicates whether revenue for this item is directly posted to the general ledger without deferral, which is useful for immediate revenue recognition.
displayinebaystoreBooleanFalseNoDetermines whether this item should be displayed in the eBay store when integrated with NetSuite, which is useful for online sales management.
displaynameStringFalseNoA user-friendly name for the item that appears in listings, reports, and customer-facing interfaces.
distributioncategoryStringFalseNoSpecifies the distribution category assigned to this item, aiding in logistics, fulfillment, and warehouse management.
distributionnetworkStringFalseNoIdentifies the distribution network through which this item is supplied, ensuring efficient inventory replenishment and order fulfillment.
dontshowpriceBooleanFalseNoIndicates whether the item price should be hidden from public or internal views, depending on business policies and customer agreements.
dropshipexpenseaccountStringFalseNoThe general ledger account used to record expenses related to drop-shipped orders, ensuring accurate cost tracking.
ebayhandlingtimeStringFalseNoSpecifies the handling time for eBay orders, influencing estimated delivery dates displayed to buyers.
ebayintlinsurancefeeDecimalFalseNoThe insurance fee applied to international eBay shipments for coverage against loss or damage during transit.
ebayintlpackagehandlingfeeDecimalFalseNoAn additional fee charged for handling international shipments via eBay, recovering costs related to packaging and processing.
ebayintlshipinsuranceStringFalseNoIndicates whether international shipping insurance is included for this item when sold on eBay.
ebayintlshippingitem1StringFalseNoDefines the first preferred international shipping method for this item on eBay, which is useful for setting up shipping options.
ebayintlshippingitem2StringFalseNoDefines the second preferred international shipping method for this item on eBay, providing customers with alternative shipping choices.
ebayintlshippingitem3StringFalseNoDefines the third preferred international shipping method for this item on eBay, allowing for flexibility in shipping options.
ebayisintlcalculatedrateStringFalseNoIndicates whether eBay automatically calculates international shipping rates based on package size, weight, and destination.
ebayisirregularpackageBooleanFalseNoSpecifies whether the item is considered an irregular package by eBay, affecting shipping costs and handling requirements.
ebayitemdescriptionStringFalseNoA detailed description of the item as it appears on eBay listings, influencing customer purchasing decisions.
ebayitemlocdisplayStringFalseNoThe display name for the item's location on eBay, helping buyers understand where the item ships from.
ebayitemloczipcodeStringFalseNoThe postal code for the item's shipping location, which eBay uses to calculate shipping estimates.
ebayitemlotsIntegerFalseNoSpecifies the number of item lots available for sale on eBay, determining bulk purchase options for buyers.
ebayitemsubtitleStringFalseNoA secondary title for the eBay listing that provides additional details or highlights specific features of the item.
ebayitemtitleStringFalseNoThe primary title of the item as listed on eBay, which helps buyers identify the product.
ebayitemweightamtStringFalseNoThe recorded weight of the item for eBay listings is used for shipping calculations and must match eBay’s required format.
ebaylayoutStringFalseNoThe specific eBay layout template applied to the listing, which dictates the visual presentation of the product page.
ebaypackagetypeStringFalseNoThe type of packaging used for shipping the item when listed on eBay, such as box, envelope, or custom packaging.
ebaypagecounterStringFalseNoIndicates the number of times the eBay listing page has been viewed by potential buyers for tracking engagement.
ebayrelistingoptionStringFalseNoDefines the automatic relisting settings for the eBay item when it remains unsold after the listing period expires.
ebaythemeStringFalseNoSpecifies the eBay theme applied to the listing, which influences the styling and layout of the product page.
ebaythemegroupStringFalseNoGroups related eBay themes for easier management and consistent branding across multiple listings.
enablecatchweightBooleanFalseNoIndicates whether catch weight processing is enabled for this item, allowing flexible weight adjustments at the point of sale.
endauctionswhenoutofstockBooleanFalseNoIf enabled, the eBay auction listing automatically ends when the item is out of stock, preventing overselling.
enforceminqtyinternallyBooleanFalseNoEnsures that internal inventory management adheres to minimum quantity rules, preventing sales below the defined threshold.
excludefromsitemapBooleanFalseNoIf enabled, this item will not be included in automatically generated sitemaps, reducing its visibility in search engine indexing.
externalidStringFalseNoA unique identifier assigned externally to track the item across different systems or platforms for integrations and mapping.
featureddescriptionStringFalseNoA highlighted description of the item that appears in prominent areas of product listings to attract customer interest.
fraudriskStringFalseNoAn internal classification or flag that indicates the level of risk associated with fraudulent transactions for this item.
froogleproductfeedStringFalseNoDetermines whether the product is included in Google Shopping (formerly Froogle) feeds for marketing and visibility purposes.
futurehorizonStringFalseNoDefines the future availability timeline of the item, typically used for demand planning and forecasting.
gainlossaccountStringFalseNoSpecifies the financial account used to record gains or losses related to this item, often for currency exchange fluctuations.
galleryBooleanFalseNoIndicates whether the item appears in the eBay gallery view, enhancing its visibility with a primary thumbnail image.
galleryfeaturedBooleanFalseNoIf enabled, the item is given premium positioning in eBay’s gallery, making it more prominent in search results.
gifttypeexpressshipBooleanFalseNoIndicates whether express shipping is available when this item is purchased as a gift.
gifttypegiftwrapBooleanFalseNoSpecifies whether gift wrapping is available as an option for this item at checkout.
gifttypeshiptorecipientBooleanFalseNoDetermines whether the item can be shipped directly to the recipient when purchased as a gift.
handlingcostDecimalFalseNoThe additional cost incurred for handling and processing the item before shipping, separate from shipping charges.
handlingcostunitsStringFalseNoThe units in which handling costs are measured, such as per order, per item, or per weight unit.
handlinggroupStringFalseNoA category grouping used to organize items with similar handling requirements, ensuring consistency in processing fees.
imagesgroupStringFalseNoAssociates the item with a specific group of images for display purposes, facilitating better visual presentation across platforms.
imageslocationStringFalseNoThe URL or file path where images related to this inventory item are stored.
includechildrenBooleanFalseNoIndicates whether child items associated with this inventory item should be included in reports and calculations.
incomeaccountStringFalseNoThe general ledger account where revenue from sales of this inventory item is recorded.
intercocogsaccountStringFalseNoThe intercompany cost of goods sold (COGS) account used for transactions involving related entities.
intercodefrevaccountStringFalseNoThe intercompany deferred revenue account used when recognizing revenue across related entities.
intercoincomeaccountStringFalseNoThe intercompany income account used for tracking revenue from transactions between subsidiaries.
internalidIntegerFalseNoA unique identifier that is automatically assigned to this inventory item within the system, serving as the primary key for items.
iscalculatedrateStringFalseNoSpecifies whether the rate for this item is automatically calculated based on predefined formulas.
isdonationitemBooleanFalseNoIndicates whether this inventory item is designated as a donation item, meaning it can be given away for charitable purposes.
isdropshipitemBooleanFalseNoIndicates whether this item is eligible for drop shipping, meaning it is shipped directly from the vendor to the customer.
isgcocompliantBooleanFalseNoSpecifies whether the item meets Global Commerce Compliance (GCO) standards for international trade.
isinactiveBooleanFalseNoIndicates whether this inventory item is currently active or inactive in the system.
isonlineBooleanFalseNoDetermines whether this inventory item is available for online sales through e-commerce platforms.
isspecialorderitemBooleanFalseNoIndicates whether this inventory item is designated as a special order item that requires unique handling or procurement.
isstorepickupallowedBooleanFalseNoSpecifies whether customers are allowed to pick up this inventory item from a physical store location.
issueproductStringFalseNoIdentifies the product or component issued when this inventory item is processed or fulfilled.
itemconditionStringFalseNoSpecifies the condition of the inventory item, such as new, refurbished, or used, which helps track item quality and suitability for sale.
itemhandlingfeeDecimalFalseNoRepresents any additional handling fee associated with this inventory item, including packaging, special storage, or extra labor costs.
itemidStringFalseNoThe unique identifier assigned to the inventory item within the NetSuite system, used for tracking and referencing the item across transactions and records.
iteminsurancefeeDecimalFalseNoIndicates the insurance cost associated with this inventory item. This can cover loss, damage, or liability during storage and shipping.
itemoptionsStringFalseNoLists the available configuration options for the inventory item, such as size, color, or other customizable attributes.
itemprocessfamilyStringFalseNoDefines the broader category or family of processes related to this inventory item, such as manufacturing workflows or inventory grouping.
itemprocessgroupStringFalseNoSpecifies the process group the inventory item within the larger process family for classification purposes.
itemrevenuecategoryStringFalseNoCategorizes the item based on its revenue classification, which helps in financial reporting and revenue recognition.
itemshipinsuranceStringFalseNoIndicates whether shipping insurance is applied to this item. Possible values can include 'Yes' or 'No' to denote coverage for potential shipping losses or damages.
itemtypeStringFalseNoDefines the type of inventory item, such as finished goods, raw materials, or services, helping in inventory management and reporting.
lastmodifieddateDatetimeFalseNoLogs when the inventory item was last modified, which is essential for auditing and tracking changes.
lastpurchasepriceDecimalFalseNoStores the most recent purchase price of the inventory item, which is useful for cost analysis, supplier negotiations, and financial reporting.
leadtimeIntegerFalseNoIndicates the number of days required to replenish this inventory item from the supplier, which is critical for inventory planning and demand forecasting.
listimmediateStringFalseNoSpecifies whether the item should be immediately listed for sale or availability upon entry into the system.
listingdurationStringFalseNoThe duration for which the item listing remains active before it expires or needs to be renewed, which is measured in days or a predefined period.
listingstartdateDateFalseNoThe date when the item listing becomes active and available for purchase.
listingstarttimeStringFalseNoThe specific time at which the item listing becomes active on the specified start date, typically formatted as HH:MM.
locationStringFalseNoThe designated physical or virtual location where the inventory item is stored, sold, or listed.
lowerwarninglimitDoubleFalseNoThe minimum threshold for item stock levels before triggering a low-stock warning, helping in inventory management and restocking.
manufacturerStringFalseNoThe name of the company or entity responsible for producing the inventory item.
manufactureraddr1StringFalseNoThe primary address line for the manufacturer's location, which can include street name and number.
manufacturercityStringFalseNoThe city where the manufacturer is located. Used for logistical and compliance purposes.
manufacturerstateStringFalseNoThe state or region where the manufacturer operates. Important for taxation and regulatory compliance.
manufacturertariffStringFalseNoThe tariff code associated with the manufacturer for taxation and import/export classification.
manufacturertaxidStringFalseNoThe tax identification number assigned to the manufacturer for compliance with financial and regulatory authorities.
manufacturerzipStringFalseNoThe postal or ZIP code for the manufacturer's location, aiding in logistics and tax-related documentation.
matchbilltoreceiptBooleanFalseNoIndicates whether billing details should match receipt details for the item. Used for validation in procurement and accounting.
matrixitemnametemplateStringFalseNoA predefined template used to generate names for matrix items, ensuring consistency in naming conventions.
matrixtypeStringFalseNoSpecifies the type of matrix item, such as a variation of a product (for example, size, color) to differentiate related inventory items.
maxdonationamountDecimalFalseNoThe maximum amount that can be donated from the sale of this inventory item, often used in charitable giving scenarios.
maximumquantityStringFalseNoThe highest quantity of the item that can be purchased in a single order. Used to enforce purchase limits.
metataghtmlStringFalseNoHTML meta tags associated with the item listing, used to optimize search engine visibility and online discoverability.
minimumquantityStringFalseNoThe minimum number of units that must be purchased in a single order, often used for bulk or wholesale pricing models.
minimumquantityunitsStringFalseNoDefines the unit of measurement for the minimum quantity (for example, pieces, boxes, packs) to clarify purchase requirements.
mossappliesBooleanFalseNoIndicates whether the item falls under the Mini One Stop Shop (MOSS) taxation scheme, applicable to digital goods and services in the EU.
mpnStringFalseNoThe Manufacturer Part Number (MPN), a unique identifier assigned by the manufacturer to distinguish this product from others.
multmanufactureaddrBooleanFalseNoIndicates whether the item has multiple manufacturing addresses, useful for supply chain tracking and compliance.
nextagcategoryStringFalseNoThe category under which the item is listed in Nextag's product feed, helping in product classification for marketing.
nextagproductfeedStringFalseNoSpecifies whether the item is included in Nextag's product feed, used for third-party marketplace visibility.
nopricemessageStringFalseNoA custom message displayed when pricing information is unavailable or restricted from display to certain users.
numactivelistingsIntegerFalseNoThe number of active listings for this item across different marketplaces, providing insights into availability and demand.
numcurrentlylistedIntegerFalseNoThe current count of the item’s listings in various sales channels, reflecting inventory status.
offersupportBooleanFalseNoIndicates whether the manufacturer or seller provides customer support for this item, such as warranties or troubleshooting assistance.
outofstockbehaviorStringFalseNoDefines the system’s behavior when the item is out of stock, such as backordering, hiding the listing, or notifying customers.
outofstockmessageStringFalseNoA predefined message displayed to customers when the item is out of stock, informing them about restocking timelines or alternatives.
overallquantitypricingtypeStringFalseNoSpecifies the type of pricing structure based on quantity, determining how bulk discounts or tiered pricing apply to the item.
packageheightStringFalseNoThe height of the item's packaging, typically measured in inches or centimeters, used for shipping and storage calculations.
packagelengthStringFalseNoThe length of the item's packaging, typically measured in inches or centimeters, used for logistics and warehouse space planning.
packagewidthStringFalseNoThe width of the item's packaging, typically measured in inches or centimeters, used for inventory storage and shipping calculations.
pagetitleStringFalseNoThe title of the item as it appears on an e-commerce website or internal catalog, often used for SEO and customer visibility.
parentStringFalseNoIndicates the parent item in a hierarchical structure, such as a parent-child relationship for matrix items or bundled products.
planningitemcategoryStringFalseNoDefines the category used for planning and demand forecasting, helping in setting reorder points and supply chain optimization.
preferencecriterionStringFalseNoSpecifies the criteria for preferential treatment in trade agreements, compliance documentation, or sourcing preferences.
preferredlocationStringFalseNoThe primary warehouse or distribution center where this item is ideally stocked to optimize order fulfillment and minimize shipping costs.
preferredstockleveldaysDoubleFalseNoThe number of days of stock supply considered optimal before reordering, ensuring stock availability without excessive inventory costs.
pricinggroupStringFalseNoGroups items with similar pricing strategies or discount structures, useful for managing customer-specific pricing rules.
primarycatdisplaynameStringFalseNoThe display name of the primary category under which the item is listed, typically used in product catalogs and online stores.
primarycategoryIntegerFalseNoThe numerical identifier representing the item's main category, useful for classification and reporting.
producerBooleanFalseNoIndicates whether the company is the manufacturer or producer of this item, affecting sourcing and branding strategies.
productfeedStringFalseNoSpecifies the marketing or sales channel feed, such as Google Shopping or Amazon Marketplace where this item is published for promotion.
purchasedescriptionStringFalseNoA detailed description of the item as it appears on purchase orders, typically including specifications and supplier-specific details.
purchaseorderamountStringFalseNoThe total monetary value of the item on a purchase order, calculated based on quantity and unit cost.
purchaseorderquantityStringFalseNoThe total number of units ordered from a supplier in a purchase order, affecting inventory replenishment.
purchaseorderquantitydiffStringFalseNoThe variance between the ordered quantity and the received quantity, used for tracking discrepancies in procurement.
purchasepricevarianceacctStringFalseNoThe accounting account used to track differences between the expected purchase price and the actual purchase price paid.
purchaseunitStringFalseNoThe unit of measurement used for purchasing this item, such as 'Each', 'Box', or 'Case', influencing supplier transactions.
quantitypricingscheduleStringFalseNoDefines the pricing schedule based on quantity tiers, allowing for automatic discounts on bulk purchases.
quantityreorderunitsStringFalseNoSpecifies the reorder quantity unit, ensuring replenishment aligns with packaging and supplier requirements.
receiptamountStringFalseNoThe total monetary value of received inventory for this item, used for reconciling purchase orders and invoices.
receiptquantityStringFalseNoThe actual quantity of this item received in inventory from a supplier, compared against purchase order expectations.
receiptquantitydiffStringFalseNoThe difference between the ordered quantity and received quantity, used for tracking procurement inconsistencies.
refundgivenasStringFalseNoSpecifies the method by which refunds are issued for this item, such as store credit, cash, or replacement.
relateditemsdescriptionStringFalseNoA description of related or complementary items often suggested for cross-selling or upselling in an online store.
reordermultipleStringFalseNoThe multiple in which this item must be reordered, ensuring that order quantities align with packaging and supplier requirements.
rescheduleindaysIntegerFalseNoDefines the number of days an inbound supply order can be rescheduled earlier, improving inventory planning.
rescheduleoutdaysIntegerFalseNoDefines the number of days an inbound supply order can be postponed, helping to adjust to changing demand or supply constraints.
reservepriceDecimalFalseNoThe minimum price at which an item can be sold to prevent underpricing. This price is typically used in auctions or special pricing agreements.
returnpolicyStringFalseNoDefines the rules governing product returns, including conditions under which a return is accepted and any applicable fees.
returnpolicydetailsStringFalseNoProvides additional information regarding the return policy, including exceptions, special conditions, and refund methods.
returnshippingpaidbyStringFalseNoSpecifies who is responsible for covering the cost of return shipping, whether it is the buyer, seller, or shared responsibility.
returnswithinStringFalseNoIndicates the allowable time frame within which a customer can return an item for a refund or exchange, typically in days or weeks.
revenueallocationgroupStringFalseNoCategorizes the item into a revenue allocation group used for financial reporting and revenue recognition processes.
revenuerecognitionruleStringFalseNoDefines the rule applied to recognize revenue for this item, ensuring compliance with accounting standards and business policies.
revrecforecastruleStringFalseNoSpecifies the forecasting rule used to predict revenue recognition over time, aiding in financial planning and analysis.
revreclassfxaccountStringFalseNoRepresents the foreign exchange reclassification account associated with revenue recognition for this item. Helps manage currency fluctuations in financial records.
revrecscheduleStringFalseNoDetermines the revenue recognition schedule, outlining how and when revenue is recognized over a specified period.
safetystocklevelDoubleFalseNoThe minimum inventory level maintained to prevent stockouts due to demand fluctuations or supply chain delays.
safetystockleveldaysIntegerFalseNoThe estimated number of days for which the safety stock level should sustain demand before replenishment occurs.
safetystocklevelunitsStringFalseNoDefines the unit of measure associated with the safety stock level, such as pieces, cases, or kilograms.
salesdescriptionStringFalseNoA detailed description of the item used in sales transactions, providing relevant product details for customers and sales teams.
saleunitStringFalseNoThe standard unit of measure in which this item is sold, such as a single unit, dozen, or pack.
schedulebcodeStringFalseNoA classification code used for exporting goods, ensuring compliance with international trade regulations.
schedulebnumberStringFalseNoA numerical identifier assigned to an item based on the U.S. Census Bureau's Schedule B classification for export tracking.
schedulebquantityStringFalseNoThe standard quantity associated with the Schedule B classification, defining the reporting unit for export compliance.
searchkeywordsStringFalseNoA set of keywords associated with the item to enhance searchability in online listings and internal catalogs.
seasonaldemandBooleanFalseNoIndicates whether the item experiences fluctuations in demand based on seasons, such as holiday-related products.
secondarybaseunitStringFalseNoAn alternative base unit of measure for the item, often used in multi-unit tracking or international transactions.
secondarycatdisplaynameStringFalseNoThe display name of the secondary product category, providing an additional classification for better catalog organization.
secondarycategoryIntegerFalseNoA numeric identifier for the secondary product category, used for alternative classifications in reporting and analysis.
secondaryconsumptionunitStringFalseNoDefines an alternate unit of consumption for the item, used in industries where products are consumed in multiple forms.
secondarypurchaseunitStringFalseNoThe unit of measure used when purchasing this item, which can differ from the standard sale or stock unit.
secondarysaleunitStringFalseNoAn alternative unit of measure for sales, providing flexibility in selling different package sizes or bulk quantities.
secondarystockunitStringFalseNoThe unit of measure used for inventory tracking in secondary storage or warehouse locations.
secondaryunitstypeStringFalseNoDefines the type of unit associated with the secondary measurement system, ensuring consistency in inventory tracking.
sellonebayBooleanFalseNoIndicates whether this item is listed for sale on eBay, enabling integration with online marketplace sales channels.
shipasiaBooleanFalseNoSpecifies whether this item is eligible for shipping to Asia, ensuring compliance with international shipping regulations.
shipaustraliaBooleanFalseNoSpecifies whether this item is eligible for shipping to Australia, determining regional availability for customers.
shipcanadaBooleanFalseNoIndicates whether this item can be shipped to Canada. A value of 'true' means shipping is available to Canada, while 'false' means it is restricted.
shipeuropeBooleanFalseNoSpecifies whether the item is eligible for shipping within Europe. If 'true,' the item can be shipped to European countries; otherwise, it is restricted.
shipgermanyBooleanFalseNoDenotes whether this item can be shipped specifically to Germany. A 'true' value means it is available for shipping to Germany.
shipindividuallyBooleanFalseNoIndicates whether this item must be shipped separately from other items. This is typically used for fragile or oversized items requiring special handling.
shipjapanBooleanFalseNoDetermines whether the item can be shipped to Japan. A 'true' value means shipping is available, whereas 'false' indicates restrictions.
shipmexicoBooleanFalseNoSpecifies whether this item can be shipped to Mexico. If 'true,' it is eligible for shipping within Mexico.
shipnorthsouthamericaBooleanFalseNoIndicates whether the item can be shipped to countries in North and South America, excluding the United States.
shippackageStringFalseNoDefines the type of shipping package required for this item. This field helps determine packaging dimensions and shipping costs.
shippingcostDecimalFalseNoRepresents the cost of shipping this item. The value is stored as a decimal number and can be determined by weight, size, or shipping region.
shippingcostunitsStringFalseNoSpecifies the units used for the shipping cost, such as United States Dollar (USD), Euro (EUR), or other currency codes.
shippingdomesticmethodsgroupStringFalseNoCategorizes the domestic shipping methods available for this item, grouping them for easier selection and application.
shippingdomgroupStringFalseNoDefines the shipping group for domestic orders, determining available shipping options and rates within the country.
shippingintlgroupStringFalseNoCategorizes available international shipping methods for this item, grouping them based on region or carrier.
shippingintlgroup1StringFalseNoSpecifies the first group of international shipping options applicable to this item. This can include specific carriers or service levels.
shippingintlgroup2StringFalseNoDefines the second set of international shipping options available for this item, allowing for more granular control over shipping preferences.
shippingintlgroup3StringFalseNoLists the third group of international shipping methods that can be used for this item, providing additional shipping flexibility.
shippingitem1StringFalseNoDenotes a specific shipping item associated with this product. This can include a predefined packaging type or shipping rate configuration.
shippingitem2StringFalseNoIdentifies another shipping item related to this product, potentially defining different packaging or rate structures.
shippingitem3StringFalseNoSpecifies a third shipping item associated with this product, offering additional shipping configuration options.
shippinglocationsgroupStringFalseNoCategorizes the locations where this item can be shipped. This grouping aids in managing regional shipping restrictions and logistics.
shippingpackaginggroupStringFalseNoDefines the packaging group assigned to this item, used for determining how the item should be packed for shipping.
shippingrate1DecimalFalseNoSpecifies the first tier of shipping rates for this item. These rates can vary based on destination, package weight, or service level.
shippingrate2DecimalFalseNoRepresents the second tier of shipping rates available for this item, providing additional pricing options for different shipping conditions.
shippingrate3DecimalFalseNoLists the third tier of shipping rates for this item, offering further pricing flexibility for different scenarios.
shipukBooleanFalseNoIndicates whether the item is eligible for shipping to the United Kingdom. A 'true' value means the item can be shipped there.
shipworldwideBooleanFalseNoSpecifies whether this item can be shipped globally, without regional restrictions. A 'true' value means worldwide shipping is available.
shoppingdotcomcategoryStringFalseNoDefines the category of this item on Shopping.com. This classification helps in product organization and discoverability.
shoppingproductfeedStringFalseNoIndicates whether this item is included in the Shopping.com product feed, which is used for online advertising and marketplace visibility.
shopzillacategoryidIntegerFalseNoRepresents the Shopzilla category ID assigned to this item, helping classify it appropriately within the Shopzilla marketplace.
shopzillaproductfeedStringFalseNoSpecifies whether this item is included in the Shopzilla product feed, which enables listing on the Shopzilla shopping platform.
showasgiftBooleanFalseNoIndicates whether this item can be designated as a gift option during checkout. A 'true' value allows customers to mark it as a gift.
showdefaultdonationamountBooleanFalseNoIndicates whether the default donation amount is displayed when the item is presented in the storefront or donation page.
sitemappriorityStringFalseNoSpecifies the priority of this item in the sitemap, affecting how search engines rank it in indexing.
softdescriptorStringFalseNoA short description that appears on a customer's credit card statement when purchasing this item.
standardimagesStringFalseNoReferences the standard images associated with this inventory item for display in online catalogs and product listings.
startingpriceDecimalFalseNoRepresents the initial price of the item before any discounts, promotions, or markups are applied.
stockdescriptionStringFalseNoA brief description of the stock status or condition of the item, used for internal and external reference.
stockunitStringFalseNoDefines the unit of measure used to track stock quantities for this item, such as pieces, boxes, or kilograms.
storecatdisplaynameStringFalseNoThe display name assigned to the item's primary store category, shown in online and in-store catalogs.
storecatdisplayname2StringFalseNoThe display name assigned to the item's secondary store category, if applicable, for classification in multiple categories.
storecategoryIntegerFalseNoThe numeric identifier for the item's primary store category, linking it to a classification in the catalog hierarchy.
storecategory2IntegerFalseNoThe numeric identifier for the item's secondary store category, allowing placement in an alternative category.
storedescriptionStringFalseNoA detailed description of the item as it appears in the online store, often including product specifications and features.
storedetaileddescriptionStringFalseNoAn extended description of the item, providing additional context, usage instructions, or promotional content.
storedisplayimageStringFalseNoURL or file reference for the primary image used to represent the item in the store display.
storedisplaynameStringFalseNoThe name of the item as displayed to customers in the store interface, typically used to provide a user-friendly and descriptive name.
storedisplaythumbnailStringFalseNoURL or file reference for the thumbnail image of the item, typically used in category pages and search results.
storeitemtemplateStringFalseNoSpecifies the template used for displaying the item in the online store, affecting its layout and presentation.
subsidiaryStringFalseNoIndicates the subsidiary to which this inventory item belongs, used in multi-entity organizations.
supersizeimagesBooleanFalseNoDetermines whether larger, high-resolution images of the item are available for zoom functionality in the store.
supplyreplenishmentmethodStringFalseNoDefines the method by which this inventory item is restocked, such as purchase orders, work orders, or transfers.
supplytimefenceIntegerFalseNoSpecifies the number of days within which supply orders should not be modified, ensuring stability in planning.
taxableBooleanFalseNoIndicates whether the item is subject to sales tax based on tax codes and jurisdiction rules.
taxscheduleStringFalseNoThe tax schedule associated with the item, determining the applicable tax rates and exemptions.
templatesgroupStringFalseNoSpecifies the group of item templates that this inventory item is associated with, aiding in bulk categorization.
totalvalueDecimalFalseNoRepresents the total value of the inventory item based on cost and quantity available.
tracklandedcostBooleanFalseNoIndicates whether the landed cost, including shipping, duties, and handling fees, is tracked for this item.
transferpriceDecimalFalseNoThe price at which the item is transferred between subsidiaries or locations within the organization.
transferpriceunitsStringFalseNoDefines the unit of measure for transfer pricing calculations, such as per unit, per kilogram, or per dozen.
unitstypeStringFalseNoSpecifies the unit type classification of the item, determining how quantities are measured and converted.
upccodeStringFalseNoThe Universal Product Code (UPC) associated with this item, used for scanning and tracking in inventory systems.
upperwarninglimitDoubleFalseNoThe maximum allowable quantity threshold for the item before triggering a warning, often used in stock management.
urlcomponentStringFalseNoThe URL-friendly component used to generate the item's product page link, typically derived from its name.
usebinsBooleanFalseNoIndicates whether bin tracking is enabled for this item, allowing for location-based inventory management.
usemarginalratesBooleanFalseNoDetermines whether marginal tax rates are applied to this item in tax calculations.
vendornameStringFalseNoThe primary vendor or supplier associated with this inventory item, used for procurement and reporting.
vendreturnvarianceaccountStringFalseNoThe accounting account used to track variances when vendor returns occur for this item.
vsoedeferralStringFalseNoSpecifies the method of revenue deferral under Vendor-Specific Objective Evidence (VSOE) accounting rules.
vsoedeliveredBooleanFalseNoIndicates whether the item has been delivered as part of a sale with VSOE revenue recognition.
vsoepermitdiscountStringFalseNoDetermines whether discounts are permitted for this item under VSOE revenue recognition rules.
vsoepriceDecimalFalseNoThe price assigned to the item under VSOE, used for revenue allocation in multi-element arrangements.
vsoesopgroupStringFalseNoSpecifies the standard operating procedure (SOP) group to which this item belongs under VSOE accounting.
weightDoubleFalseNoThe weight of the item, typically measured in pounds or kilograms, used for shipping and handling calculations.
weightunitStringFalseNoDefines the unit of measure for the item's weight, such as grams, ounces, pounds, or kilograms.
weightunitsStringFalseNoSpecifies the weight measurement system used for this item, ensuring consistency in shipping and logistics.
willshipStringFalseNoIndicates the shipping eligibility of the item, such as whether it can be shipped domestically or internationally.
yahooproductfeedStringFalseNoSpecifies whether this item is included in the Yahoo product feed for external marketing and sales integrations.

Return to Top

inventoryItemCorrelateditem 

NameTypeReadOnlyReferencesFilterOnlyDescription
correlationfldDoubleFalseNoThe correlation percentage represents the statistical relationship between this item and another item, indicating how often they are purchased together.
countfldIntegerFalseNoThe count field captures the number of times this item has been correlated with another item based on purchase patterns.
itemStringFalseNoThe identifier or name of the item being analyzed, comparing the primary inventory item with its related or suggested items.
itemnkeyfldStringFalseNoThe key field representing the item in NetSuite's database, used to uniquely identify inventory items for correlation analysis.
liftfldDoubleFalseNoThe lift percentage measures how strongly items are associated, reflecting their likelihood of being purchased together versus random chance.

Return to Top

inventoryItemItemAccountingBookDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with the inventory item. This determines the financial treatment of the item within different accounting frameworks.
itemStringFalseNoThe unique identifier or name of the inventory item. This field links the item to its specific accounting book entry.

Return to Top

inventoryItemItemQuantityPricingDiscount 

NameTypeReadOnlyReferencesFilterOnlyDescription
leveldiscountDoubleFalseNoThe discount percentage or amount applied to an inventory item at a specific quantity pricing level.
levelpricenameStringFalseNoThe name of the price level associated with this inventory item, typically used to define different pricing structures for various customer segments or quantity tiers.
parentitemStringFalseNoThe identifier or name of the parent inventory item linked to this pricing level organizes pricing information for items that may have multiple pricing levels.

Return to Top

inventoryItemItemQuantityPricingLevel 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoRepresents the unique identifier or name of the inventory item being referenced. This value corresponds to an item in the NetSuite inventory system.
leveldiscountDoubleFalseNoIndicates the discount percentage applied to the inventory item at a specific pricing level, typically determined by predefined pricing rules in NetSuite.

Return to Top

inventoryItemItemVendor 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe unique identifier or name of the inventory item associated with a specific vendor.
preferredvendorBooleanFalseNoIndicates whether this vendor is the preferred supplier for the given inventory item. A value of 'true' means the vendor is preferred.
purchasepriceStringFalseNoThe cost at which the inventory item is purchased from the vendor. This value reflects the agreed-upon price before any discounts or taxes.
scheduleStringFalseNoThe purchasing schedule or frequency with which the inventory item is ordered from the vendor. This can represent predefined procurement cycles.
subsidiaryStringFalseNoThe specific subsidiary within the organization that is responsible for purchasing the inventory item from the vendor. Useful for multi-entity organizations.
vendorStringFalseNoThe name or identifier of the vendor supplying the inventory item. This links the item to its supplier in the procurement system.
vendorcodeStringFalseNoThe internal or vendor-provided code used to identify the inventory item in the vendor’s catalog. Helps match vendor-specific product references.
vendorcostenteredDecimalFalseNoThe cost of the inventory item as entered in the system, which can include vendor-specific pricing considerations before conversion or adjustments.
vendorcurrencyidStringFalseNoThe currency in which the vendor's pricing is recorded. Ensures accurate cost tracking across international transactions.

Return to Top

inventoryItemLocations 

NameTypeReadOnlyReferencesFilterOnlyDescription
atpleadtimeIntegerFalseNoThe number of days required before an item becomes available for promise to customers based on available-to-promise (ATP) calculations.
averagecostmliDecimalFalseNoThe average cost of an inventory item across all transactions and locations, calculated based on the costing method applied.
backwardconsumptiondaysIntegerFalseNoThe number of days before a demand requirement date within which forecasted demand can be adjusted or consumed by actual orders.
costDecimalFalseNoThe standard unit cost assigned to the inventory item, typically used for cost accounting and valuation purposes.
costaccountingstatusStringFalseNoThe current status of the item within cost accounting processes, indicating whether cost calculations are pending, completed, or require updates.
costinglotsizeDoubleFalseNoThe predefined lot size used to calculate per-unit costs in cost accounting, influencing standard and weighted average costing calculations.
currentstandardcostDecimalFalseNoThe most recent standard cost assigned to the item, reflecting its predetermined valuation for cost management and financial reporting.
currentstandardcosteffectivedateDateFalseNoThe date when the current standard cost of the item became effective, marking the point at which cost updates were applied.
defaultreturncostDecimalFalseNoThe cost value applied when an item is returned to inventory, often based on average cost, last purchase price, or a predefined default.
demandsourceStringFalseNoThe origin of demand for the item, specifying whether it arises from sales orders, production orders, transfer orders, or forecasts.
demandtimefenceIntegerFalseNoThe number of days within which demand is considered firm and not subject to changes due to forecast adjustments.
fixedlotsizeDoubleFalseNoThe fixed quantity used when replenishing inventory, ensuring that orders or production runs adhere to a predefined batch size.
forwardconsumptiondaysIntegerFalseNoThe number of days after a demand requirement date within which forecasted demand can be adjusted or consumed by actual orders.
inventorycosttemplateStringFalseNoA predefined template that dictates how inventory costs are calculated and applied based on selected costing methods and parameters.
invtclassificationStringFalseNoThe categorization of the inventory item based on predefined criteria, such as A, B, or C classifications for cycle counting or stock priority.
invtcountintervalIntegerFalseNoThe number of days between scheduled inventory counts, determining how frequently the item should be counted in cycle counting procedures.
itemStringFalseNoThe unique identifier or name of the inventory item, representing a specific SKU or product within the system.
lastinvtcountdateDateFalseNoThe most recent date on which a physical inventory count was conducted for this item at the specified location.
lastpurchasepricemliDecimalFalseNoThe most recent purchase price paid for the item, recorded from supplier transactions and used for procurement analysis.
locationStringFalseNoThe specific warehouse, store, or inventory location where the item is stored and tracked within the system.
nextinvtcountdateDateFalseNoThe next scheduled date for performing an inventory count of this item based on cycle count frequency and classification.
periodiclotsizedaysIntegerFalseNoThe number of days in each periodic lot size increment, determining the batch intervals for ordering or production replenishments.
periodiclotsizetypeStringFalseNoThe method used for periodic lot sizing, specifying whether lots are calculated based on fixed periods, dynamic intervals, or other strategies.
preferredstocklevelDoubleFalseNoThe optimal quantity of an item that should be maintained in inventory to ensure smooth operations without overstocking.
qtyintransitexternalDoubleFalseNoThe total quantity of this item currently in transit from an external supplier or source, not yet received into inventory.
quantityavailableDoubleFalseNoThe total quantity of the item that is currently available for sale or internal use, excluding committed and back-ordered quantities.
quantitybackorderedDoubleFalseNoThe total quantity of this item that has been ordered by customers but is not yet fulfilled due to insufficient stock.
quantitycommittedDoubleFalseNoThe total quantity of this item that has been allocated to fulfill open orders but is not yet shipped or consumed.
quantityintransitDoubleFalseNoThe total quantity of the item currently being transferred between internal locations, warehouses, or distribution centers.
quantityonhandDoubleFalseNoThe total physical quantity of the item currently in stock at the specified location, including available and committed inventory.
quantityonorderDoubleFalseNoThe total quantity of this item that has been ordered from suppliers or through internal production but has not yet been received.
reorderpointDoubleFalseNoThe inventory threshold at which a replenishment order should be triggered to prevent stockouts, based on demand and lead time calculations.
rescheduleindaysIntegerFalseNoThe number of days by which an inbound supply order can be rescheduled earlier to align with changing demand requirements.
rescheduleoutdaysIntegerFalseNoThe number of days by which an inbound supply order can be rescheduled later due to shifts in demand or supply constraints.
supplylotsizingmethodStringFalseNoThe method used to determine how lot sizes are calculated for supply planning, such as fixed lot sizes or economic order quantity (EOQ).
supplytimefenceIntegerFalseNoThe number of days within which planned supply orders are considered firm and not subject to automatic rescheduling by the system.
supplytypeStringFalseNoThe categorization of supply sources, indicating whether the item is replenished through purchase, production, transfers, or other methods.

Return to Top

inventoryItemPresentationItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
basepriceDecimalFalseNoThe standard price assigned to the inventory item before any discounts, promotions, or dynamic pricing adjustments.
descriptionStringFalseNoA detailed description of the inventory item, typically used for display purposes in catalogs, reports, or e-commerce listings.
onlinepriceDecimalFalseNoThe price of the inventory item as displayed in online sales channels, which can differ from the base price due to promotions, regional adjustments, or custom pricing rules.
presentationitemStringFalseNoAn associated or complementary item recommended for display alongside the main inventory item, often used for upselling or cross-selling purposes.
presitemidIntegerFalseNoThe internal identifier for the related presentation item, uniquely distinguishing it within the NetSuite system.
superitemStringFalseNoA higher-level or parent item that the current inventory item is associated with, typically used for bundling, kits, or hierarchical product structures.

Return to Top

inventoryItemPrice 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencypageStringFalseNoThe currency associated with the item price, determining the monetary unit for the amount displayed.
discountdisplayDoubleFalseNoThe default percentage discount applied to this item price, which affects the final sale price for transactions.
isinactiveBooleanFalseNoIndicates whether this item price record is inactive. If true, the price is not used in transactions.
itemStringFalseNoThe unique identifier or name of the item for which this price entry is applicable, ensuring each entry is associated with a valid inventory item.
priceDecimalFalseNoThe monetary amount assigned to the item in the specified currency, before any additional discounts or taxes.

Return to Top

inventoryItemQuantity 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe unique identifier or name of the inventory item being tracked. This could be a Stock Keeping Unit (SKU), product name, or another reference.
maxcountIntegerFalseNoThe maximum allowable quantity of this inventory item that can be stored or ordered, managing stock levels and avoiding overstocking.
mincountIntegerFalseNoThe minimum required quantity of this inventory item before a reorder or replenishment action is triggered, ensuring that stock does not fall below a critical threshold.

Return to Top

inventoryItemSiteCategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
categorydescriptionStringFalseNoA textual representation of the inventory item's category, providing additional details about its classification.
isdefaultBooleanFalseNoIndicates whether this category is the preferred or default classification for the inventory item.
itemStringFalseNoThe unique identifier or name of the inventory item, representing a specific product or material in stock.
websiteStringFalseNoSpecifies the website or e-commerce platform associated with this inventory item, helping track availability across multiple online sales channels.

Return to Top

inventoryItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoRepresents the unique identifier for an inventory item that corresponds to a specific product or Stock Keeping Unit (SKU) that is tracked in the inventory.

Return to Top

inventoryItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe unique identifier for the inventory item that is being translated. This corresponds to the item record in NetSuite.
displaynameStringFalseNoThe name of the item as it should appear in the storefront or other user-facing interfaces. This is typically used for branding and easy recognition.
languageStringFalseNoThe language code associated with the translated text, ensuring that the correct localization is applied to the item's details.
nopricemessageStringFalseNoA custom message displayed when the item's price is unavailable. This is often used for products that require a quote or have variable pricing.
outofstockmessageStringFalseNoA message that is shown when the item is out of stock, informing customers of unavailability or providing restocking details.
pagetitleStringFalseNoThe title of the product page when displayed in a web store or search engine results. This is useful for SEO and improving user navigation.
salesdescriptionStringFalseNoA brief, sales-focused description of the item, highlighting key features and benefits to encourage purchases.
storedescriptionStringFalseNoA detailed description of the item used in an online store, providing key information that helps customers make purchasing decisions.
featureddescriptionStringFalseNoA highlighted description of the item, typically used for promotional purposes or special feature callouts.
specialsdescriptionStringFalseNoA description used to highlight any special promotions, discounts, or exclusive offers related to the item.
storedisplaynameStringFalseNoThe name of the item as it appears in the online store, tailored for customer visibility and marketing presentation.
storedetaileddescriptionStringFalseNoAn in-depth description of the item displayed in the online store, providing comprehensive details, specifications, and usage information.

Return to Top

inventorynumber 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the inventory number record, used for system reference and database management.
expirationdateDateFalseNoThe date on which the inventory number expires, indicating when the associated item should no longer be used or sold.
externalidStringFalseNoA unique identifier assigned externally to track the inventory number in an external system, ensuring consistency across platforms.
itemStringFalseNoThe name or unique identifier of the inventory item associated with this inventory number, linking it to a specific product or Stock Keeping Unit (SKU).
memoStringFalseNoA free-text field that allows users to enter additional notes or comments related to the inventory number, such as storage conditions or special handling instructions.

Return to Top

InventoryNumberLocation 

NameTypeReadOnlyReferencesFilterOnlyDescription
inventorynumberStringFalseNoThe unique identifier assigned to a specific inventory item, typically used for tracking and verification purposes.
locationStringFalseNoThe designated storage or fulfillment site where the inventory item is currently located, such as a warehouse, store, or distribution center.
quantityavailableDoubleFalseNoThe total number of units of the inventory item that are currently available for sale or use, excluding items that are already allocated or reserved.
quantityintransitDoubleFalseNoThe number of units of the inventory item that are currently being transferred between locations, such as shipments in progress or items being moved from one warehouse to another.
quantityonhandDoubleFalseNoThe total count of units physically present in inventory, including those allocated for orders but not yet shipped, and excluding backordered or incoming stock.

Return to Top

inventorystatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique identifier for the inventory status record, used internally by NetSuite.
descriptionStringFalseNoDetailed explanation or label for the inventory status, providing additional context on its usage.
externalidStringFalseNoAn optional identifier that can be used to reference this inventory status record from external systems.
inventoryavailableBooleanFalseNoIndicates whether inventory associated with this status is available for order commitment and allocation.
isinactiveBooleanFalseNoSpecifies whether this inventory status is inactive. Inactive statuses cannot be assigned to items or transactions.
nameStringFalseNoThe user-defined name of the inventory status, used for classification and selection within NetSuite.

Return to Top

inventorystatuschange 

NameTypeReadOnlyReferencesFilterOnlyDescription
externalidStringFalseNoA unique identifier assigned to the inventory status change transaction, typically used for external reference and system integration.
locationStringFalseNoThe physical or logical location associated with the inventory status change. This field helps track where the inventory is stored or processed.
memoStringFalseNoA free-text field where users can enter additional notes or explanations regarding the inventory status change. This can include reasons for the update or any relevant context.
previousstatusStringFalseNoThe inventory status before the change was applied. This represents the previous categorization of the inventory, such as Available, Backordered, or Damaged.
revisedstatusStringFalseNoThe updated inventory status after the change has been applied. This field reflects the new categorization, indicating whether the inventory is now Available, On Hold, Reserved, or another designated status.

Return to Top

inventorytransfer 

NameTypeReadOnlyReferencesFilterOnlyDescription
classStringFalseNoThe classification assigned to this inventory transfer, used for categorization and reporting within NetSuite.
createddateDatetimeFalseNoThe timestamp when this inventory transfer record was initially created in NetSuite.
departmentStringFalseNoThe department associated with this inventory transfer, typically used for financial tracking and departmental cost allocation.
externalidStringFalseNoA unique identifier for this inventory transfer that originates from an external system, allowing for integration and data synchronization.
lastmodifieddateDatetimeFalseNoThe timestamp indicating the most recent update to this inventory transfer record.
locationStringFalseNoThe originating location from which inventory is being transferred, representing a warehouse, store, or distribution center.
memoStringFalseNoA free-text field used to capture additional details or notes related to this inventory transfer.
postingperiodStringFalseNoThe accounting period in which this inventory transfer is recorded, determining when it impacts financial statements.
subsidiaryStringFalseNoThe business entity or subsidiary responsible for this inventory transfer, relevant in multi-entity organizations using NetSuite.
totalDecimalFalseNoThe total monetary value of the items being transferred, calculated based on unit cost and quantity.
trandateDateFalseNoThe date when this inventory transfer transaction is recorded, typically reflecting the actual movement of goods.
tranidStringFalseNoA system-generated unique identifier for this inventory transfer transaction within NetSuite.
transferlocationStringFalseNoThe destination location to which inventory is being transferred, representing a warehouse, store, or distribution center.

Return to Top

invoice 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with this invoice, typically representing the financial account used for recording transactions.
althandlingcostDecimalFalseNoThe alternative handling cost applied to the invoice, usually reflecting special handling fees or adjustments.
altshippingcostDecimalFalseNoThe alternative shipping cost applied to the invoice, used when an alternative rate is used instead of standard shipping charges.
amountpaidDecimalFalseNoThe total amount that has been paid against this invoice, reducing the outstanding balance.
amountremainingDecimalFalseNoThe remaining balance due on the invoice after payments and adjustments have been applied.
amountremainingtotalboxDecimalFalseNoThe total remaining balance displayed in the summary section of the invoice, aggregating all outstanding amounts.
approvalstatusStringFalseNoIndicates the current approval status of the invoice, such as pending, approved, or rejected.
asofdateDateFalseNoThe effective date for financial reporting purposes, representing when the invoice data is considered valid.
balanceDecimalFalseNoThe total outstanding balance on this invoice, reflecting unpaid amounts after all payments and credits have been accounted for.
billaddressStringFalseNoThe billing address where the invoice is directed, typically including recipient name, street address, city, and postal code.
billaddresslistStringFalseNoA reference to a predefined list of billing addresses associated with the customer.
billingaccountStringFalseNoThe specific billing account linked to this invoice, used for categorization and financial tracking.
billingaddressStringFalseNoThe complete formatted billing address for the invoice recipient, used for official correspondence.
billisresidentialStringFalseNoIndicates whether the billing address is a residential location, which can impact tax calculations and delivery methods.
bulkprocsubmissionStringFalseNoIndicates whether this invoice was submitted as part of a bulk processing operation, useful for tracking large-scale transactions.
canhavestackableBooleanFalseNoSpecifies whether multiple discounts or promotions can be stacked on this invoice, affecting pricing calculations.
classStringFalseNoThe accounting classification assigned to this invoice, often used for departmental tracking and reporting.
consolidatebalanceDecimalFalseNoThe total consolidated balance across related invoices or financial entities, useful for aggregated reporting.
couponcodeStringFalseNoA promotional code applied to the invoice, potentially reducing the total amount due.
createddateDatetimeFalseNoThe date and time when the invoice was originally created in the system, which is automatically generated.
createdfromStringFalseNoThe source transaction or document from which this invoice was generated, such as a sales order.
currencyStringFalseNoThe currency in which this invoice is denominated, based on the customer's default or selected currency.
currencynameStringFalseNoThe name of the currency associated with this invoice, such as US Dollar or Euro.
currencysymbolStringFalseNoThe symbol of the currency used in this invoice, such as $ for US dollars, € for euros, or £ for British pounds.
customformStringFalseNoA reference to the custom invoice form template used for this specific transaction, allowing for customized layouts.
deferredrevenueDecimalFalseNoThe portion of the invoice amount recognized as deferred revenue, indicating income that will be realized in future periods.
departmentStringFalseNoThe department responsible for the transaction, used for internal accounting and reporting.
discountamountDecimalFalseNoThe total discount amount applied to this invoice, reducing the payable balance.
discountdateDateFalseNoThe date by which the discount must be utilized to be applicable, typically part of early payment terms.
discountitemStringFalseNoThe specific discount item or policy applied to this invoice, often referencing predefined discount rules.
discountrateStringFalseNoThe rate or percentage of discount applied to this invoice, affecting the overall price calculation.
discounttotalDecimalFalseNoThe total sum of all discounts applied to this invoice, including item-level and overall discounts.
duedateDateFalseNoThe date by which the invoice must be paid according to the terms established between the vendor and the company.
emailStringFalseNoThe email address associated with the recipient of this invoice, used for electronic delivery.
enddateDateFalseNoThe final date relevant to this invoice, such as the end of a service period or subscription term.
entityStringFalseNoThe customer, supplier, or entity to whom this invoice is issued, which serves as a foreign key linking to the corresponding record.
entitynexusStringFalseNoThe tax nexus associated with the customer entity, influencing tax calculation rules.
entitytaxregnumStringFalseNoThe tax registration number of the customer, required for compliance in certain tax jurisdictions.
estgrossprofitDecimalFalseNoThe estimated gross profit for this invoice, calculated as revenue minus direct costs.
estgrossprofitpercentStringFalseNoThe estimated gross profit percentage, reflecting profitability as a ratio of revenue.
exchangerateDecimalFalseNoThe exchange rate applied to convert invoice amounts to the base currency for accounting purposes.
excludecommissionBooleanFalseNoIndicates whether sales commissions should be excluded from this invoice, affecting salesperson compensation.
expcostdiscamountDecimalFalseNoThe total discount amount applied to expenses included in this invoice.
expcostdiscountStringFalseNoThe discount applied to expense-related charges on the invoice, reducing the total payable amount.
expcostdiscprintBooleanFalseNoSpecifies whether the expense discount should be displayed on the printed invoice.
expcostdiscrateStringFalseNoThe percentage discount applied to expenses on this invoice, influencing cost reductions.
expcostdisctaxableBooleanFalseNoIndicates whether the expense discount amount is subject to tax calculations.
expcosttaxcodeStringFalseNoThe tax code applied to expense-related charges in this invoice tracks the specific tax treatment during processing.
expcosttaxrate1StringFalseNoThe primary tax rate applied to expense-related charges on this invoice, typically associated with purchases or reimbursements.
externalidStringFalseNoA unique external identifier for this invoice, often used for integrations with external systems.
fobStringFalseNoThe Free on Board (FOB) term associated with this invoice, indicating the point of transfer for shipping liability.
forinvoicegroupingBooleanFalseNoIndicates whether this invoice is eligible for grouping with other invoices for consolidated billing.
giftcertappliedDecimalFalseNoThe total monetary value of gift certificates applied to this invoice, reducing the outstanding balance.
groupedtoStringFalseNoIndicates whether this invoice is grouped with another transaction for processing or reporting purposes, typically used for consolidating invoices.
handlingcostDecimalFalseNoThe cost associated with handling the order include packaging, administrative fees, and shipping.
handlingtax1rateStringFalseNoThe tax rate applied to the handling charges for the invoice, representing the percentage rate used to calculate handling tax.
handlingtaxcodeStringFalseNoThe tax code associated with handling charges on the invoice determines the applicable tax rules for handling fees.
isbasecurrencyBooleanFalseNoIndicates whether the invoice is in the company's base currency. A value of 'true' means it is, while 'false' means it is in a foreign currency.
ismultishiptoBooleanFalseNoSpecifies whether the invoice includes multiple shipping destinations. If 'true', the invoice supports multiple shipping addresses.
istaxableBooleanFalseNoSpecifies whether this invoice is subject to taxation based on applicable tax laws.
itemcostdiscamountDecimalFalseNoThe total discount amount applied to the cost of the item, representing the monetary reduction in item cost due to applied discounts
itemcostdiscountStringFalseNoThe type or name of the discount applied to the item cost, indicating the discount category, such as promotional discounts.
itemcostdiscprintBooleanFalseNoSpecifies whether the item cost discount should be visible on the printed invoice.
itemcostdiscrateStringFalseNoThe discount rate applied to the cost of an item in a vendor invoice, typically expressed as a percentage.
itemcostdisctaxableBooleanFalseNoIndicates whether the item cost discount amount is taxable.
itemcosttaxcodeStringFalseNoThe tax code applied to item-related charges, typically used to determine the tax treatment of the item cost.
itemcosttaxrate1StringFalseNoThe primary cost-based tax rate applied to an item in a vendor bill or invoice associated with cost-based taxation calculations.
lastmodifieddateDatetimeFalseNoThe date and time of the last modification to this invoice maintained by NetSuite, capturing all changes made.
leadsourceStringFalseNoThe marketing or sales campaign that led to this transaction, useful for attribution tracking.
linkedtrackingnumbersStringFalseNoA list of tracking numbers associated with shipments related to this invoice, providing logistics details.
locationStringFalseNoThe physical or virtual location associated with this invoice, often used for reporting and taxation purposes.
memoStringFalseNoA custom note or memo associated with the invoice, often used for internal reference or additional details.
messageStringFalseNoThe message displayed on the invoice, typically containing customer-facing information or special instructions.
messageselStringFalseNoAn internal identifier or selection key for predefined messages associated with invoices.
muccpromocodeinstanceStringFalseNoA unique identifier linking the invoice to a specific multi-use coupon code instance, used for tracking applied discounts.
nextapproverStringFalseNoThe designated user or role responsible for approving the invoice, if approval workflows are enabled.
nexusStringFalseNoThe tax jurisdiction or location associated with the invoice, determining applicable tax rates and regulations.
opportunityStringFalseNoA reference to the associated sales opportunity, linking the invoice to a potential deal or pipeline stage.
otherrefnumStringFalseNoAn alternate reference number provided by the customer, often used for purchase orders or external tracking.
overrideinstallmentsBooleanFalseNoIndicates whether the default installment payment schedule for this invoice has been manually overridden.
partnerStringFalseNoThe business partner, reseller, or affiliate associated with this transaction.
paylinkStringFalseNoA payment link generated for the invoice, allowing customers to make online payments directly.
postingperiodStringFalseNoThe financial period during which this invoice is posted, used for accounting and reporting purposes.
promocodeStringFalseNoThe promotional code applied to this invoice, determining discounts or special pricing adjustments.
promocodepluginimplStringFalseNoThe system implementation or plugin managing the application of the promotional code logic.
recognizedrevenueDecimalFalseNoThe portion of the invoice amount that has been recognized as revenue according to accounting standards.
recurringbillBooleanFalseNoIndicates whether this invoice is part of a recurring billing schedule, generating periodic charges.
returntrackingnumbersStringFalseNoTracking numbers associated with returned items linked to this invoice, aiding in logistics and processing.
revenuestatusStringFalseNoThe current revenue recognition status of the invoice, indicating whether revenue has been deferred, recognized, or pending.
revreconrevcommitmentBooleanFalseNoIndicates whether revenue reconciliation and commitment processes apply to this invoice for financial tracking.
saleseffectivedateDateFalseNoThe official date when the sales transaction became effective for revenue recognition purposes.
salesgroupStringFalseNoThe sales team or group responsible for the transaction, used for performance tracking and commissions.
salesrepStringFalseNoThe individual sales representative assigned to this invoice, linked to sales performance and incentives.
shipaddressStringFalseNoThe shipping address where goods or services associated with this invoice will be delivered.
shipaddresslistStringFalseNoA list of available shipping addresses associated with the customer for selection in this transaction.
shipdateDateFalseNoThe scheduled date when the order associated with this invoice is set to be shipped.
shipisresidentialStringFalseNoIndicates whether the shipping address is classified as a residential location, which can affect shipping costs.
shipmethodStringFalseNoThe shipping method selected for this invoice, such as standard, expedited, or freight.
shipoverrideStringFalseNoIndicates whether the default shipping method and details have been manually overridden.
shippingaddressStringFalseNoThe detailed address to which goods will be shipped, including street, city, and postal code.
shippingcostDecimalFalseNoThe total cost of shipping for this invoice, calculated based on carrier rates and selected shipping options.
shippingcostoverriddenStringFalseNoIndicates whether the calculated shipping cost has been manually modified.
shippingtax1rateStringFalseNoThe tax rate applied to the first level of shipping charges, if applicable.
shippingtaxcodeStringFalseNoThe tax code associated with shipping charges, used for compliance with tax regulations.
sourceStringFalseNoThe origin of this invoice, such as a sales order, web transaction, or manual entry.
startdateDateFalseNoThe start date relevant to this invoice, often used for subscription services or contract-based billing.
statusStringFalseNoThe current status of the invoice, such as pending, approved, paid, or voided.
statusRefStringFalseNoAn internal reference code representing the status of the invoice in system workflows.
subsidiaryStringFalseNoThe business entity or subsidiary under which this invoice is recorded, relevant for multi-entity organizations.
subsidiarytaxregnumStringFalseNoThe tax registration number of the subsidiary handling this invoice, ensuring compliance with tax authorities.
subtotalDecimalFalseNoThe total amount of the invoice before taxes and additional charges are applied.
syncpartnerteamsBooleanFalseNoIndicates whether partner sales teams are synchronized with this invoice for reporting and commission calculations.
syncsalesteamsBooleanFalseNoIndicates whether the sales teams associated with this invoice are synchronized for tracking and analysis.
taxdetailsoverrideBooleanFalseNoSpecifies whether default tax calculations for this invoice have been manually overridden.
taxitemStringFalseNoThe specific tax item applied to this invoice, defining how tax is calculated and reported.
taxpointdateDateFalseNoThe date on which the tax liability for this invoice is recognized, crucial for VAT and sales tax reporting.
taxpointdateoverrideBooleanFalseNoIndicates whether the default tax point date has been manually adjusted.
taxrateDoubleFalseNoThe tax rate applied to the invoice, determining the total tax amount calculated.
taxregoverrideBooleanFalseNoSpecifies whether the default tax registration settings have been manually overridden for this invoice.
taxtotalDecimalFalseNoThe total tax amount calculated for this invoice, based on applicable tax rates and taxable amounts.
termsStringFalseNoThe payment terms specified for this invoice, such as net 30, due on receipt, or installment-based.
timediscamountDecimalFalseNoThe discount amount applied based on early payment terms or time-sensitive promotions.
timediscountStringFalseNoA reference to the time-based discount policy applicable to this invoice.
timediscprintBooleanFalseNoIndicates whether the time-based discount should be displayed on the printed invoice.
timediscrateStringFalseNoThe rate at which a time-based discount is applied, typically expressed as a percentage.
timedisctaxableBooleanFalseNoIndicates whether the time-based discount amount is subject to taxation.
timetaxcodeStringFalseNoThe tax code associated with the time-based discount, ensuring proper tax calculation and compliance.
timetaxrate1StringFalseNoThe first level tax rate applied to the time-based discount amount, if applicable.
tobeemailedBooleanFalseNoIndicates whether this invoice is scheduled to be sent to the customer via email.
tobefaxedBooleanFalseNoIndicates whether this invoice should be sent to the customer via fax.
tobeprintedBooleanFalseNoIndicates whether a physical copy of this invoice is required for printing.
totalDecimalFalseNoThe final total amount of the invoice, including taxes, discounts, and additional charges.
totalcostestimateDecimalFalseNoAn estimated total cost associated with fulfilling this invoice, useful for profitability analysis.
trackingnumbersStringFalseNoA list of tracking numbers associated with shipments linked to this invoice, aiding in delivery monitoring.
trandateDateFalseNoThe transaction date of this invoice, representing when the invoice was officially created.
tranidStringFalseNoThe unique transaction ID assigned to this invoice for system tracking and reference.
tranisvsoebundleBooleanFalseNoIndicates whether this invoice is part of a Vendor-Specific Objective Evidence (VSOE) bundle for revenue recognition.
unbilledordersDecimalFalseNoThe total value of associated sales orders that have not yet been billed in this invoice.
vsoeautocalcBooleanFalseNoIndicates whether VSOE calculations are automatically applied to this invoice.

Return to Top

invoiceBillingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique internal identifier for the billing address record, used for reference within the NetSuite system.
addr1StringFalseNoThe primary street address for the billing location, typically including house or building number and street name.
addr2StringFalseNoAdditional address information, such as apartment, suite, or unit number, if applicable.
addr3StringFalseNoFurther address details, which can include complex or subdivision name, building section, or other location identifiers.
addresseeStringFalseNoThe name of the recipient or entity associated with the billing address, used for invoicing purposes.
attentionStringFalseNoThe specific person or department at the billing address to whom the invoice should be directed.
cityStringFalseNoThe name of the city or locality where the billing address is located.
countryStringFalseNoThe country corresponding to the billing address, typically represented as a full name or standardized code.
dropdownstateStringFalseNoA selectable field representing the state or region of the billing address, often used for user interface dropdowns.
overrideBooleanFalseNoIndicates whether the default billing address should be manually overridden with custom values.
stateStringFalseNoThe state or province of the billing address, used for tax calculations and regional compliance.

Return to Top

invoiceGiftCertRedemption 

NameTypeReadOnlyReferencesFilterOnlyDescription
authcodeStringFalseNoThe unique code associated with a gift certificate, used for redemption against an invoice.
authcodeappliedDecimalFalseNoThe monetary amount from the gift certificate that has been applied to the invoice balance.

Return to Top

invoicegroup 

NameTypeReadOnlyReferencesFilterOnlyDescription
amountdueDecimalFalseNoThe total outstanding balance for the invoice, representing the amount that is still unpaid by the customer.
amountpaidDecimalFalseNoThe total amount that has been paid toward the invoice by the customer, reflecting partial or full payments made.
billaddressStringFalseNoThe full billing address associated with the invoice group, including street, city, state, and postal code.
billaddresslistStringFalseNoA reference identifier for the billing address record stored in the system.
currencyStringFalseNoThe currency in which the invoice group transactions are recorded, represented by the currency code.
customerStringFalseNoThe unique identifier for the customer associated with this invoice group. This value links to the customer record in the system.
customernameStringFalseNoThe full name of the customer, as recorded in the system. This is a human-readable version of the customer identifier.
datedrivenStringFalseNoIndicates whether the invoice due date is determined based on a specific date-driven rule or a predefined term.
dayofmonthnetdueIntegerFalseNoThe specific day of the month on which the invoice is due when using a date-driven payment term.
daysuntilnetdueIntegerFalseNoThe number of days from the invoice date until the payment is due.
discounttotalDecimalFalseNoThe total discount applied to the invoice group, including any early payment or promotional discounts.
duedateDateFalseNoThe final date by which payment for the invoice group is expected to be made.
duenextmonthifwithindaysIntegerFalseNoIf the invoice is due within this many days from the end of the month, the due date is extended to the following month.
externalidStringFalseNoAn optional user-defined identifier for the invoice group, typically used for integration with external systems.
groupedbypoBooleanFalseNoIndicates whether invoices within this group are consolidated based on purchase order numbers.
handlingcostDecimalFalseNoThe total cost associated with handling fees for the invoice group, such as packaging or processing charges.
idIntegerFalseNoThe internal system-generated identifier for the invoice group record that distinguishes each invoice group entry.
invoicegroupnumberStringFalseNoThe unique identifier assigned to the invoice group for tracking and reference.
itemtotalDecimalFalseNoThe total cost of all items included in the invoice group before taxes, discounts, and additional charges.
lastmodifiedbyStringFalseNoThe user who last modified the invoice group record in the system essential for tracking changes.
lastmodifieddateDatetimeFalseNoThe timestamp of the most recent update or modification made to a particular invoice group record.
memoStringFalseNoAn optional note or remark associated with the invoice group, typically used for internal reference.
ponumberStringFalseNoThe purchase order number associated with this invoice group, which links the invoice to the original purchase order issued by the buyer.
shippingcostDecimalFalseNoThe total cost of shipping for this invoice group, including any applicable handling fees or surcharges.
statusStringFalseNoThe current status of the invoice group, indicating whether it is pending, approved, paid, or in another relevant state.
subsidiaryStringFalseNoThe subsidiary or business entity associated with this invoice group, which helps identify the organizational unit responsible for the transaction.
taxtotalDecimalFalseNoThe total amount of tax applied to this invoice group, including all applicable sales tax, Value Added Tax (VAT), or other regulatory tax components.
termsStringFalseNoThe payment terms agreed upon for this invoice group, specifying conditions such as net payment periods, early payment discounts, or due dates.
totalDecimalFalseNoThe total amount due for this invoice group, including all item costs, taxes, and shipping fees.
trandateDateFalseNoThe transaction date for this invoice group, indicating when the invoice was created or processed in the system.

Return to Top

InvoiceItemShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoUnique identifier for the shipping address record within the invoice item. Typically used for internal reference and system operations.
addr1StringFalseNoPrimary street address or building number for the shipping destination. This is the first line of the address and is required for accurate delivery.
addr2StringFalseNoSecondary address line, often used for apartment numbers, suite numbers, or additional address details.
addr3StringFalseNoTertiary address line for any additional location details, such as building names or in-depth delivery instructions.
addresseeStringFalseNoThe recipient's name associated with this shipping address. This could be an individual or a business entity.
attentionStringFalseNoSpecific person or department within the organization to whom the package should be directed.
cityStringFalseNoThe city or locality where the shipment is being sent. Required for determining the delivery region.
countryStringFalseNoThe country in which the shipping address is located. Used for international shipping and regulatory compliance.
dropdownstateStringFalseNoThe state or province of the shipping address, selected from a predefined list in a dropdown menu for standardization.
overrideBooleanFalseNoIndicates whether the default shipping address should be overridden. A value of 'true' means this address takes precedence over default settings.
stateStringFalseNoThe state or province associated with the shipping address, used for tax calculations, routing, and regulatory purposes.

Return to Top

invoiceLinkedTrackingNumberMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
trackingnumberStringFalseNoA unique tracking number assigned to a shipment to monitor its delivery status, typically provided by the shipping carrier.

Return to Top

invoicePartner 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage of the total invoice attributed to this partner's contribution reflects revenue sharing. It also includes the cost allocation among partners.
isprimaryBooleanFalseNoIndicates whether this partner is the primary contributor for the invoice, which typically has the highest responsibility or revenue allocation level.
partnerStringFalseNoThe unique identifier or name of the partner associated with this invoice. Partners can be external entities, resellers, or internal stakeholders.
partnerroleStringFalseNoThe partner's specific role on the invoice, such as reseller, affiliate, distributor, or another designated partnership type.

Return to Top

invoiceSalesTeam 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage of the total revenue from an invoice that is attributed to this sales team member. This value helps track individual contributions to a sale.
employeeStringFalseNoThe name or unique identifier of the employee assigned to the sales team, used to track which employees are involved in each transaction.
isprimaryBooleanFalseNoIndicates whether this sales team member is the primary representative for the invoice. A value of 'true' means the employee is the main point of contact.
salesroleStringFalseNoThe specific role assigned to the sales team member within the invoice transaction, such as Account Manager, Sales Representative, or Business Development Executive.

Return to Top

invoiceShipGroup 

NameTypeReadOnlyReferencesFilterOnlyDescription
destinationaddressStringFalseNoThe shipping destination address for this invoice shipment group, specifying where the items will be delivered.
docStringFalseNoAn internal reference or identifier related to the invoice shipment group. This field does not have a user-facing label.
handlingrateDecimalFalseNoThe calculated cost associated with handling the shipment, including packaging and processing fees.
shippingmethodStringFalseNoThe selected shipping method or carrier service used for delivering the items, such as FedEx, UPS, or USPS.
shippingrateDecimalFalseNoThe total cost of shipping for this invoice shipment group, based on the selected shipping method and package details.
sourceaddressStringFalseNoThe origin address from which the shipment is being sent, typically the warehouse or fulfillment center.
uniquekeyIntegerFalseNoA system-generated unique identifier for this invoice shipment group, ensuring data integrity and record tracking.

Return to Top

invoiceShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique internal system-generated identifier for the shipping address record used for reference purposes.
addr1StringFalseNoPrimary street address where the shipment should be delivered, typically includes the house or building number and street name.
addr2StringFalseNoAdditional address information such as apartment, suite, unit number, or other secondary location details.
addr3StringFalseNoThe third line of the shipping address, typically used for additional location details such as suite numbers, apartment numbers, or internal mail stops.
addresseeStringFalseNoThe recipient or company name associated with the shipping address, used for labeling and identification purposes.
attentionStringFalseNoA designated contact person or department for the shipment, ensuring that the package reaches the correct individual within an organization.
cityStringFalseNoThe city or town associated with the shipping address, essential for accurate delivery and geographic identification.
countryStringFalseNoCountry associated with the shipping address, typically represented using its full name or standard country code.
dropdownstateStringFalseNoState or province selection used in dropdown menus, often stored in a standardized format for consistency.
overrideBooleanFalseNoIndicates whether the shipping address is manually overridden, bypassing system defaults or automated selections.
stateStringFalseNoThe state or province associated with the shipping address for the invoice, ensuring accurate delivery and tax calculations.

Return to Top

invoiceTrackingNumberMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
trackingnumberStringFalseNoThe unique identifier assigned to a shipment for tracking purposes, used by carriers to monitor the status and location of a package in transit.

Return to Top

invoiceTranPromotion 

NameTypeReadOnlyReferencesFilterOnlyDescription
couponcodeStringFalseNoThe unique code associated with a specific coupon applied to the transaction. This is used to provide discounts or other promotional benefits.
promocodeStringFalseNoThe promotional code used in the transaction to apply discounts, special offers, or rewards, which can be manually entered by the customer or automatically applied based on eligibility.
promotiontypeStringFalseNoThe classification of the promotion applied to the transaction, indicating whether it is a discount, rebate, special offer, or other type of promotional incentive.

Return to Top

InvtCommit 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoAn automatically assigned unique internal identifier for the inventory commitment record. This is used to reference the specific commitment in transactions, reports, and scripts.

Return to Top

InvtItemPriceHistory 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoA unique internal identifier assigned to each price history record for inventory items, used for tracking and referencing specific records.
currencyStringFalseNoThe currency in which the item's price is recorded, helping in multi-currency environments to differentiate pricing for different regions or transactions.
discountDoubleFalseNoThe percentage or fixed amount of discount applied to the item, representing markdowns or negotiated reductions in pricing.
itemStringFalseNoThe identifier or name of the inventory item associated with this pricing history record. This links the price change to a specific product or stock-keeping unit (SKU).
priceDecimalFalseNoThe actual price of the inventory item at the time of the recorded entry. This reflects the selling price or cost based on historical data.
pricetypeStringFalseNoThe price level associated with the recorded price can vary based on the pricing structure set in NetSuite, with examples including 'Base Price,' 'Wholesale Price,' and 'Retail Price.'
quantityDoubleFalseNoThe minimum purchase quantity required for this price to be applicable, commonly used for volume-based pricing tiers.

Return to Top

IPRestrictions 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoA unique identifier automatically generated by the system for each record in the IP Restrictions table, used to reference specific restriction entries.
roleStringFalseNoThe user role associated with the IP restriction, determining the level of access permitted based on predefined security policies.
rulesStringFalseNoA list of IP restriction rules for the specified role that define allowed or blocked IP addresses, limiting NetSuite access to designated networks.

Return to Top

issue 

NameTypeReadOnlyReferencesFilterOnlyDescription
assignedStringFalseNoThe user or team assigned to resolve the issue. This indicates responsibility for addressing and closing the issue.
autonameBooleanFalseNoIndicates whether the issue is automatically named based on predefined rules or requires manual naming.
buildbrokenStringFalseNoThe build version in which the issue was first identified as a problem or defect, tracking when a regression or bug was introduced.
buildfixedStringFalseNoThe build version in which the issue was resolved. Provides insight into when a bug was fixed and in which release it was addressed.
buildtargetStringFalseNoThe intended build version in which the issue is expected to be fixed, which helps in planning and tracking issue resolution.
createddateDatetimeFalseNoThe timestamp indicating when the issue was first logged, which is useful for tracking the age and time to resolution of issues.
customformStringFalseNoThe specific form used for capturing the issue details, categorizing issues based on different reporting templates.
datereleasedStringFalseNoThe date when the issue fix was officially released as part of a build or version.
emailassigneeBooleanFalseNoIndicates whether an email notification should be sent to the assigned user when the issue is updated, keeping stakeholders informed.
emailcellsStringFalseNoA list of specific email addresses or distribution lists notified about changes to the issue, ensuring relevant parties stay updated.
emailemployeesStringFalseNoComma-separated list of employee email addresses notified about issue updates, ensuring key personnel are informed.
externalabstractStringFalseNoA high-level summary of the issue meant for external stakeholders or customers, providing a non-technical description of the problem.
externaldetailsStringFalseNoA detailed explanation of the issue for external stakeholders, including impact and any relevant background information.
externalidStringFalseNoA unique identifier for the issue in external systems, facilitating integration with third-party tracking tools or customer support portals.
isreviewedBooleanFalseNoIndicates whether the issue has been reviewed for accuracy, completeness, and validity, which helps in issue triage and prioritization.
isshowstopperBooleanFalseNoThe issue is identified as a critical blocker that must be resolved before release or deployment to ensure further progress.
issueabstractStringFalseNoA brief summary of the issue, including key details such as symptoms, affected areas, and impact, which is useful for quick reference.
issuenumberStringFalseNoA unique identifier assigned to the issue within the system is used for tracking and referencing specific issues.
issuestatusStringFalseNoThe current status of the issue which indicates the stage of resolution, such as Open, In Progress, Resolved, or Closed.
issuetagsStringFalseNoA comma-separated list of keywords or labels assigned to the issue for categorization and easy searchability.
issuetypeStringFalseNoThe classification of the issue, such as Bug, Enhancement, Feature Request, or Task, which helps in managing different types of issues.
itemStringFalseNoThe specific product, module, or component affected by the issue, which helps in pinpointing the source of the problem.
lastmodifieddateDatetimeFalseNoThe timestamp of the last update to the issue record, which is useful for tracking recent changes and updates.
moduleStringFalseNoThe software module or functional area where the issue occurs, categorizing and assigning issues to the right team.
newdetailsStringFalseNoAdditional details about the issue that have been recently updated or discovered, providing more context for resolution.
priorityStringFalseNoThe urgency level of the issue, typically ranging from Low to Critical, prioritizing resolution efforts.
productStringFalseNoThe specific product or service related to the issue, filtering issues by product category.
productteamStringFalseNoThe team responsible for the affected product or feature, directing issues to the right group for resolution.
reportedbyStringFalseNoThe user or entity that initially reported the issue, providing accountability and contact information for follow-ups.
reproduceStringFalseNoSteps to reproduce the issue, including environment details and any necessary configurations essential for debugging and resolution.
reviewerStringFalseNoThe individual or team responsible for reviewing the issue before it is marked as resolved or closed, ensuring quality control.
severityStringFalseNoThe impact level of the issue, often categorized as Minor, Major, or Critical, assessing risk and prioritization.
sourceStringFalseNoThe origin of the issue report, such as Customer Feedback, Internal Testing, or Automated Monitoring, helps in tracking issue sources.
versionbrokenStringFalseNoThe software version where the issue was first identified as a problem, which is useful for regression analysis.
versionfixedStringFalseNoThe software version where the issue was resolved helps to track when fixes are deployed.
versiontargetStringFalseNoThe software version targeted for fixing the issue. Helps align issue resolution with release planning.

Return to Top

issueproduct 

NameTypeReadOnlyReferencesFilterOnlyDescription
externalidStringFalseNoA unique identifier assigned in integrations or third-party systems, typically provided by an external application and does not change once set.
idIntegerFalseNoThe primary key for this record, serving as a unique identifier, which is automatically generated and used to distinguish each entry in the table.
internalidIntegerFalseNoAn internal identifier assigned by NetSuite to track this record and is commonly used in scripts, workflows, and API calls.
isinactiveBooleanFalseNoIndicates whether this record is inactive. A value of 'true' means the record is not currently in use.
issueproductStringFalseNoThe name or identifier of the product associated with the issue, used to track relevant product details.
issueproductdescriptionStringFalseNoA detailed description of the product associated with the issue, including specifications, features, or other relevant information.
showinactiveversionsBooleanFalseNoSpecifies whether inactive versions of the product should be displayed in queries and reports. A value of 'true' includes inactive versions.

Return to Top

issueproductversion 

NameTypeReadOnlyReferencesFilterOnlyDescription
allowbrokeninBooleanFalseNoIndicates whether the product version allows broken functionality to be introduced, typically used for testing and debugging purposes.
allowfixedinBooleanFalseNoSpecifies whether the product version permits fixes to be applied, ensuring that bug fixes can be incorporated into the release.
allowtargetBooleanFalseNoDefines whether this product version is a valid target for issue resolution. If 'true', issues can be marked as resolved in this version.
expectedreleasedateDateFalseNoThe projected release date of this product version, which is subject to change based on development progress and testing outcomes.
externalidStringFalseNoA unique identifier for the product version used by external systems, ensuring consistency between NetSuite and other integrated platforms.
externalreleasetargetStringFalseNoSpecifies the intended release target for this product version in external systems, which helps in aligning release schedules.
idIntegerFalseNoA unique identifier for the product version related to the issue. It serves as the primary key used to track specific versions associated with that issue.
internalidIntegerFalseNoAn internal identifier used within NetSuite to distinguish this product version from others, typically used for internal references and system operations.
isefixBooleanFalseNoIndicates whether this version contains emergency fixes. If enabled, this version is categorized as a hotfix or emergency patch release.
isinactiveBooleanFalseNoDetermines whether this product version is currently inactive. If set to 'true', the version is not available for use in issue tracking or resolution.
issueproductStringFalseNoRepresents the product associated with this version, categorizing issues and tracking versions for different products within NetSuite.
issueversiondescriptionStringFalseNoA detailed description of the product version, including notable changes, improvements, and fixed issues, used for documentation and reference purposes.
portletdescriptionStringFalseNoA brief summary of the product version displayed in NetSuite portlets, providing an at-a-glance view of key details for users.
productversionStringFalseNoThe specific version number or identifier assigned to this product version, which follows the standard versioning format used by the organization.
showinportletBooleanFalseNoIndicates whether this product version should be visible in NetSuite portlets. If 'true', users can see relevant version details in their dashboards.

Return to Top

IssueVersionRelation 

NameTypeReadOnlyReferencesFilterOnlyDescription
nameStringFalseNoThe name associated with the issue version relation, typically representing the version identifier or label used to track iterations of an issue within the system.

Return to Top

item 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier assigned to each item within NetSuite. This identifier is used for tracking and referencing the item across the system.
accbookrevrecforecastruleStringFalseNoDefines the revenue recognition forecast rule associated with a specific accounting book, determining how revenue is calculated and reported.
accountStringFalseNoSpecifies the general ledger account to which the item is linked, defining financial transactions related to the item.
accountingbookStringFalseNoIndicates the specific accounting book in which financial transactions related to the item are recorded, allowing multi-book accounting.
amortizationperiodIntegerFalseNoDefines the duration, in accounting periods, over which an asset’s cost is amortized for financial reporting purposes.
amortizationtemplateIntegerFalseNoReferences a predefined amortization template that dictates the schedule and method for expense or revenue amortization.
assetaccountIntegerFalseNoIdentifies the asset account in the general ledger that tracks the value of the item when classified as an asset.
accountingbookamortizationStringFalseNoIndicates the amortization schedule associated with a specific accounting book, used for expense recognition over time.
accountingbookcreateplansonStringFalseNoSpecifies the criteria or event that triggers the creation of revenue plans within a particular accounting book.
accountingbookrevrecruleStringFalseNoDetermines the revenue recognition rule applied within an accounting book, guiding how revenue is realized over time.
accountingbookrevrecscheduleStringFalseNoDefines the revenue recognition schedule for an item, outlining when and how revenue is recognized in a given accounting book.
alternatedemandsourceitemStringFalseNoSpecifies an alternative item that can be used to meet demand when the primary item is unavailable. Helps manage stock shortages efficiently.
atpleadtimeDoubleFalseNoRepresents the Available to Promise (ATP) lead time, which is the estimated time required for an item to be available for sale or fulfillment.
atpmethodStringFalseNoSpecifies the default ATP calculation method used to determine item availability based on supply and demand.
autoleadtimeBooleanFalseNoIndicates whether the system automatically calculates lead time for the item based on historical data and supplier performance.
autopreferredstocklevelBooleanFalseNoDetermines whether the preferred stock level should be automatically calculated based on demand trends and replenishment schedules.
autoreorderpointBooleanFalseNoSpecifies whether the reorder point is automatically determined based on sales history, demand forecasting, and replenishment cycles.
availabletopartnersBooleanFalseNoIndicates whether the item is visible and available to business partners, such as resellers or distributors, within the NetSuite system.
averagecostDecimalFalseNoRepresents the average cost of the item, calculated based on historical purchase prices and inventory valuation methods.
backwardconsumptiondaysIntegerFalseNoDefines the number of days in the past that the system looks at to consume demand for planning and forecasting purposes.
binnumberStringFalseNoIdentifies the specific bin or storage location where the item is stored within a warehouse or inventory facility.
binonhandavailDoubleFalseNoIndicates the total quantity of the item available in bins that can be used for order fulfillment.
binonhandcountDoubleFalseNoRepresents the total physical quantity of the item currently stored in bins, including allocated and reserved stock.
bomquantityDoubleFalseNoSpecifies the quantity of the item required in a Bill of Materials (BOM) for manufacturing or assembly processes.
buildentireassemblyBooleanFalseNoIndicates whether all sub-assemblies of the item should be built together when creating a work order.
buildtimeDoubleFalseNoDefines the variable lead time required to manufacture or assemble an item when fulfilling a work order.
buildtimelotsizeDoubleFalseNoSpecifies the lot size used to determine lead time calculations for work orders, affecting production efficiency.
buyitnowpriceDecimalFalseNoIndicates the price at which an item can be purchased immediately on eBay without bidding.
billexchratevarianceacctIntegerFalseNoReferences the exchange rate variance account used to track currency fluctuations related to item purchases and supplier payments.
billingscheduleIntegerFalseNoIdentifies the billing schedule associated with the item, determining how and when customers are invoiced.
billpricevarianceacctIntegerFalseNoSpecifies the general ledger account used to track price variances between expected and actual supplier invoice amounts.
billqtyvarianceacctIntegerFalseNoReferences the account used to track variances in quantities received versus quantities billed by suppliers.
captionStringFalseNoStores the display name for the item as shown on an e-commerce website or storefront.
categoryStringFalseNoCategorizes the item within NetSuite for classification, reporting, and filtering purposes.
classStringFalseNoAssigns a classification to the item for financial segmentation and reporting, often used for departmental tracking.
commercecatalogidStringFalseNoReferences the identifier for the e-commerce catalog in which the item is listed.
commercecategoryenddateDatetimeFalseNoSpecifies the date and time when an item’s association with a commerce category expires, affecting online visibility.
commercecategoryidStringFalseNoIdentifies the category under which the item is classified in an e-commerce system.
commercecategoryisinactiveBooleanFalseNoIndicates whether the e-commerce category assigned to the item is inactive and no longer in use.
commercecategoryisprimaryBooleanFalseNoSpecifies whether the assigned commerce category is the primary classification for the item.
commercecategorynameStringFalseNoDisplays the name of the commerce category associated with the item.
commercecategorystartdateDatetimeFalseNoSpecifies the date and time when an item becomes associated with a commerce category, affecting online visibility.
componentStringFalseNoIdentifies an item that is used as a component in the assembly or manufacturing of another item.
componentofStringFalseNoIndicates the parent item that includes this item as a component in its BOM.
componentyieldDoubleFalseNoRepresents the expected yield percentage of a component item used in a manufacturing process, accounting for losses.
consumptionunitStringFalseNoDefines the unit of measure in which the item is consumed during manufacturing or production processes.
contingentrevenuehandlingBooleanFalseNoIndicates whether an item is eligible for contingent revenue handling, affecting revenue recognition timing and rules.
conversionrateDoubleFalseNoSpecifies the rate at which one unit of the item converts into another unit, often used for inventory or sales tracking.
copydescriptionBooleanFalseNoIndicates whether the item description should be automatically copied to sales orders when the item is selected.
correlateditemStringFalseNoReferences an item that is commonly purchased alongside the current item, useful for upselling and recommendations.
correlateditemcorrelationDoubleFalseNoRepresents the correlation factor between this item and another frequently purchased item, based on sales data.
correlateditemcountIntegerFalseNoIndicates the number of times the correlated item has been purchased with this item in transaction history.
correlateditemliftDoubleFalseNoRepresents the increase in likelihood that a correlated item is purchased when this item is bought.
correlateditempurchaserateDoubleFalseNoIndicates the probability that a customer purchasing this item will also purchase the correlated item.
costDecimalFalseNoSpecifies the purchase price of the item from suppliers, used in cost accounting and profitability analysis.
costaccountingstatusStringFalseNoIndicates the current cost accounting status of the item, which affects inventory valuation and reporting.
costcategoryStringFalseNoAssigns a cost category to the item for grouping and financial analysis.
costestimateDoubleFalseNoRepresents an estimated cost for the item, defined by internal calculations or external price sources.
costestimatetypeStringFalseNoSpecifies the methodology used to estimate the cost of the item, such as standard cost or average cost.
costingmethodStringFalseNoIndicates the cost accounting method used for the item, such as FIFO, LIFO, or weighted average cost.
countryofmanufactureStringFalseNoThe country where the item was manufactured, used for compliance, reporting, and supply chain tracking.
createdDatetimeFalseNoThe date and time when the item record was initially created in the system.
createjobBooleanFalseNoIndicates whether a job record should be created when this item is used in a transaction or process.
createrevenueplansonStringFalseNoDefines the event or condition upon which revenue plans should be generated for this item.
currentstandardcostDecimalFalseNoThe most recent standard cost assigned to this item, used for accounting and cost analysis.
currentstdcosteffectivedateDateFalseNoThe effective date from which the current standard cost of the item is applicable.
createddateDateFalseNoThe date when the item record was first added to the system.
createexpenseplansonIntegerFalseNoSpecifies when expense plans should be created for this item based on predefined criteria.
custreturnvarianceaccountIntegerFalseNoThe general ledger account used to record variances in customer returns, ensuring accurate financial tracking.
dateviewedDatetimeFalseNoThe most recent date and time when this item record was accessed or viewed in the system.
daysbeforeexpirationDoubleFalseNoThe number of days remaining before the item reaches its expiration date, useful for inventory management.
deferralaccountIntegerFalseNoThe deferred expense account associated with this item for managing revenue recognition and expense deferrals.
defaultreturncostDecimalFalseNoThe default cost assigned when a returned item is processed, helping with accurate return valuations.
deferrevrecBooleanFalseNoIndicates whether revenue recognition for this item should be deferred based on specific accounting rules.
demandmodifierDoubleFalseNoA factor used to adjust the estimated demand for this item in demand planning calculations.
demandsourceStringFalseNoIdentifies the source of demand for this item, such as sales orders, work orders, or purchase requests.
departmentStringFalseNoThe department associated with this item, typically used for financial segmentation and reporting.
descriptionStringFalseNoA detailed textual description of the item, providing additional context for users and customers.
directrevenuepostingBooleanFalseNoIndicates whether revenue transactions for this item should be posted directly to the general ledger without deferrals.
displayinebaystoreBooleanFalseNoSpecifies whether this item should be displayed for sale in the associated eBay store.
displaynameStringFalseNoThe public-facing name of the item, used in sales channels, web stores, and reports.
distributioncategoryStringFalseNoThe category under which this item falls within the distribution network, used for logistics and classification.
distributionnetworkStringFalseNoDefines the network or channel through which this item is distributed to customers.
dontshowpriceBooleanFalseNoIndicates whether the item's price should be hidden from public or customer-facing displays.
demandtimefenceIntegerFalseNoThe number of days within which demand planning should not change orders for this item.
dropshipexpenseaccountIntegerFalseNoThe general ledger account used to track expenses associated with drop-ship orders for this item.
ebayitemdescriptionStringFalseNoA detailed product description specifically formatted for eBay listings.
ebayitemsubtitleStringFalseNoA secondary title used in eBay listings to provide additional context and marketing appeal.
ebayitemtitleStringFalseNoThe main title used for this item in eBay listings, designed for search optimization and visibility.
ebayrelistingoptionStringFalseNoSpecifies the automatic relisting options available for this item in eBay if it does not sell.
enforceminqtyinternallyBooleanFalseNoIndicates whether internal sales and stock tracking should enforce the minimum order quantity requirement.
effectivebomcontrolStringFalseNoDefines the BOM control strategy applied to this item for manufacturing processes.
effectivedateDateFalseNoThe date when the current configuration, cost, or pricing of this item becomes active.
effectiverevisionStringFalseNoThe active product revision or version of the item, useful in manufacturing and inventory management.
expenseamortizationruleIntegerFalseNoThe predefined rule that determines how expenses for this item should be amortized over time.
enablecatchweightBooleanFalseNoIndicates whether this item supports catch weight tracking, used in industries with variable unit weights.
endauctionswhenoutofstockBooleanFalseNoSpecifies whether eBay auctions for this item should automatically end when stock is depleted.
excludefromsitemapBooleanFalseNoIndicates whether this item should be excluded from website sitemaps to prevent it from appearing in search results.
externalidStringFalseNoA unique identifier for this item used for integration with external systems and third-party applications.
externalidstringStringFalseNoA text-based version of the external identifier, often used for display and reporting purposes.
featureddescriptionStringFalseNoA highlighted description used for marketing purposes, such as in promotions or featured listings.
feeddescriptionStringFalseNoThe description of this item as it appears in product feeds for marketplaces and advertising channels.
feednameStringFalseNoThe name assigned to this item in external product feeds, used for online selling and syndication.
fixedbuildtimeDoubleFalseNoThe fixed lead time required to build this item in a work order, measured in days.
fixedlotsizeDoubleFalseNoThe predefined lot size for manufacturing or ordering this item, ensuring efficiency in procurement and production.
formuladateDateFalseNoA calculated date based on a predefined formula, often used for reporting or automation.
formulanumericDoubleFalseNoA numeric value derived from a formula, commonly used for analytics and custom calculations.
formulatextStringFalseNoA text value generated by a formula, often utilized for labeling or classification purposes.
forwardconsumptiondaysIntegerFalseNoThe number of future days considered when consuming forecasted demand for this item.
fraudriskStringFalseNoThe assessed fraud risk level associated with this item, used in fraud detection and mitigation strategies.
froogleproductfeedBooleanFalseNoIndicates whether this item should be included in the Google Base product feed now known as Google Merchant Center.
futurehorizonIntegerFalseNoThe time horizon, measured in days, used for future demand and supply planning for this item.
fxcostDecimalFalseNoThe purchase price of this item in foreign currency, used for international procurement and cost tracking.
generateaccrualsBooleanFalseNoSpecifies whether accrual transactions should be automatically generated for this item.
giftcertauthcodeStringFalseNoThe unique authorization code assigned to a gift certificate item, required for redemption.
giftcertemailStringFalseNoThe email address of the recipient for electronic gift certificates, used for delivery and communication.
fullnameStringFalseNoThe full name of the item, including any additional identifiers used for internal or customer reference.
gainlossaccountIntegerFalseNoThe general ledger account used to record gains or losses associated with currency fluctuations or cost changes.
giftcertexpdateDateFalseNoThe expiration date of a gift certificate associated with this item, determining its validity period.
giftcertfromStringFalseNoThe name of the individual or entity that purchased the gift certificate, typically used for tracking the buyer's information.
giftcertmsgStringFalseNoA personalized message included with the gift certificate, which is displayed to the recipient when they receive their gift certificate.
giftcertorigamtStringFalseNoThe original monetary value assigned to the gift certificate at the time of purchase, which remains fixed and does not change with usage.
giftcertrecipientStringFalseNoThe name of the individual or entity to whom the gift certificate is issued, which helps identify the intended recipient of the gift certificate.
handlingcostDecimalFalseNoThe cost associated with handling an item, including packaging, processing, and administrative fees, which is separate from shipping costs.
imageurlStringFalseNoA URL that links to the image associated with the item is used for displaying product images in web stores or internal systems.
internalidStringFalseNoA unique identifier assigned to the item within the system is used internally for database referencing and record management.
includechildrenBooleanFalseNoIndicates whether child items associated with a parent item should be included in searches and reports, useful for managing families or kits.
internalidnumberIntegerFalseNoThe numerical representation of the internal ID, providing an alternative reference for sorting and identification.
incomeaccountIntegerFalseNoThe financial account where income generated from the sale of this item is recorded, which is crucial for accounting and financial reporting.
inventorylocationStringFalseNoThe physical or virtual location where the item is stored,which helps in inventory tracking and order fulfillment.
invtclassificationStringFalseNoThe classification assigned to the item based on inventory management policies, such as high-priority, slow-moving, or discontinued.
invtcountintervalIntegerFalseNoThe number of days between scheduled inventory counts for this item, ensuring accurate stock tracking and reduces discrepancies.
isavailableBooleanFalseNoIndicates whether the item is currently available for sale or fulfillment. This helps prevent overselling or inaccurate stock representation.
isdonationitemBooleanFalseNoIndicates whether the item is classified as a variable-amount donation item, typically used for charitable contributions.
isdropshipitemBooleanFalseNoSpecifies whether the item is designated as a drop-ship item, which ships directly from the supplier to the customer without being stocked in inventory.
isfulfillableBooleanFalseNoIndicates whether the item can be included in a sales order for fulfillment, which is important for items that can be informational or non-deliverable.
isgcocompliantBooleanFalseNoSpecifies whether the item meets compliance requirements, ensuring compatibility with payment processing system.
isinactiveBooleanFalseNoIndicates whether the item is currently inactive in the system, typically hidden from searches and transactions.
islotitemBooleanFalseNoIndicates whether the item requires lot tracking is useful for inventory control, particularly for perishable or regulated items.
isonlineBooleanFalseNoDetermines whether the item is displayed on the company's web store. If set to 'false', the item remains hidden from online listings.
ispreferredvendorBooleanFalseNoIndicates whether a specific vendor is the preferred supplier for this item, which helps streamline purchasing decisions.
isserialitemBooleanFalseNoSpecifies whether the item requires serial number tracking, which is essential for high-value or regulated goods.
isspecialorderitemBooleanFalseNoIndicates whether the item is a special order item, typically ordered upon customer request rather than kept in stock.
isspecialworkorderitemBooleanFalseNoDetermines whether the item is designated as a special work order item, requiring customized processing or manufacturing.
isstorepickupallowedBooleanFalseNoIndicates whether customers can pick up this item at a physical store location instead of having it shipped.
issueproductStringFalseNoDefines the associated product issued for specific transactions, often used in service-related or bundled item scenarios.
isphantomBooleanFalseNoIndicates whether the item is a phantom item, meaning it is used for assembly tracking but does not physically exist in stock.
istaxableBooleanFalseNoSpecifies whether the item is subject to sales tax crucial for compliance with tax regulations.
isvsoebundleBooleanFalseNoDetermines whether the item is classified as a Vendor-Specific Objective Evidence (VSOE) bundle for revenue recognition purposes.
iswipBooleanFalseNoIndicates whether the item is considered Work In Progress (WIP) inventory, commonly used in manufacturing environments.
itemidStringFalseNoThe internal name or identifier assigned to the item for referencing within the system, which can differ from the public-facing item name.
itemprocessfamilyStringFalseNoThe category or family to which the item belongs, typically used for organizing items based on production or processing characteristics.
itemprocessgroupStringFalseNoA subgroup classification within an item process family, allowing for further segmentation of items based on manufacturing or handling requirements.
itemurlStringFalseNoA URL linking to the item’s detailed page, often used for web store listings or internal documentation.
itemtypeStringFalseNoThe type of item, such as inventory, non-inventory, service, or assembly. This classification affects how the item is managed in the system.
lastinvtcountdateDateFalseNoThe most recent date on which a physical inventory count was conducted for this item. This helps track stock accuracy.
lastmodifieddateDatetimeFalseNoThe timestamp of the most recent modification made to the item record. This is useful for auditing and tracking changes.
lastpurchasepriceDecimalFalseNoThe last recorded purchase price for the item. This provides insight into cost trends and supplier pricing.
lastquantityavailablechangeDatetimeFalseNoThe timestamp of the last change made to the available quantity of this item in inventory. This helps track fluctuations in stock levels.
leadtimeIntegerFalseNoThe estimated number of days required to replenish stock for this item, assisting in inventory planning and reorder strategies.
listingdurationStringFalseNoThe duration for which an item listing remains active on eBay when integrated with NetSuite, which helps in managing online sales.
locationStringFalseNoThe specific location or warehouse where the item is stored is essential for inventory tracking and fulfillment.
locationadvwarningthresholdIntegerFalseNoThe threshold number of days before an item’s release status triggers an advance warning, which helps with production and planning.
locationallowstorepickupBooleanFalseNoIndicates whether store pickup is allowed for the item, which helps customers choose their preferred fulfillment method.
locationatpleadtimeDoubleFalseNoThe ATP lead time for the item at this location, affecting order fulfillment expectations.
locationaveragecostDecimalFalseNoThe average cost of the item at this specific location, assisting in financial analysis and pricing strategies.
locationbuildtimeDoubleFalseNoThe estimated lead time required to build or assemble the item at this location, which is critical for production planning.
locationbuildtimelotsizeDoubleFalseNoThe standard lot size used when calculating build time at this location, ensuring consistency in manufacturing schedules.
locationcostDecimalFalseNoThe standard cost of the item at this location is used for cost accounting and inventory valuation.
locationcostaccountingstatusStringFalseNoThe cost accounting status of the item at this location, indicating whether costs are current, pending, or outdated.
locationdefaultreturncostDecimalFalseNoThe default cost used when processing returns for this item at the specified location, which helps in managing return-related finances.
locationdemandsourceStringFalseNoSpecifies the primary demand source for this item at this location, such as sales orders, work orders, or intercompany transfers.
locationfixedbuildtimeIntegerFalseNoThe fixed lead time required to build the item at this location, irrespective of order quantity, which assists in scheduling production.
locationfixedlotsizeDoubleFalseNoThe fixed lot size applicable when planning production runs at this location, which helps optimize manufacturing efficiency.
locationinvtclassificationStringFalseNoThe inventory classification of the item at this location, such as high-turnover, slow-moving, or obsolete.
locationinvtcountintervalIntegerFalseNoThe interval in days between scheduled inventory counts for this item at this location, ensuring inventory accuracy.
locationlastinvtcountdateDateFalseNoThe most recent inventory count date for this item at the specified location, which helps track stock accuracy.
locationlatedemandthresholdDoubleFalseNoThe threshold for late demand impact at this location, used to identify critical delays in order fulfillment.
locationlateperioddaysIntegerFalseNoThe number of days defining the late period for demand at this location, helping to track and mitigate delays.
locationleadtimeIntegerFalseNoThe number of days required for inventory to be transferred or replenished at a specific location.
locationminimumrescheduledaysIntegerFalseNoThe minimum number of days required before a rescheduling action can be performed at a given location.
locationnextinvtcountdateDateFalseNoThe scheduled date for the next inventory count at the specified location, aiding in stock accuracy.
locationpastdueforecastdaysIntegerFalseNoThe number of days past due for forecasted demand at a location, impacting inventory planning.
locationpreferredstocklevelDoubleFalseNoThe ideal stock level for an item at a given location to prevent stockouts while avoiding overstocking.
locationqtyavailforstorepickupDoubleFalseNoThe quantity of an item available at a location for customers selecting in-store pickup.
locationquantityavailableDoubleFalseNoThe total quantity of an item currently available for sale or fulfillment at a specific location.
locationquantitybackorderedDoubleFalseNoThe number of units that have been ordered but are currently out of stock and awaiting replenishment.
locationquantitycommittedDoubleFalseNoThe number of units already allocated to sales orders or other commitments at a given location.
locationquantityintransitDoubleFalseNoThe number of units currently being transferred from one location to another but not yet received.
locationquantityonhandDoubleFalseNoThe actual physical quantity of an item stored at a location, including reserved stock.
locationquantityonorderDoubleFalseNoThe number of units that have been ordered from suppliers or other sources but have not yet been received.
locationreorderpointDoubleFalseNoThe inventory level at which an automatic reorder is triggered to replenish stock at a specific location.
locationreschedulehorizonIntegerFalseNoThe time horizon in days within which inventory rescheduling adjustments can be made.
locationrescheduleindaysIntegerFalseNoThe number of days within which an inbound shipment or order can be rescheduled earlier.
locationrescheduleoutdaysIntegerFalseNoThe number of days within which an inbound shipment or order can be postponed.
locationsafetystocklevelDoubleFalseNoThe buffer inventory level maintained at a location to prevent stockouts due to demand fluctuations or supply chain delays.
locationstorepickupbufferstockDoubleFalseNoThe quantity of stock reserved at a location specifically for store pickup orders to ensure availability.
locationsupplylotsizingmethodStringFalseNoThe method used for determining the lot size when replenishing inventory, such as fixed order quantity or lot-for-lot.
locationsupplytypeStringFalseNoThe sourcing method used for inventory at a given location, such as stocked, drop-shipped, or externally procured.
locationtotalvalueDecimalFalseNoThe total monetary value of inventory held at a specific location, based on cost or valuation method.
lowerwarninglimitDoubleFalseNoThe lower threshold for acceptable stock levels before triggering alerts or replenishment actions.
manufacturerStringFalseNoThe name of the company that produces the item, helping track the item's origin and supplier details.
manufactureraddr1StringFalseNoThe primary street address of the manufacturer is useful for shipping, compliance, and supplier management.
manufacturercityStringFalseNoThe city where the manufacturer is located, providing geographic context for supply chain and logistics operations.
manufacturerstateStringFalseNoThe state or province where the manufacturer is based, which is important for tax, regulatory compliance, and shipping considerations.
manufacturertariffStringFalseNoThe tariff classification code associated with the manufacturer, often required for import/export compliance.
manufacturertaxidStringFalseNoThe tax identification number assigned to the manufacturer for regulatory and financial reporting purposes.
manufacturerzipStringFalseNoThe postal or ZIP code associated with the manufacturer of the item is used for shipping calculations, tax determination, and compliance reporting.
matchbilltoreceiptBooleanFalseNoIndicates whether an invoice should be matched against the corresponding receipt before processing payment.
matrixBooleanFalseNoIndicates whether the item is part of a matrix configuration, typically used for items with variations such as size or color.
maxdonationamountStringFalseNoThe maximum amount that can be donated or allocated as a variable contribution for the item.
manufacturingchargeitemBooleanFalseNoSpecifies whether the item is a chargeable component within a manufacturing process.
matrixchildBooleanFalseNoIndicates whether the item is a child item within a matrix structure, inheriting attributes from its parent item.
matrixitemnametemplateStringFalseNoThe naming convention template applied to matrix items to standardize item descriptions across variations.
matrixtypeStringFalseNoIndicates the type of matrix used for the item, typically relevant for items with variations, such as apparel or electronics.
maximumquantityIntegerFalseNoThe maximum number of units that can be purchased or ordered for a given transaction.
metataghtmlStringFalseNoCustom HyperText Markup Language (HTML) meta tags used for SEO purposes to enhance the item's visibility in search engines.
minimumquantityIntegerFalseNoThe minimum number of units that must be purchased or ordered in a single transaction.
mossappliesBooleanFalseNoIndicates whether the item is subject to the Mini One Stop Shop (MOSS) tax scheme, applicable to digital goods in certain regions.
mpnStringFalseNoThe Manufacturer Part Number (MPN), a unique identifier assigned by the manufacturer to distinguish the product.
multmanufactureaddrBooleanFalseNoIndicates whether multiple manufacturing addresses are supported for this item. This is useful for businesses with multiple production facilities.
nextagcategoryStringFalseNoSpecifies the product category assigned to this item for NexTag, a price comparison website.
nextagproductfeedBooleanFalseNoDetermines whether this item is included in the NexTag product feed, allowing it to appear in online price comparisons.
nextinvtcountdateDateFalseNoRepresents the scheduled date for the next physical inventory count of this item to ensure stock accuracy.
numactivelistingsIntegerFalseNoDisplays the number of active listings for this item on eBay, reflecting current sales availability.
numberalloweddownloadsDoubleFalseNoSpecifies the total number of downloads allowed for this digital product before access is restricted.
numcurrentlylistedIntegerFalseNoIndicates the quantity of this item currently listed for sale on eBay, helping track marketplace stock levels.
obsoletedateDateFalseNoThe date on which this item becomes obsolete and is no longer considered for inventory, sales, or production.
nopricemessageStringFalseNoA custom message displayed when no price is available for this item, often used for request-based pricing.
obsoleterevisionStringFalseNoSpecifies the obsolete revision of this item, typically referring to discontinued or outdated product versions.
offersupportBooleanFalseNoIndicates whether customer support is offered for this item, helping buyers understand service availability.
onlinecustomerpriceDecimalFalseNoThe price of this item for customers purchasing online, distinct from in-store or bulk pricing.
onspecialBooleanFalseNoDenotes whether this item is currently part of a special promotion or discount campaign.
othervendorStringFalseNoThe name of an alternate vendor that supplies this item, providing sourcing flexibility.
outofstockbehaviorStringFalseNoDefines how the system handles out-of-stock situations for this item, such as backordering or preventing purchases.
overheadtypeStringFalseNoSpecifies the overhead cost classification assigned to this item, used in cost accounting and pricing strategies.
overallquantitypricingtypeStringFalseNoDetermines how quantity-based pricing is applied to this item, affecting discounts and bulk order calculations.
pagetitleStringFalseNoThe title displayed on the product's web page, optimizing search visibility and customer engagement.
parentStringFalseNoIndicates the parent item to which this item is related, commonly used for sub-items or product variations.
periodiclotsizetypeStringFalseNoDefines the type of periodic lot sizing used for this item in inventory planning, influencing reorder strategies.
preferredlocationIntegerFalseNoSpecifies the default storage location where this item is primarily kept within inventory.
planningitemcategoryStringFalseNoCategorizes this item for planning purposes, helping with demand forecasting and resource allocation.
outofstockmessageStringFalseNoThe message displayed to customers when this item is out of stock, guiding purchasing decisions.
preferencecriterionStringFalseNoSpecifies the preference criterion used for trade compliance, such as origin-based customs classification.
preferredbinBooleanFalseNoIndicates whether this item is assigned to a preferred bin location within a warehouse for optimized picking.
preferredlocationStringFalseNoThe default or primary inventory location assigned to an item within the system.
preferredstocklevelDoubleFalseNoDefines the ideal stock level to maintain for this item to ensure consistent availability without overstocking.
preferredstockleveldaysIntegerFalseNoRepresents the number of days of supply the preferred stock level should cover, aiding in inventory management.
priceDecimalFalseNoThe standard sales price of this item, used for customer transactions and pricing calculations.
pricesincludetaxBooleanFalseNoIndicates whether item prices include tax when displayed or processed in transactions, which affects how tax calculations are applied.
pricinggroupStringFalseNoDefines the pricing group to which the item belongs, which helps manage discounts and special pricing rules for related items.
primarycategoryIntegerFalseNoRepresents the primary eBay category ID for the item when listed on eBay, categorizing the item appropriately in online marketplaces.
purchaseorderamountDoubleFalseNoSpecifies the allowable variance in the total amount of a vendor bill compared to its associated purchase order.
purchaseorderquantityDoubleFalseNoDefines the acceptable variance in quantity between a vendor bill and its corresponding purchase order, which helps manage discrepancies.
purchaseorderquantitydiffDoubleFalseNoRecords the actual difference in quantity between a vendor bill and its associated purchase order, tracking purchase discrepancies.
printitemsBooleanFalseNoIndicates whether items should be printed on forms such as invoices and packing slip for managing item visibility on documents.
prodpricevarianceacctIntegerFalseNoRepresents the general ledger account used to track price variances in production costs in manufacturing.
prodqtyvarianceacctIntegerFalseNoSpecifies the general ledger account for recording quantity variances in production, which helps monitor discrepancies in production.
projecttemplateIntegerFalseNoIdentifies the default project template associated with this item used in service-based operations.
purchasedescriptionStringFalseNoProvides a detailed description of the item for purchasing purposes, appearing on purchase orders and vendor-related transactions.
purchaseunitStringFalseNoDefines the unit of measurement used when purchasing this item. Examples include 'Each,' 'Box,' or 'Case,' depending on how the item is ordered.
purchasepricevarianceacctIntegerFalseNoSpecifies the general ledger account used to track purchase price variances, helping businesses analyze differences between costs.
quantityavailableDoubleFalseNoRepresents the current quantity of the item that is available for sale or use, excluding committed stock.
quantitybackorderedDoubleFalseNoTracks the number of units currently on backorder, indicating demand for an item that exceeds the available stock and is awaiting fulfillment.
quantitycommittedDoubleFalseNoShows the quantity of this item that has been allocated to sales orders but not yet shipped. Helps ensure accurate inventory tracking.
quantityonhandDoubleFalseNoIndicates the total quantity of the item physically available in inventory, including both committed and uncommitted stock.
quantityonorderDoubleFalseNoDisplays the total number of units currently on order from suppliers, which helps businesses anticipate stock replenishments.
quantitypricingscheduleStringFalseNoLinks the item to a quantity-based pricing schedule, which defines pricing tiers based on order quantities.
receiptamountDoubleFalseNoSpecifies the allowable tolerance for discrepancies between a vendor bill and the amount recorded on an item receipt.
receiptquantityDoubleFalseNoDefines the acceptable variance in quantity between an item receipt and the vendor bill, which helps control inventory discrepancies.
receiptquantitydiffDoubleFalseNoRecords the actual difference in quantity between an item receipt and a vendor bill is useful for reconciling purchase and inventory.
reordermultipleIntegerFalseNoDetermines the minimum quantity multiple required when reordering the item, ensuring purchases align with supplier packaging.
reorderpointDoubleFalseNoSpecifies the inventory level at which a reorder is triggered to prevent stockouts, maintaining adequate stock levels based on demand.
rescheduleindaysIntegerFalseNoDefines the number of days an inbound order can be rescheduled earlier to align with changing demand forecasts.
rescheduleoutdaysIntegerFalseNoSpecifies the number of days an order can be pushed out when supply chain delays occur or demand decreases.
reservepriceDecimalFalseNoRepresents the minimum price at which an item can be sold on eBay, ensuring sellers do not accept bids below a certain threshold.
relateditemsdescriptionStringFalseNoProvides additional details about related items is used to display complementary or alternative products.
revrecforecastruleStringFalseNoDetermines the rule applied for forecasting revenue recognition, aligning revenue recognition practices with accounting policies.
revrecscheduleStringFalseNoSpecifies the revenue recognition schedule associated with the item, defining how revenue is recognized over time.
residualDoubleFalseNoRepresents the remaining value of an asset or item after depreciation or usage, which helps in financial reporting and asset valuation.
roundupascomponentBooleanFalseNoIndicates whether the item quantity should be rounded up when used as a component in a bill of materials or production process.
rotationtypeStringFalseNoDefines the stock rotation method for the item, such as FIFO (First In, First Out) or LIFO (Last In, First Out), managing inventory flow.
safetystocklevelDoubleFalseNoSpecifies the minimum inventory level that should be maintained to prevent stockouts, which acts as a buffer against demand fluctuations.
safetystockleveldaysIntegerFalseNoDefines the number of days of stock coverage provided by the safety stock level, helping businesses plan for supply chain variability.
salesdescriptionStringFalseNoContains the product description displayed on sales transactions, such as quotes, orders, and invoices.
saleunitStringFalseNoSpecifies the unit of measurement in which the item is sold, such as 'Each,' 'Pack,' or 'Pallet' ensuring clarity in sales transactions.
sameasprimarybookamortizationBooleanFalseNoIndicates whether amortization settings for this item match those of the primary accounting book.
sameasprimarybookrevrecBooleanFalseNoSpecifies whether revenue recognition settings match those of the primary accounting book, ensuring compliance with accounting standards.
schedulebcodeStringFalseNoRepresents the Schedule B export code used for international trade reporting and classifying goods for customs declarations.
schedulebnumberStringFalseNoThe Schedule B Number is a unique identifier for classifying exported goods, ensuring compliance with international trade regulations.
schedulebquantityStringFalseNoThe Schedule B Quantity, indicating the number of units of an item being exported, as required for customs declarations and reporting.
searchkeywordsStringFalseNoA list of keywords used to improve searchability for the item within catalogs, online marketplaces, and internal searches.
scrapacctIntegerFalseNoThe general ledger account designated to record the cost of scrapped or discarded inventory, useful for financial tracking and reporting.
seasonaldemandBooleanFalseNoIndicates whether the item experiences seasonal fluctuations in demand, which can impact inventory planning and sales forecasting.
secondaryconsumptionunitStringFalseNoThe alternative unit of measure used when tracking the consumption of this item in production or internal processes.
secondarypurchaseunitStringFalseNoAn alternate unit of measure that can be used for purchasing this item, differing from the standard purchase unit.
secondarysaleunitStringFalseNoA secondary unit of measure that can be used when selling this item, allowing flexibility in sales transactions.
secondarystockunitStringFalseNoAn additional unit of measure used for tracking inventory levels in a format different from the primary stock unit.
secondaryunitstypeStringFalseNoThe classification of secondary units of measure associated with this item, ensuring consistency across various unit conversions.
sellonebayBooleanFalseNoIndicates whether this item is listed for auction or sale on eBay, enabling synchronization with online marketplaces.
serialnumberStringFalseNoThe unique serial or lot number assigned to this item, used for tracking, warranty management, and quality control.
serialnumberlocationStringFalseNoThe designated location within the inventory system where serial or lot numbers are stored, helping streamline retrieval and tracking.
shipindividuallyBooleanFalseNoSpecifies whether this item must be shipped separately from other items, often due to size, fragility, or regulatory requirements.
shippackageStringFalseNoThe type of package or packaging specification recommended for shipping this item, ensuring proper handling and protection.
shippingrateDecimalFalseNoThe cost of shipping this item, calculated based on carrier rates, item weight, dimensions, and destination.
shoppingdotcomcategoryStringFalseNoThe category under which this item is listed on Shopping.com, improving visibility in online product searches.
shippingcostDecimalFalseNoThe total cost associated with shipping this item, including handling fees, carrier charges, and any additional surcharges.
shoppingproductfeedBooleanFalseNoIndicates whether this item is included in an automated product feed for online shopping platforms to enhance product discoverability.
shopzillacategoryidIntegerFalseNoThe unique category identifier assigned to this item in the Shopzilla product catalog, used for accurate categorization in marketplace listings.
shopzillaproductfeedBooleanFalseNoDetermines whether this item is part of the automated product feed sent to Shopzilla for online advertising and sales.
sitemappriorityDoubleFalseNoThe priority level assigned to this item’s webpage in the website’s sitemap, influencing search engine optimization (SEO) rankings.
softdescriptorStringFalseNoA short description used for credit card statements, helping customers recognize transactions related to this item purchase.
startingpriceDecimalFalseNoThe initial price set for this item when listed on eBay auctions, serving as the minimum acceptable bid.
stockdescriptionStringFalseNoA brief but informative description of the item, typically used for internal inventory management and reporting.
stockunitStringFalseNoThe primary unit of measure in which this item is stocked, such as pieces, kilograms, or liters, ensuring accurate inventory tracking.
storedescriptionStringFalseNoA detailed description of the item as displayed in an online or physical store, providing customers with relevant product information.
showdefaultdonationamountBooleanFalseNoIndicates whether a default donation amount should be displayed when this item is associated with a charitable contribution option.
subsidiaryStringFalseNoThe specific subsidiary or business entity within the organization that owns or manages this item, aiding in financial reporting and allocation.
subtypeStringFalseNoA classification of this item that provides additional categorization beyond the primary item type, often used for reporting and organization.
supplylotsizingmethodStringFalseNoThe methodology used to determine the lot size for replenishing inventory, such as fixed order quantity or economic order quantity.
supplyreplenishmentmethodStringFalseNoThe strategy used for restocking this item, such as Make-to-Stock (MTS), Make-to-Order (MTO), or Just-in-Time (JIT) inventory management.
storedetaileddescriptionStringFalseNoA comprehensive, rich-text description of this item, often used for marketing and detailed product specifications in an online store.
supplytypeStringFalseNoIndicates whether the item is a manufactured, purchased, or drop-shipped product, affecting supply chain and procurement processes.
storedisplayimageIntegerFalseNoThe reference ID of the main product image displayed in the store, used to visually represent the item to customers.
storedisplaynameStringFalseNoThe name of the item as displayed in the online store, which can differ from the internal item name.
storedisplaythumbnailIntegerFalseNoThe reference ID of the thumbnail image for the item, shown in smaller previews on product listings and search results.
supplytimefenceIntegerFalseNoThe planning time fence in days, defining the period during which supply changes are restricted to avoid last-minute disruptions.
taxcodeStringFalseNoThe tax classification code assigned to this item, used for calculating applicable sales tax rates.
taxscheduleStringFalseNoThe tax schedule associated with this item, defining how sales tax is applied across different regions or jurisdictions.
thumbnailurlStringFalseNoThe URL of the thumbnail image for this item, typically used in online product listings and search results.
totalvalueDecimalFalseNoThe total value of this item in inventory, calculated as the unit cost multiplied by the total quantity on hand.
totalquantityonhandDoubleFalseNoThe current total stock available for this item across all locations, helping with inventory management and replenishment planning.
tracklandedcostBooleanFalseNoIndicates whether the total landed cost, including shipping, duties, and other expenses, is tracked, aiding in cost analysis.
transferpriceDoubleFalseNoThe price at which inventory items are transferred between locations within the company. This is used for internal cost tracking.
typeStringFalseNoThe classification of the item, such as inventory, non-inventory, service, or other types defined within NetSuite.
unitstypeStringFalseNoThe unit type associated with the item, determining the measurement system used, such as each, dozen, or box.
unbuildvarianceaccountIntegerFalseNoThe general ledger account where cost variances related to unbuilding assemblies are recorded.
upccodeStringFalseNoThe Universal Product Code (UPC) assigned to the item for barcode scanning and product identification.
upperwarninglimitDoubleFalseNoThe maximum threshold for a specified parameter before triggering a warning, such as inventory levels or quality control measures.
urlcomponentStringFalseNoA segment of the URL specific to the item, typically used for e-commerce and online catalog display.
usebinsBooleanFalseNoIndicates whether the item is stored in designated bins within warehouses for inventory management.
usecomponentyieldBooleanFalseNoDetermines whether the system accounts for component yield variations when manufacturing an assembly item.
usemarginalratesBooleanFalseNoIndicates whether marginal tax rates apply to this item in tax calculations for transactions.
vendorStringFalseNoThe preferred vendor from whom the item is primarily sourced, used in procurement and purchase order processing.
vendorcodeStringFalseNoA unique identifier assigned by the vendor to this item, often used for cross-referencing vendor catalogs.
vendorcostDecimalFalseNoThe cost at which the vendor sells the item to the company, used for procurement and pricing calculations.
vendreturnvarianceaccountIntegerFalseNoThe account where cost variances related to vendor returns are recorded, ensuring accurate financial tracking.
vendorcostenteredDecimalFalseNoThe manually entered cost of the item from the vendor, which may differ from system-calculated costs.
vendornameStringFalseNoThe name of the vendor providing the item, used in reporting and purchase order management.
vendorpricecurrencyStringFalseNoThe currency in which the vendor cost is denominated, ensuring accurate multi-currency transactions.
vsoedeferralStringFalseNoIndicates the revenue deferral method applied to this item, used in revenue recognition calculations.
vsoedeliveredBooleanFalseNoSpecifies whether the item has been delivered, often defaulting to 'Delivered' status for fulfillment tracking.
vsoepermitdiscountStringFalseNoDetermines whether and how discounts are allowed for this item within sales transactions.
vsoepriceDoubleFalseNoRepresents the VSOE price of an item used in revenue recognition processes, particularly for allocating revenue in a sales transaction.
vsoesopgroupStringFalseNoDefines the allocation type used for revenue recognition purposes, ensuring compliance with accounting standards.
websiteStringFalseNoStores the associated website URL or identifier where this item is listed or available for purchase.
weightDoubleFalseNoRecords the physical weight of the item, typically used for shipping calculations and logistics management.
weightunitIntegerFalseNoThe unit of measurement for weight, such as grams, kilograms, or pounds, based on the unit type settings.
weightunitsStringFalseNoThe textual representation of the weight unit, such as 'kg' or 'lbs', used in user interfaces and reports.
wipacctIntegerFalseNoThe WIP account associated with an inventory item used in manufacturing or assembly processes where costs are accumulated for partially completed items.
wipvarianceacctIntegerFalseNoThe account used to track variances between estimated and actual work-in-progress costs in manufacturing.
yahooproductfeedBooleanFalseNoIndicates whether the item is included in the Yahoo Shopping product feed for online sales and marketing.

Return to Top

itemAccountingBookDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe specific accounting book associated with this record, identifying the financial ledger in which the item-related accounting details are recorded.
itemStringFalseNoThe unique identifier or name of the item related to this accounting book details, tracking product or service financial information within the specified accounting book.

Return to Top

itemaccountmapping 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with the item account mapping, defining the financial reporting framework used for transactions.
classStringFalseNoThe classification category assigned to the item account mapping, used for tracking and segmenting financial data.
customdimensionStringFalseNoA customizable dimension that allows users to define and track additional categorization attributes for item account mapping.
customformStringFalseNoThe custom form applied to this item account mapping, influencing the layout and fields available when viewed or edited.
departmentStringFalseNoThe department associated with the item account mapping, helping to allocate transactions to the correct business unit.
destinationaccountStringFalseNoThe general ledger account that serves as the destination for mapped transactions related to the specified item account.
effectivedateDateFalseNoThe date when this item account mapping becomes active, determining from when the mapping rules apply.
enddateDateFalseNoThe date when this item account mapping is no longer active, marking the end of its applicability.
externalidStringFalseNoA unique identifier assigned externally to the item account mapping, allowing for integration with other systems.
itemaccountStringFalseNoThe specific item-related account being mapped, determining the financial treatment of inventory, expenses, or revenue.
locationStringFalseNoThe location associated with the item account mapping, used to allocate transactions based on geographical or business site distinctions.
sourceaccountStringFalseNoThe original general ledger account from which transactions are being mapped to a new destination account.
subsidiaryStringFalseNoThe subsidiary to which this item account mapping applies, ensuring the correct financial reporting structure within a multi-entity organization.

Return to Top

itemBaseSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoRepresents the unique identifier or internal reference for an item, linking to its record and allowing access to details such as pricing, availability, and classification.

Return to Top

itemBinQuantity 

NameTypeReadOnlyReferencesFilterOnlyDescription
binStringFalseNoThe unique identifier for the storage bin where items are located within the warehouse, enabling businesses to manage inventory.
itemStringFalseNoThe specific item stored in the bin, identified by its internal item name or Stock Keeping Unit (SKU).
onhandDoubleFalseNoThe total quantity of the item currently stored in the specified bin, regardless of availability.
onhandavailDoubleFalseNoThe quantity of the item in the bin that is available for allocation, excluding committed stock or reserved inventory.

Return to Top

itemcollection 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoAn internal system-generated identifier that is unique to each item collection and cannot be changed.
descriptionStringFalseNoA detailed explanation or summary of the item collection, providing context on its purpose or usage within NetSuite.
externalidStringFalseNoAn optional identifier that can be set externally to integrate with other systems, ensuring consistency across different platforms.
isinactiveBooleanFalseNoIndicates whether the item collection is currently inactive. If set to 'true', the collection is not available for use in transactions.
nameStringFalseNoThe name of the item collection, typically used to categorize or group related items for easy identification and retrieval.

Return to Top

ItemCollectionCustomerSegmentMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
customersegmentStringFalseNoRepresents a specific customer segment, which categorizes customers based on shared characteristics such as purchasing behavior, industry, or geographic location.
itemsegmentStringFalseNoIndicates the item collection associated with a customer segment, allowing for the grouping of products or services relevant to that segment.

Return to Top

itemcollectionitemmap 

NameTypeReadOnlyReferencesFilterOnlyDescription
externalidStringFalseNoA unique identifier for the item collection mapping, used for external integrations and references.
internalidIntegerFalseNoAn internal unique identifier for the item collection mapping, primarily used within NetSuite for database operations.
itemStringFalseNoThe item associated with this mapping, representing a specific product or inventory unit in NetSuite.
itemcollectionStringFalseNoThe collection to which the item belongs, grouping related items together for categorization, pricing, or other business logic.

Return to Top

ItemCollectionItemSimpleMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoRepresents the unique identifier or name of an item within the item collection used to map items to specific collections in NetSuite.

Return to Top

itemCorrelatedItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
correlationfldDoubleFalseNoThe correlation percentage between the primary item and the correlated item, representing the strength of their relationship.
countfldIntegerFalseNoThe total number of times the primary item and the correlated item have appeared together in transactions or sales records.
itemStringFalseNoRepresents the identifier or unique name of the primary item in the correlation analysis.
itemnkeyfldStringFalseNoA unique key or reference for the correlated item, used for internal tracking and identification within the database.
liftfldDoubleFalseNoThe lift percentage, which measures the increase in likelihood that the correlated item is purchased when the primary item is also purchased.

Return to Top

itemdemandplan 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique identifier assigned internally to each demand plan entry.
alternatesourceitemStringFalseNoThe item that can be used as an alternative source in the demand plan, helping to meet supply needs.
analysisdurationIntegerFalseNoThe number of past periods analyzed to determine historical demand trends for forecasting.
demandplanidStringFalseNoSystem-generated identifier for the demand plan, used to track and reference specific plans.
externalidStringFalseNoUser-defined external identifier that links this demand plan to external systems or records.
itemStringFalseNoThe specific inventory item for which demand is being forecasted in this plan.
locationStringFalseNoThe physical or logical location associated with this demand plan, such as a warehouse or store.
memoStringFalseNoA text field for entering notes or comments related to this demand plan entry.
projectiondurationIntegerFalseNoThe total length of time, measured in periods, over which demand projections are made.
projectionintervalStringFalseNoThe frequency at which demand projections are calculated, such as daily, weekly, or monthly.
projectionmethodStringFalseNoThe technique used to forecast demand, such as moving average, linear regression, or seasonal analysis.
projectionstartdateDateFalseNoThe start date from which demand projections begin in the forecast.
subsidiaryStringFalseNoThe business subsidiary to which this demand plan applies, relevant for multi-subsidiary organizations.
unitsStringFalseNoThe unit of measure used for demand planning, ensuring consistency in quantity calculations.

Return to Top

ItemDemandPlanDemandplandetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
demandrownumberIntegerFalseNoThe sequential identifier for each demand row within the item demand plan, ensuring unique tracking of demand entries.
enddateDateFalseNoThe final date for the demand entry, indicating the last day within the demand plan period that this row applies to.
itemdemandplanStringFalseNoThe identifier or reference to the specific item demand plan associated with this entry, linking it to the overall forecasting strategy.
quantityDoubleFalseNoThe total amount of the item forecasted for this specific demand entry, measured in the designated unit for the item.

Return to Top

ItemDemandSource 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoUnique internal identifier for the item demand source, used within the system to reference and track specific records.

Return to Top

itemfulfillment 

NameTypeReadOnlyReferencesFilterOnlyDescription
accessibilitytypefedexStringFalseNoSpecifies the accessibility type for FedEx shipments, determining the level of delivery access required.
ancillaryendorsementfedexStringFalseNoIndicates the type of ancillary service endorsement for FedEx, used for special handling or return services.
b13afilingoptionfedexStringFalseNoDefines the B13A filing option for FedEx, required for exporting goods from Canada and subject to customs regulations.
b13astatementdatafedexStringFalseNoContains additional details related to the B13A filing for FedEx, ensuring compliance with Canadian export documentation.
backupemailaddressupsStringFalseNoStores an alternative email address for UPS notifications, used in case the primary email is unavailable.
balanceDecimalFalseNoRepresents the outstanding balance associated with the fulfillment, reflecting any unpaid amounts.
bookingconfirmationnumfedexStringFalseNoA unique booking confirmation number for FedEx shipments, used for tracking and managing scheduled pickups.
certifiedmailuspsBooleanFalseNoIndicates whether the shipment is sent via USPS Certified Mail, which provides proof of mailing and delivery tracking.
consolidatebalanceDecimalFalseNoReflects the combined outstanding balance across multiple transactions or fulfillments.
createddateDatetimeFalseNoRecords the date and time when the fulfillment record was created in the system.
createdfromStringFalseNoReferences the source record (such as a sales order) from which this fulfillment was generated.
createdfromshipgroupIntegerFalseNoIdentifies the specific shipment group associated with the source transaction for this fulfillment.
customformStringFalseNoSpecifies the custom form template used for this fulfillment, allowing for customized document layouts.
entityStringFalseNoRepresents the customer, vendor, or other entity associated with this fulfillment transaction.
exchangerateStringFalseNoIndicates the exchange rate applied if the transaction involves currency conversion.
externalidStringFalseNoStores a unique identifier from an external system, allowing integration and tracking across different platforms.
haladdressfedexStringFalseNoProvides the Hold at Location (HAL) address for FedEx shipments, specifying the pickup location for the recipient.
halphonefedexStringFalseNoLists the contact phone number for the FedEx HAL service, ensuring recipient verification.
handlingcostDecimalFalseNoRepresents the total handling charges applied to the fulfillment, covering packing and processing expenses.
hazmattypefedexStringFalseNoSpecifies the hazardous material classification for FedEx shipments, ensuring compliance with safety regulations.
holdatlocationfedexBooleanFalseNoIndicates whether the FedEx shipment is being held at a designated FedEx location for pickup instead of home delivery.
insidedeliveryfedexBooleanFalseNoSpecifies whether FedEx should provide inside delivery, meaning the package is delivered beyond the front door.
insidepickupfedexBooleanFalseNoIndicates whether FedEx is required to pick up the package from inside a facility rather than curbside.
isbasecurrencyBooleanFalseNoDenotes whether the transaction is in the base currency of the subsidiary or company.
iscargoaircraftonlyfedexBooleanFalseNoMarks the package as restricted to cargo aircraft only for FedEx shipments due to hazardous material regulations.
lastmodifieddateDatetimeFalseNoRecords the most recent date and time when the fulfillment record was modified.
memoStringFalseNoStores any additional notes, comments, or references related to an individual item fulfillment record.
packeddateDateFalseNoRecords the date when the items in this fulfillment were packed and prepared for shipment.
pickeddateDateFalseNoRecords the date when the items in this fulfillment were picked from inventory for packing.
postingperiodStringFalseNoIndicates the accounting period in which the fulfillment is posted, relevant for financial reporting.
requestedbyStringFalseNoIdentifies the person or entity that requested the fulfillment, providing tracking for internal operations.
shipaddressStringFalseNoSpecifies the detailed shipping address where the fulfillment is being delivered.
shipaddresslistStringFalseNoReferences a predefined list of shipping addresses associated with the customer or entity.
shipcompanyStringFalseNoStores the name of the shipping company responsible for delivering the fulfillment.
shipcountryStringFalseNoIndicates the destination country where the items in a particular fulfillment transaction are being shipped.
shipisresidentialBooleanFalseNoMarks whether the shipping address is a residential location, which can affect delivery fees and restrictions.
shipmentprocessedBooleanFalseNoIndicates whether the shipment has been processed in the system, confirming that the order is ready for dispatch.
shipmentweightfedexStringFalseNoRecords the total weight of the shipment as measured for FedEx deliveries.
shipmentweightupsStringFalseNoRecords the total weight of the shipment as measured for UPS deliveries.
shipmentweightuspsStringFalseNoRecords the total weight of the shipment as measured for USPS deliveries.
shipmethodStringFalseNoSpecifies the shipping method or carrier service selected for this fulfillment.
shipoverrideBooleanFalseNoIndicates whether the default shipping method was overridden manually for this fulfillment.
shippeddateDateFalseNoRecords the date when the shipment was officially dispatched to the recipient.
shipphoneStringFalseNoStores the contact phone number associated with the shipping address for delivery communication.
shippingaddressStringFalseNoContains the complete shipping address details, including street, city, state, and postal code.
shippingcostDecimalFalseNoRecords the total cost of shipping applied to this fulfillment, including carrier charges and fees.
shipstatusStringFalseNoIndicates the current status of the shipment, such as pending, shipped, or delivered.
statusStringFalseNoRepresents the overall status of the fulfillment, tracking its progress from creation to completion.
statusRefStringFalseNoReferences the internal system status for the fulfillment, used for backend processing.
subsidiaryStringFalseNoIdentifies the subsidiary associated with this fulfillment, relevant for multi-entity businesses.
termsofsalefedexStringFalseNoSpecifies the terms of sale applicable to this FedEx shipment, outlining the responsibilities of the buyer and seller.
trandateDateFalseNoRecords the transaction date of the fulfillment, used for financial and operational tracking.
tranidStringFalseNoStores the unique transaction ID assigned to this fulfillment, ensuring system-wide identification.

Return to Top

ItemFulfillmentPackage 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemfulfillmentStringFalseNoRepresents the unique identifier for the item fulfillment record, which tracks the shipment of items from an order.
packagedescrStringFalseNoA detailed description of the contents within the package, including product names, quantities, and any relevant notes.
packagetrackingnumberStringFalseNoThe tracking number assigned by the carrier for the shipment, allowing customers and businesses to monitor delivery progress.
packagetrackingnumberreturnStringFalseNoThe return tracking number assigned by the carrier, used when a package is being sent back to the sender.

Return to Top

ItemFulfillmentPackageFedex 

NameTypeReadOnlyReferencesFilterOnlyDescription
admpackagetypefedexStringFalseNoSpecifies the type of admissibility package required for FedEx shipments, ensuring compliance with shipping regulations.
alcoholrecipienttypefedexStringFalseNoIndicates the category of recipient for alcohol shipments, such as a business or an individual, ensuring proper handling and delivery.
authorizationnumberfedexStringFalseNoThe unique authorization number required for specific shipments, such as controlled substances or regulated items.
codamountfedexDecimalFalseNoThe Cash on Delivery (COD) amount that must be paid by the recipient before the package is released.
codfreighttypefedexStringFalseNoDetermines whether freight charges are added to the COD amount, specifying how additional shipping costs are handled.
codmethodfedexStringFalseNoDefines the method by which the COD amount is collected, such as cash, check, or money order.
codotherchargefedexDecimalFalseNoAny additional charges applied to the COD amount, such as handling fees or insurance costs.
deliveryconffedexStringFalseNoSpecifies the type of delivery confirmation required, such as signature confirmation or proof of delivery.
dryiceweightfedexDoubleFalseNoIndicates the weight of dry ice in the shipment, necessary for packages requiring temperature control.
insuredvaluefedexDecimalFalseNoThe declared value of the package for insurance purposes, ensuring coverage in case of loss or damage.
isalcoholfedexBooleanFalseNoIndicates whether the package contains alcohol, which may require special shipping and handling procedures.
isnonstandardcontainerfedexBooleanFalseNoSpecifies whether the package is in a non-standard container, affecting shipping rates and handling requirements.
itemfulfillmentStringFalseNoRepresents the item fulfillment record associated with the shipment, linking the package to the corresponding order.
packageheightfedexIntegerFalseNoThe height of the package in inches, used to calculate shipping rates and ensure proper handling.
packagelengthfedexIntegerFalseNoThe length of the package in inches, important for determining dimensional weight and shipping costs.
packagetrackingnumberfedexStringFalseNoThe unique tracking number assigned to the package by FedEx, enabling real-time shipment tracking.
packagetrackingnumberreturnStringFalseNoThe tracking number assigned to a return shipment, allowing for monitoring of returned goods.
packageweightfedexDoubleFalseNoThe weight of the package in pounds, used to determine shipping costs and applicable handling procedures.
packagewidthfedexIntegerFalseNoThe width of the package in inches, factored into dimensional weight calculations for shipping.
packagingfedexStringFalseNoSpecifies the type of FedEx packaging used, such as an envelope, box, or custom packaging.
priorityalertcontentfedexStringFalseNoA detailed description of the contents in a Priority Alert shipment, ensuring proper handling and expedited processing.
priorityalerttypefedexStringFalseNoDefines the level of priority alert service applied to the package, such as temperature-sensitive or high-value shipments.
reference1fedexStringFalseNoReference information provided for tracking and identification purposes, often including order or invoice numbers.
signatureoptionsfedexStringFalseNoLists the available FedEx delivery signature options, such as adult signature required or direct signature.
signaturereleasefedexStringFalseNoIndicates whether the recipient has pre-authorized FedEx to leave the package without a signature.

Return to Top

ItemFulfillmentPackageUps 

NameTypeReadOnlyReferencesFilterOnlyDescription
additionalhandlingupsBooleanFalseNoIndicates if the package requires special handling based on size, weight, or characteristics per United Parcel Service (UPS) regulations.
codamountupsDecimalFalseNoThe amount to be collected from the recipient upon delivery under the Cash on Delivery (COD) service.
codmethodupsStringFalseNoThe method used for collecting the COD amount, such as cash, check, or another payment method accepted by UPS.
deliveryconfupsStringFalseNoSpecifies the level of delivery confirmation requested for the package, such as signature required or adult signature required.
insuredvalueupsDecimalFalseNoThe declared insured value of the package, determining the maximum reimbursement amount in case of loss or damage during transit.
itemfulfillmentStringFalseNoThe internal identifier linking this package to the corresponding item fulfillment record in NetSuite.
packagedescrupsStringFalseNoA brief description of the package contents, which may be used for shipping documentation and customs declarations.
packageheightupsIntegerFalseNoThe vertical measurement of the package in inches, used for calculating dimensional weight and shipping costs.
packagelengthupsIntegerFalseNoThe longest side measurement of the package in inches, used for shipping rate determination.
packagetrackingnumberreturnStringFalseNoThe UPS tracking number assigned to the package for return shipments, allowing tracking and status updates.
packagetrackingnumberupsStringFalseNoThe primary UPS tracking number for the package, enabling monitoring of its movement through the shipping network.
packageweightupsDoubleFalseNoThe total weight of the package in pounds, used for calculating shipping costs and verifying weight limits.
packagewidthupsIntegerFalseNoThe horizontal measurement of the package in inches, relevant for shipping calculations and dimensional weight determination.
packagingupsStringFalseNoThe type of packaging selected for the shipment, such as UPS-branded boxes or custom packaging.
reference1upsStringFalseNoA customizable reference field that can store order numbers, customer IDs, or other shipment-related identifiers for tracking purposes.
reference2upsStringFalseNoAn additional customizable reference field for storing extra shipment-related information, such as invoice numbers or purchase order details.

Return to Top

ItemFulfillmentPackageUsps 

NameTypeReadOnlyReferencesFilterOnlyDescription
deliveryconfuspsStringFalseNoSpecifies the type of delivery confirmation requested for the United States Postal Service (USPS) package, such as Signature Confirmation or Certified Mail.
insuredvalueuspsDecimalFalseNoThe declared value of the package contents for insurance purposes, ensuring coverage in case of loss or damage.
itemfulfillmentStringFalseNoThe unique identifier for the item fulfillment record associated with this USPS package shipment.
packagedescruspsStringFalseNoA detailed description of the package contents, providing clarity on the shipped items for customs and shipping purposes.
packageheightuspsIntegerFalseNoThe height of the package in inches, used for calculating shipping costs and ensuring proper handling.
packagelengthuspsIntegerFalseNoThe length of the package in inches, required for determining dimensional weight and shipping classification.
packagetrackingnumberuspsStringFalseNoThe tracking number assigned by USPS, allowing shippers and recipients to monitor package status and delivery progress.
packageweightuspsDoubleFalseNoThe total weight of the package in pounds, used to calculate shipping rates and ensure compliance with carrier weight limits.
packagewidthuspsIntegerFalseNoThe width of the package in inches, factored into dimensional weight calculations for accurate shipping costs.
packaginguspsStringFalseNoThe type of packaging used for the USPS shipment, such as Flat Rate Box, Envelope, or Custom Packaging.
reference1uspsStringFalseNoAn optional reference number provided by the sender to associate the shipment with an internal order, invoice, or tracking system.
reference2uspsStringFalseNoA secondary reference number that can be used for additional tracking or order association purposes.

Return to Top

itemFulfillmentReturnAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA system-generated identifier for the return address record used internally by NetSuite.
addr1StringFalseNoThe primary street address for the return location, typically the most specific part of the address, such as a street name and number.
addr2StringFalseNoAdditional address line for the return location, which can be used for suite numbers, apartment numbers, or other relevant address details.
addr3StringFalseNoA tertiary address line for the return location, which can be used for extra details such as building names or complex identifiers.
addresseeStringFalseNoThe full name of the person or entity to whom the returned item is being addressed, typically the recipient's name.
attentionStringFalseNoA specific contact person at the return location. This is useful when directing the return to a specific individual within a business or department.
cityStringFalseNoThe city where the return address is located. This value is used for shipping and logistics purposes.
countryStringFalseNoThe country associated with the return address. This should be a recognized country name or code.
dropdownstateStringFalseNoA state or province selection used in dropdown menus within NetSuite. This value is often standardized based on the country.
overrideBooleanFalseNoIndicates whether the default return address settings are overridden. If 'true', the user has customized the return address details.
stateStringFalseNoThe state or province associated with the return address. This value is used for determining tax rates, shipping zones, and other regional settings.

Return to Top

itemFulfillmentShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique identifier for the address entry, typically used as a primary key or reference within the table.
addr1StringFalseNoThe first line of the address, typically used to include street name, building number, and any primary address information.
addr2StringFalseNoThe second line of the address, often used for additional address details such as apartment or suite number.
addr3StringFalseNoAn optional third line of the address, used for additional address information if necessary, such as a building name or floor number.
addresseeStringFalseNoThe name of the recipient or intended recipient of the shipment, typically the individual or company receiving the delivery.
attentionStringFalseNoA specific individual or department to which the address is directed, often used in business contexts to ensure the correct recipient.
cityStringFalseNoThe city or town part of the address where the recipient is located, typically used for sorting mail and deliveries.
countryStringFalseNoThe country where the recipient is located. This field helps identify the correct international region for shipping.
dropdownstateStringFalseNoThe state or province part of the address. This value is selected from a predefined list, ensuring correct and standardized entries for geographic locations.
overrideBooleanFalseNoA boolean flag that determines if certain address validation rules should be bypassed or overridden during processing or shipping.
stateStringFalseNoThe state or province part of the address, used in addressing to specify the regional administrative division within a country.

Return to Top

itemgroup 

NameTypeReadOnlyReferencesFilterOnlyDescription
availabletopartnersBooleanFalseNoIndicates whether this item group is available to partners for viewing and selection in the NetSuite system.
classStringFalseNoRepresents the classification assigned to this item group, used for categorization and reporting.
createddateDatetimeFalseNoThe date and time when this item group record was created in NetSuite.
customformStringFalseNoThe custom form associated with this item group, determining the layout and fields displayed in NetSuite.
departmentStringFalseNoSpecifies the department associated with this item group, which helps in financial segmentation and reporting.
descriptionStringFalseNoA detailed description of the item group, providing insights into its purpose and contents.
displaynameStringFalseNoThe name of the item group as displayed in NetSuite user interfaces and reports.
externalidStringFalseNoA unique identifier assigned to this item group by an external system, allowing integration with third-party applications.
includechildrenBooleanFalseNoIndicates whether child items under this item group should be included in relevant calculations, searches, and reports.
includestartendlinesBooleanFalseNoDetermines whether start and end lines are included when processing this item group in transactions and reporting.
isinactiveBooleanFalseNoIndicates whether this item group is inactive and should be excluded from selection in transactions and lists.
issueproductStringFalseNoSpecifies the product that is issued or linked when this item group is referenced in a transaction.
isvsoebundleBooleanFalseNoIndicates whether this item group is a Vendor-Specific Objective Evidence (VSOE) bundle, which affects revenue recognition rules.
itemidStringFalseNoThe internal identifier or SKU assigned to this item group for reference within NetSuite.
itemtypeStringFalseNoDefines the type of item group, distinguishing it from individual inventory items and other item categories.
lastmodifieddateDatetimeFalseNoThe date and time when this item group record was last updated in NetSuite.
locationStringFalseNoSpecifies the default location associated with this item group for inventory tracking and fulfillment purposes.
parentStringFalseNoIndicates the parent item group under which this item group is categorized in a hierarchical structure.
printitemsBooleanFalseNoDetermines whether the individual items within this item group should be printed on transaction forms, such as invoices and packing slips.
subsidiaryStringFalseNoSpecifies the subsidiary to which this item group belongs, ensuring proper financial segmentation in multi-entity organizations.
upccodeStringFalseNoThe Universal Product Code (UPC) associated with this item group, used for barcode scanning and inventory identification.
vendornameStringFalseNoThe name of the vendor associated with this item group, typically used in procurement and supply chain management.

Return to Top

itemGroupMember 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier assigned to each record in the item group membership table.
itemStringFalseNoThe specific item that is part of the item group, identified by its unique item name or code.
linenumberIntegerFalseNoA sequential identifier representing the line number of the item within the group, ensuring order and uniqueness within the context of the group.
parentitemStringFalseNoThe parent item to which this item belongs, indicating its membership within a predefined item group structure.
quantityDoubleFalseNoThe number of units of the item included in the group, representing the default quantity assigned when the group is used in transactions.

Return to Top

itemGroupSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoRepresents the unique identifier or name of the item, used to associate the item with subsidiaries in the mapping process.

Return to Top

itemGroupTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe unique identifier or name of the item within the system, typically used for internal reference and categorization.
displaynameStringFalseNoThe name of the item as it is displayed to users in various interfaces, including online stores and reports.
languageStringFalseNoThe specific language used for translating the item-related information, ensuring localization for different markets.
nopricemessageStringFalseNoA message displayed when an item does not have a price available, informing users of its status or pricing conditions.
outofstockmessageStringFalseNoA message displayed when the item is out of stock, informing users about its unavailability or potential restocking timeframe.
pagetitleStringFalseNoThe title displayed on the web page for the item, often used for SEO purposes to improve search engine visibility.
salesdescriptionStringFalseNoA brief, marketing-focused description of the item used in sales channels, emphasizing key features and benefits.
storedescriptionStringFalseNoA description of the item as it appears in an online store, providing customers with relevant product details.
featureddescriptionStringFalseNoA highlighted description of the item used for promotional purposes or special listings within the store.
specialsdescriptionStringFalseNoA description specifically used to promote special offers, discounts, or limited-time deals associated with the item.
storedisplaynameStringFalseNoThe name of the item as displayed in the store, ensuring a customer-friendly and market-appropriate presentation.
storedetaileddescriptionStringFalseNoA comprehensive and detailed description of the item, providing in-depth information to help customers make informed purchasing decisions.

Return to Top

itemlocationconfiguration 

NameTypeReadOnlyReferencesFilterOnlyDescription
advancewarningthresholdIntegerFalseNoSpecifies the threshold value for advance warning notifications related to inventory levels or order processing.
atpleadtimeIntegerFalseNoRepresents the lead time used in Available to Promise (ATP) calculations, determining how long it takes an item to be available for fulfillment.
backwardconsumptiondaysIntegerFalseNoDefines the number of days before the current date within which demand consumption is backtracked for planning purposes.
buildtimeDoubleFalseNoIndicates the time required to assemble or manufacture an item, measured in days or another relevant unit.
costDecimalFalseNoRepresents the monetary value associated with producing, purchasing, or holding an item in inventory.
costinglotsizeDoubleFalseNoDetermines the standard lot size used in cost calculations for inventory valuation and financial reporting.
customformStringFalseNoIdentifies the custom form associated with the item-location configuration, which can influence UI display and data entry options.
defaultreturncostDecimalFalseNoSpecifies the default cost applied when an item is returned, often used in Return Merchandise Authorization (RMA) processes.
demandsourceStringFalseNoIndicates the origin of demand for the item at this location, such as sales orders, work orders, or transfer orders.
demandtimefenceIntegerFalseNoSets the time fence for considering demand signals, preventing short-term fluctuations from disrupting planning.
externalidStringFalseNoStores an external identifier that can be used for integrations or cross-referencing with other systems.
fixedlotsizeStringFalseNoDefines a fixed quantity for lot-sizing purposes, ensuring consistent order or production batch sizes.
forwardconsumptiondaysIntegerFalseNoSpecifies the number of days ahead of the current date within which demand consumption is forecasted for planning purposes.
idIntegerFalseNoA unique identifier for the item-location configuration record, ensuring each entry is uniquely distinguishable from others.
inventorycosttemplateStringFalseNoReferences the cost template used for inventory valuation, impacting how costs are applied to this item at the given location.
invtclassificationStringFalseNoCategorizes the inventory based on predefined classifications, such as high-turnover or slow-moving items.
invtcountintervalStringFalseNoDefines the frequency at which inventory counts should be conducted for this item at the specified location.
isautolocassignmentallowedBooleanFalseNoIndicates whether automatic location assignment is permitted when fulfilling orders or receiving inventory.
isautolocassignmentsuspendedBooleanFalseNoSpecifies whether automatic location assignment is temporarily suspended, preventing system-driven location selection.
iswipBooleanFalseNoDenotes whether the item is considered Work In Progress (WIP), meaning it is in the process of being manufactured but not yet completed.
itemStringFalseNoSpecifies the item associated with this configuration, linking to the item master record.
latedemandthresholdDoubleFalseNoDefines the acceptable threshold for late demand fulfillment before triggering alerts or rescheduling actions.
leadtimeIntegerFalseNoIndicates the time required to replenish inventory, from order placement to item availability at the specified location.
locationStringFalseNoRepresents the physical or logical location where this configuration applies, such as a warehouse or store.
locationallowstorepickupBooleanFalseNoDetermines whether this location allows customers to pick up items in-store as part of the fulfillment process.
locationstorepickupbufferstockIntegerFalseNoSpecifies the buffer stock level maintained at the location to support store pickup orders and prevent stockouts.
memoStringFalseNoA free-text field for notes or additional details about the item-location configuration.
minimumrescheduledaysIntegerFalseNoDefines the minimum number of days before a scheduled order can be rescheduled, preventing frequent last-minute changes.
nameStringFalseNoThe name or label associated with this item-location configuration record, used for identification.
nextinvtcountdateDateFalseNoIndicates the next scheduled inventory count date for the item at the specified location.
pastdueforecastdaysIntegerFalseNoDetermines the number of past due days to consider when forecasting demand, ensuring overdue orders are factored in.
periodiclotsizedaysIntegerFalseNoDefines the interval in days for periodic lot sizing, determining when batch orders should be placed.
periodiclotsizetypeStringFalseNoSpecifies the type of periodic lot sizing strategy applied, such as fixed interval or variable interval ordering.
poreceiptcostDecimalFalseNoRepresents the cost assigned to inventory received via purchase orders, impacting cost accounting and valuation.
preferredstocklevelDoubleFalseNoSpecifies the optimal stock level to maintain at the location, helping to avoid shortages and excess inventory.
reorderpointDoubleFalseNoDefines the inventory level at which a reorder should be triggered to replenish stock before running out.
rescheduleindaysIntegerFalseNoSpecifies the number of days by which an inbound supply order can be rescheduled earlier based on demand changes.
rescheduleoutdaysIntegerFalseNoIndicates the number of days an inbound supply order can be postponed to better align with inventory needs.
safetystocklevelDoubleFalseNoRepresents the buffer stock maintained to mitigate demand fluctuations and supply chain disruptions.
savedleadtimeIntegerFalseNoStores the previously calculated lead time value for reference in supply chain planning and adjustments.
savedpreferredstocklevelDoubleFalseNoHolds the last recorded preferred stock level before updates, useful for historical comparison.
savedreorderpointDoubleFalseNoMaintains the previous reorder point value before any modifications, aiding in tracking adjustments.
subsidiaryStringFalseNoSpecifies the business subsidiary that owns or manages this item-location configuration.
supplylotsizingmethodStringFalseNoDefines the method used to determine lot sizes for supply orders, such as fixed lot size or economic order quantity.
supplytimefenceIntegerFalseNoSets the time boundary for supply planning, restricting last-minute changes to incoming supply orders.
supplytypeStringFalseNoIndicates the type of supply for the item at this location, such as purchased, manufactured, or transferred.
templatestoredBooleanFalseNoSpecifies whether this configuration is stored as a template for use in future item-location setups.

Return to Top

itemMember 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the item member entry, assigned automatically by NetSuite.
bomquantityDecimalFalseNoThe quantity of the component item required in the bill of materials (BOM) to manufacture the parent item.
componentyieldDoubleFalseNoRepresents the expected yield percentage of the component item in production, accounting for potential losses or inefficiencies.
effectivedateDateFalseNoThe date when the component item becomes effective in the bill of materials, determining when it can be used in production.
effectiverevisionStringFalseNoThe specific revision of the bill of materials that applies from the effective date onward, ensuring version control in production processes.
itemStringFalseNoThe identifier or name of the component item included in the bill of materials.
itemsourceStringFalseNoIndicates the source of the item, such as whether it is purchased externally, manufactured in-house, or transferred from another location.
linenumberIntegerFalseNoA sequential number that identifies the position of the component within the bill of materials for easy reference.
obsoletedateDateFalseNoThe date when the component item is no longer valid for use in the bill of materials, typically due to replacement or discontinuation.
obsoleterevisionStringFalseNoThe revision of the bill of materials that marks the obsolescence of the component item, ensuring accurate tracking of changes.
parentitemStringFalseNoThe parent item to which the component belongs, indicating its role in the assembly or production process.
quantityDoubleFalseNoThe total number of component units required per unit of the parent item in the bill of materials.

Return to Top

ItemPeriodicLotSizeType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoUnique internal identifier for the record, used as a primary key within NetSuite to track and reference the specific item periodic lot size type.

Return to Top

itemPresentationItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
basepriceDecimalFalseNoThe standard selling price of the item before any discounts, promotions, or customer-specific pricing adjustments are applied.
descriptionStringFalseNoA detailed textual representation of the item, providing key product attributes and differentiating features.
onlinepriceDecimalFalseNoThe price at which the item is sold through online channels, which can differ from the base price due to e-commerce pricing strategies.
presentationitemStringFalseNoAn associated item commonly displayed alongside the primary item to encourage upselling or bundling opportunities.
presitemidIntegerFalseNoThe unique internal identifier assigned to the related item for tracking and database reference purposes.
superitemStringFalseNoIndicates a higher-level grouping or categorization for this item, potentially used for product families, collections, or parent-child item relationships.

Return to Top

itemPrice 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencypageStringFalseNoThe currency associated with this pricing record, determining which currency the price is displayed and calculated in.
discountdisplayDoubleFalseNoThe default discount percentage applied to this item price, reflecting any standard discount agreements.
isinactiveBooleanFalseNoIndicates whether this pricing record is inactive. If true, the price is not currently in use.
itemStringFalseNoThe identifier or name of the item for which this pricing record applies, linking to the corresponding product or service.
priceDecimalFalseNoThe specific monetary amount set for the item in this pricing record, based on the associated currency.

Return to Top

itempricing 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique internal identifier for the item pricing record, used to track and reference specific entries in NetSuite.
calculatequantitydiscountsStringFalseNoIndicates if quantity discounts should be automatically applied for this item. A value of 'true' enables discounts based on quantity thresholds.
externalidStringFalseNoAn optional identifier that can be used to reference this record externally, often for integration purposes with other systems.
inputusingStringFalseNoSpecifies the method or format used to input the pricing information for this item, which can vary depending on business processes or integration settings.
lineidIntegerFalseNoA unique identifier for each line in the item pricing record, used to differentiate between multiple price points or discount levels for a given item.
transactionidIntegerFalseNoThe identifier associated with the transaction linked to this item pricing record, providing context on where the pricing details apply.
vendorIntegerFalseNoThe internal identifier of the vendor associated with this pricing record, indicating the supplier providing the item or pricing details.

Return to Top

ItemPricingDiscount 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique identifier for the item pricing discount entry. This serves as the primary key for referencing the discount record.
fromquantityDoubleFalseNoMinimum quantity required for the discount to apply. This defines the threshold at which the discount starts.
itempricingIntegerFalseNoReference to the item pricing record associated with this discount. This links the discount to a specific item pricing structure.
itempricingrecordStringFalseNoIdentifier for the item pricing record, providing additional details about the pricing configuration applied to the item.
memoStringFalseNoOptional field for storing notes or additional information about this discount entry. This can include internal comments or explanations.
percentDoubleFalseNoThe percentage discount applied when the quantity threshold is met. This value determines the reduction applied to the standard price.
quantityorderedDoubleFalseNoThe actual quantity of items ordered that is eligible for this discount is used to determine if the discount criteria are met.

Return to Top

itemprocessfamily 

NameTypeReadOnlyReferencesFilterOnlyDescription
customformStringFalseNoThe internal ID of the custom form used for this item process family, determining the layout and fields available when interacting with records in NetSuite.
descriptionStringFalseNoA detailed explanation or summary of the item process family, providing context about how this family is used within NetSuite.
externalidStringFalseNoA unique identifier assigned to this item process family for external system integration, allowing seamless synchronization with external applications.
isinactiveBooleanFalseNoIndicates whether this item process family is active or inactive. If set to 'true', the record is deactivated and not available for selection in NetSuite.
nameStringFalseNoThe name or identifier assigned to this item process family, helping users differentiate between different process families.

Return to Top

itemprocessgroup 

NameTypeReadOnlyReferencesFilterOnlyDescription
customformStringFalseNoSpecifies the custom form associated with the item process group, detailing the layout and fields displayed when managing the group in NetSuite.
descriptionStringFalseNoA detailed description of the item process group, providing context on its purpose and how it is used within inventory or manufacturing workflows.
externalidStringFalseNoA unique external identifier for the item process group, often used for integration with external systems or data synchronization.
isinactiveBooleanFalseNoIndicates whether the item process group is inactive. If set to 'true', the group is no longer in use but remains in the system for historical reference.
nameStringFalseNoThe name of the item process group, serving as its primary identifier within NetSuite. This should be a clear and meaningful name for easy reference.

Return to Top

itemQuantity 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe unique identifier or name of the item in inventory, which can refer to a product, material, or SKU being tracked in NetSuite.
maxcountIntegerFalseNoThe upper threshold for the quantity of the item that should be maintained in stock, used for inventory management and restocking decisions.
mincountIntegerFalseNoThe lower threshold for the quantity of the item that should be maintained in stock, triggering reorder points to prevent stockouts.

Return to Top

itemQuantityPricingDiscount 

NameTypeReadOnlyReferencesFilterOnlyDescription
leveldiscountDoubleFalseNoThe discount percentage or amount applied at a specific quantity tier for an item. This value determines the reduction in price for bulk purchases.
levelpricenameStringFalseNoThe name of the price level associated with the quantity-based discount, allowing for differentiated pricing structures based on customer type or sales strategy.
parentitemStringFalseNoThe identifier of the item to which the quantity-based pricing discount applies, linking the discount details to a specific product or service in the NetSuite inventory.

Return to Top

itemQuantityPricingLevel 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoRepresents the specific item for which quantity-based pricing is applied, determining the applicable discount tier.
leveldiscountDoubleFalseNoIndicates the discount percentage based on quantity purchased, reflecting the reduction from the standard price.

Return to Top

itemreceipt 

NameTypeReadOnlyReferencesFilterOnlyDescription
classStringFalseNoRepresents the classification category associated with the item receipt, which is often used for financial reporting and segmentation.
createddateDatetimeFalseNoThe date and time when the item receipt was initially created in the system, providing a historical reference for tracking.
createdfromStringFalseNoThe source transaction or document from which this item receipt was generated, such as a purchase order or transfer order.
currencyStringFalseNoThe three-letter ISO currency code used for this transaction, indicating the currency in which the amounts are recorded.
currencynameStringFalseNoThe full name of the currency associated with the transaction, aiding in better readability in reports and forms.
currencysymbolStringFalseNoThe symbolic representation of the currency (for example, $, €, ¥) used in the transaction, facilitating quick identification.
customformStringFalseNoThe custom form template applied to this item receipt, defining the layout and fields visible in the user interface.
departmentStringFalseNoThe department associated with the item receipt, which helps in expense allocation and department-specific reporting.
entityStringFalseNoThe vendor or other business entity related to this item receipt, typically referring to the supplier of the received goods.
exchangerateDecimalFalseNoThe exchange rate applied to this transaction, converting foreign currency values into the base currency of the organization.
externalidStringFalseNoA unique identifier assigned externally, often used for integrating with third-party systems or for tracking outside NetSuite.
inboundshipmentStringFalseNoA reference to an inbound shipment record linked to this item receipt, providing visibility into received goods from shipments.
isbasecurrencyBooleanFalseNoIndicates whether the transaction is recorded in the base currency of the company, with TRUE meaning it is in base currency.
itemfulfillmentStringFalseNoLinks to an item fulfillment record, representing the fulfillment of sales orders related to the received items.
landedcostperlineBooleanFalseNoSpecifies whether landed costs (such as freight, duties, and taxes) are allocated per individual line item in the receipt.
lastmodifieddateDatetimeFalseNoThe date and time when the item receipt was last updated, providing insight into recent modifications.
locationStringFalseNoThe physical or virtual location where the received items are stored or processed, aiding in inventory tracking.
memoStringFalseNoA free-text field allowing users to enter notes or additional details about this item receipt for internal reference.
postingperiodStringFalseNoThe accounting period in which this transaction is recorded, ensuring proper financial period alignment.
subsidiaryStringFalseNoThe subsidiary entity under which this transaction is recorded, relevant in multi-subsidiary organizations.
trandateDateFalseNoThe official transaction date of the item receipt, typically representing when the goods were received.
tranidStringFalseNoA unique identifier automatically assigned by NetSuite for tracking this item receipt within the system.

Return to Top

itemrevision 

NameTypeReadOnlyReferencesFilterOnlyDescription
effectivedateDateFalseNoThe date when this item revision becomes effective in NetSuite, determining when it can be used in transactions and planning.
externalidStringFalseNoA unique identifier for the item revision that is set externally, often used for integrations and data synchronization with external systems.
inactiveBooleanFalseNoIndicates whether this item revision is inactive. If set to 'true', the revision is no longer available for use in transactions or planning.
itemStringFalseNoThe associated item for this revision, linking the revision to a specific product or inventory item in NetSuite.
memoStringFalseNoA free-text field that allows users to add notes or additional details about this item revision for reference purposes.
nameStringFalseNoThe name assigned to the item revision, typically used for identification and reference within NetSuite.
obsoletedateDateFalseNoThe date when this item revision is considered obsolete, meaning it should no longer be used in transactions or planning.

Return to Top

ItemSegmentIncludingSyntheticInclsynthitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoRepresents a unique identifier or name for an item within the NetSuite system,linking inventory, sales, and purchasing records to specific items.

Return to Top

ItemSegmentItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoRepresents the unique identifier or name of the item within the NetSuite database, which is used to reference specific inventory, non-inventory, or service items in transactions and reports.

Return to Top

ItemSegmentType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier for the item segment type, which is used to distinguish different segment types within NetSuite's item classification system.

Return to Top

itemSiteCategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
categorydescriptionStringFalseNoA detailed textual description of the item category, providing context for classification within the system.
isdefaultBooleanFalseNoIndicates whether this category is the preferred or default category for the item. If set to 'true,' this category is automatically selected.
itemStringFalseNoThe unique identifier or name of the item associated with this category. This value links the item to its respective category.
websiteStringFalseNoThe website or e-commerce platform where this category is used to organize and display items for online browsing and sales.

Return to Top

ItemSource 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier used to distinguish each record in the ItemSource table, serving as a primary reference for linking related data across the system.

Return to Top

itemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoRepresents the unique identifier or name of an item in the system, which can include a SKU, product name, or another reference to track inventory, products, or services.

Return to Top

ItemSubtype 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier for item subtypes, used to distinguish between different categories in transactions, reporting, and system integrations.

Return to Top

ItemSupplyLotSizingType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoThe unique internal identifier assigned to each record is used for referencing and managing lot sizing types associated with item supply in NetSuite.

Return to Top

itemsupplyplan 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the supply plan record within NetSuite is used for tracking and referencing specific supply plans.
externalidStringFalseNoExternal identifier assigned to the supply plan record often used for integrations with external systems and allows cross-platform tracking.
itemStringFalseNoThe item associated with the supply plan, referring to a specific product or inventory unit that is being planned for supply and demand fulfillment.
locationStringFalseNoThe designated location where the supply plan is applied, representing warehouses, stores, or other inventory storage and distribution sites.
memoStringFalseNoA free-text field for adding notes or additional context related to the supply plan, which can include planning rationale, changes, or other relevant details.
subsidiaryStringFalseNoThe subsidiary linked to the supply plan is essential for financial tracking in NetSuite, where subsidiaries are distinct business entities within the company's structure.

Return to Top

ItemSupplyPlanOrder 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemsupplyplanStringFalseNoRepresents the supply plan associated with a specific item, detailing the planned orders, expected inventory levels, and replenishment schedules.
ordercreatedBooleanFalseNoIndicates whether an order has been successfully created in the system. A value of 'true' means the order exists, while 'false' means it has not been generated.
orderdateDateFalseNoThe date when the order was created or scheduled. This helps track when supply chain actions are initiated.
ordernumberStringFalseNoA unique identifier assigned to the order, which can be used for tracking and referencing within the system.
ordertypeStringFalseNoSpecifies the type of order being processed, such as purchase order, transfer order, or work order, to distinguish different supply chain transactions.
quantityDoubleFalseNoThe total number of units associated with this order, reflecting the planned or actual supply volume.
receiptdateDateFalseNoThe expected or actual date when the order is scheduled to be received into inventory, helping with supply chain and demand planning.

Return to Top

ItemSupplyPlanPlanningmessage 

NameTypeReadOnlyReferencesFilterOnlyDescription
creationdateDateFalseNoThe date when the item supply plan was created, which helps track when the supply plan record was first generated.
itemsupplyplanStringFalseNoA reference to the specific item supply plan being evaluated, identifying the plan associated with the message.
messageStringFalseNoA detailed message providing insights or warnings related to the supply plan. This can include scheduling conflicts, stock level alerts, or recommendations.
messagecodeIntegerFalseNoA numerical code representing the type of message related to the supply plan, categorizing different types of supply plan messages.
quantityDoubleFalseNoThe quantity of items affected by the supply plan message, indicating the number of units involved in the order or inventory adjustment.
receiptdateDateFalseNoThe expected date when the inventory or order is scheduled to be received, which is critical for tracking supply chain timelines.
transactionidStringFalseNoThe unique identifier of the transaction associated with the supply plan, linking the message to a specific order or movement of goods.

Return to Top

ItemSupplyType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoThe internal identifier for the item supply type is automatically generated and cannot be modified manually, serving as a reference to the specific supply type record.

Return to Top

itemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe unique identifier for the item being translated, corresponding to the item's internal ID in NetSuite.
displaynameStringFalseNoThe localized name displayed for the item in the specified language is often used in store listings and catalogs.
languageStringFalseNoThe translated item record in NetSuite supports multiple languages, helping to manage product information for global markets.
nopricemessageStringFalseNoA custom message displayed when no price is available for the item in the given language, which is useful for restricted items or those requiring a quote.
outofstockmessageStringFalseNoThe localized message shown when the item is out of stock, managing customer expectations by providing alternative options or restock information.
pagetitleStringFalseNoThe translated title of the item used for SEO and displayed in the browser title bar when viewing the item’s product page.
salesdescriptionStringFalseNoThe detailed sales-oriented description of the item in the specified language is often used in quotes, invoices, and sales orders.
storedescriptionStringFalseNoA brief product description intended for use in online stores, providing essential details about the item in the specified language.
featureddescriptionStringFalseNoA highlighted or promotional description of the item, translated for the specific locale, typically used in special promotions or featured item listings.
specialsdescriptionStringFalseNoA short, translated description used for promotional or special offer sections of the store, drawing attention to discounts or limited-time deals.
storedisplaynameStringFalseNoThe localized name displayed for the item within the store interface, helping customers identify the product in their preferred language.
storedetaileddescriptionStringFalseNoA rich, fully translated description containing in-depth information about the product, often including specifications, usage details, and benefits.

Return to Top

itemType 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoA system-generated unique identifier assigned to each item type in NetSuite, used for programmatically referencing records.
idStringFalseNoThe external identifier for the item type, often used for integration purposes or custom scripting within NetSuite.
nameStringFalseNoThe descriptive name of the item type, providing a human-readable label for categorization and reporting.

Return to Top

ItemUnit 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoThe key column represents a unique identifier for each record within the table, distinguishing between different entries and is commonly used as the primary key to ensure data integrity.

Return to Top

itemVendor 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe unique identifier or name of the inventory item associated with a vendor.
preferredvendorBooleanFalseNoIndicates whether this vendor is the preferred supplier for the given item.
purchasepriceStringFalseNoThe cost at which the item is purchased from the vendor, typically set in the vendor's currency.
scheduleStringFalseNoThe purchasing schedule or agreement linked to the vendor for this item, which can include reorder frequencies or contract terms.
subsidiaryStringFalseNoThe specific subsidiary within the organization that is associated with the vendor-item relationship.
vendorStringFalseNoThe supplier providing the item, identified by name or unique vendor ID.
vendorcodeStringFalseNoA unique code assigned to the vendor for reference in procurement and inventory systems.
vendorcostenteredDecimalFalseNoThe cost of the item as entered into the system, reflecting the price set by the vendor before any adjustments or conversions.
vendorcurrencyidStringFalseNoThe currency in which the vendor's pricing is denominated, identified by its currency code (for example, USD, EUR, and GBP).

Return to Top

job 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the job record.
accountnumberStringFalseNoAccount associated with the job, typically a customer or company.
actualtimeDoubleFalseNoTotal actual work hours recorded for the job.
allowallresourcesfortasksBooleanFalseNoIndicates whether all resources can be assigned to project tasks.
allowexpensesBooleanFalseNoSpecifies whether expense tracking is enabled for the job.
allowtimeBooleanFalseNoSpecifies whether time tracking is allowed for this job.
alternatecontactStringFalseNoSecondary contact person associated with the job.
altnameStringFalseNoProject name or alternative name for the job.
billingscheduleStringFalseNoDefines the billing schedule used for invoicing this job.
calculatedenddateDateFalseNoSystem-calculated expected completion date for the job.
calculatedenddatebaselineDateFalseNoBaseline value for the system-calculated completion date.
categoryStringFalseNoCategory or classification assigned to the job.
commentsStringFalseNoAdditional notes or remarks related to the job.
companynameStringFalseNoName of the company or entity associated with the job.
contactStringFalseNoPrimary contact person for the job.
contactlistStringFalseNoList of contacts associated with this job.
currencyStringFalseNoCurrency in which financials for the job are tracked.
currencyprecisionIntegerFalseNoNumber of decimal places used for currency values in this job.
customerStringFalseNoCustomer linked to the job.
datecreatedDateFalseNoDate when the job record was created.
defaultbillingaddressStringFalseNoPrimary billing address associated with the job.
defaultshippingaddressStringFalseNoPrimary shipping address associated with the job.
enddateDateFalseNoActual date the job was completed.
entityidStringFalseNoUnique identifier for the job within the system.
entitynumberIntegerFalseNoSystem-generated number for the job record.
entitystatusStringFalseNoCurrent status of the job, such as 'In Progress' or 'Completed'.
entitytitleStringFalseNoProject identifier or reference name for the job.
estimatedcostDecimalFalseNoProjected total cost required to complete the job.
estimatedgrossprofitDecimalFalseNoEstimated gross profit expected from the job.
estimatedgrossprofitpercentDoubleFalseNoPercentage of estimated gross profit relative to revenue.
estimatedlaborcostDecimalFalseNoExpected labor cost for completing the job.
estimatedlaborcostbaselineDecimalFalseNoBaseline estimate of labor costs for the job.
estimatedlaborrevenueDecimalFalseNoProjected revenue generated from labor costs.
estimatedrevenueDecimalFalseNoExpected total revenue from the job.
estimatedtimeDoubleFalseNoInitial estimated hours required for the job.
estimatedtimeoverrideDoubleFalseNoUpdated estimated work hours based on adjustments.
estimatedtimeoverridebaselineDoubleFalseNoBaseline value for adjusted estimated work hours.
externalidStringFalseNoUnique identifier for external integrations or references.
forecastchargerunondemandBooleanFalseNoSpecifies whether forecast charges can be run on demand.
fxrateDecimalFalseNoExchange rate applicable to currency values in this job.
includecrmtasksintotalsBooleanFalseNoIndicates whether CRM task values should be included in job totals.
isexempttimeBooleanFalseNoMarks time entries for this job as exempt from standard tracking.
isinactiveBooleanFalseNoIndicates whether the job record is inactive.
isproductivetimeBooleanFalseNoMarks recorded time as productive work hours.
isutilizedtimeBooleanFalseNoClassifies tracked time as utilized work hours.
jobbillingtypeStringFalseNoDefines how the job is billed, such as 'Fixed Price' or 'Time & Materials'.
jobitemStringFalseNoItem or service linked to job billing.
jobpriceDecimalFalseNoPrice assigned to the job, typically for billing purposes.
jobtypeStringFalseNoClassification of the job, such as 'Internal' or 'External'.
lastbaselinedateDateFalseNoDate when the last baseline for this job was set.
lastmodifieddateDateFalseNoLast recorded modification date of the job record.
limittimetoassigneesBooleanFalseNoRestricts time and expense tracking to assigned resources only.
materializetimeBooleanFalseNoEnables automatic creation of planned time entries.
parentStringFalseNoParent record to which this job is linked, if applicable.
percentcompleteDoubleFalseNoPercentage of revenue recognition override completion.
percenttimecompleteDoubleFalseNoPercentage of work completed based on recorded time.
primarycontactStringFalseNoMain point of contact for the job.
projectedenddateDateFalseNoEstimated completion date based on current progress.
projectedenddatebaselineDateFalseNoBaseline projected end date for tracking deviations.
projectmanagerStringFalseNoPerson responsible for managing the job.
startdateDateFalseNoOfficial start date of the job.
startdatebaselineDateFalseNoBaseline start date recorded for tracking changes.
timeapprovalStringFalseNoApproval process required for time entries related to this job.
timeremainingDoubleFalseNoEstimated remaining work hours needed to complete the job.

Return to Top

jobAddressbook 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoUnique internal identifier for the address book entry.
addressbookaddressStringFalseNoFull address details associated with the record, including street, city, state, postal code, and country.
defaultbillingBooleanFalseNoIndicates whether this address is the default billing address for the entity.
defaultshippingBooleanFalseNoIndicates whether this address is the default shipping address for the entity.
entityStringFalseNoThe associated entity (customer, vendor, or partner) for this address record.
labelStringFalseNoA user-defined label for the address, helping distinguish it from others.

Return to Top

jobAddressbookEntityAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoUnique key identifying the address record within the entity's address book.
addr1StringFalseNoPrimary street address, typically including building number and street name.
addr2StringFalseNoSecondary address line, often used for apartment, suite, or unit details.
addr3StringFalseNoAdditional address line for extended location details if necessary.
addresseeStringFalseNoThe name of the recipient or organization associated with the address.
attentionStringFalseNoA designated contact person at the specified address for correspondence.
cityStringFalseNoThe city where the address is located.
countryStringFalseNoThe country associated with the address.
dropdownstateStringFalseNoState or province selected from a predefined dropdown list.
overrideBooleanFalseNoIndicates whether custom address details override system-generated values.
stateStringFalseNoState or province where the address is located.

Return to Top

jobBulkMerge 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoThe entity involved in the bulk merge process, such as a customer or vendor.
mergedateDateFalseNoThe date and time when the bulk merge operation was executed.
mergetypeStringFalseNoSpecifies the type of bulk merge operation performed.
statusStringFalseNoThe current status of the bulk merge process, such as pending, completed, or failed.
subjectStringFalseNoThe subject or title associated with the bulk merge operation.
templateStringFalseNoThe template used for the bulk merge process, defining the format and content of the merged data.
usernameStringFalseNoThe user who initiated or executed the bulk merge operation.

Return to Top

jobCompanyContact 

NameTypeReadOnlyReferencesFilterOnlyDescription
contactStringFalseNoThe associated contact person or entity linked to the company record.

Return to Top

JobRequisitionPostingType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoUnique identifier for the job requisition posting type. This serves as the primary key for the table.

Return to Top

JobRequisitionStatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoUnique identifier for the job requisition status. This serves as the primary key for the table.

Return to Top

jobResourceJobResourceMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
jobresourceStringFalseNoIdentifier for the job resource associated with this mapping.

Return to Top

JobResourceRole 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the job resource role.
descriptionStringFalseNoDetailed description of the job resource role.
isinactiveBooleanFalseNoIndicates whether the role is inactive.
nameStringFalseNoName of the job resource role.
owntimeapprovalBooleanFalseNoSpecifies whether users in this role can approve their own time entries.
projecttimeapproverBooleanFalseNoIndicates whether users in this role can approve project-related time entries.
reassignresourcesBooleanFalseNoAllows bulk reassignment of task assignments to different resources.

Return to Top

jobResources 

NameTypeReadOnlyReferencesFilterOnlyDescription
jobresourceStringFalseNoName of the job resource assigned to a project.
projectStringFalseNoAssociated job or project the resource is allocated to.

Return to Top

jobstatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the job status.
descriptionStringFalseNoDetailed description of the job status.
externalidStringFalseNoExternal identifier used for integrations or external systems.
isinactiveBooleanFalseNoIndicates whether the job status is inactive.

Return to Top

jobtype 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the job type.
externalidStringFalseNoExternal identifier used for integrations or external systems.
isinactiveBooleanFalseNoIndicates whether the job type is inactive.
nameStringFalseNoName of the job type.

Return to Top

journalentry 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoAccounting book associated with the journal entry.
approvalstatusStringFalseNoCurrent approval status of the journal entry.
approvedBooleanFalseNoIndicates whether the journal entry has been approved.
classStringFalseNoClassification category for reporting and tracking purposes.
createddateDatetimeFalseNoTimestamp indicating when the journal entry was created.
createdfromStringFalseNoReference to the transaction or record that originated this journal entry.
credittotalDecimalFalseNoTotal credit amount in the journal entry.
currencyStringFalseNoCurrency used in the journal entry.
customformStringFalseNoCustom form template applied to this journal entry.
debittotalDecimalFalseNoTotal debit amount in the journal entry.
departmentStringFalseNoDepartment associated with this journal entry.
entitynexusStringFalseNoNexus entity related to the journal entry for tax purposes.
exchangerateDecimalFalseNoExchange rate applied for currency conversion in this journal entry.
expenseallocjournalcountStringFalseNoNumber of expense allocation journal entries associated.
externalidStringFalseNoExternal identifier used for integrations or external systems.
isbasecurrencyBooleanFalseNoIndicates whether the journal entry is in the base currency of the company.
isreversalStringFalseNoSpecifies whether the journal entry is a reversal entry.
lastmodifieddateDatetimeFalseNoTimestamp of the last modification made to this journal entry.
memoStringFalseNoMemo or note providing additional details about the journal entry.
nextapproverStringFalseNoNext person or role responsible for approving the journal entry.
nexusStringFalseNoTax nexus related to the journal entry.
parentexpenseallocStringFalseNoReference to the parent expense allocation record, if applicable.
postingperiodStringFalseNoAccounting period in which the journal entry is posted.
reversaldateDateFalseNoDate on which the reversal of this journal entry is scheduled.
reversaldeferBooleanFalseNoIndicates whether the reversal should be deferred.
statusStringFalseNoCurrent processing status of the journal entry.
subsidiaryStringFalseNoSubsidiary associated with this journal entry.
subsidiarytaxregnumStringFalseNoTax registration number of the subsidiary.
taxpointdateDateFalseNoDate used for tax reporting purposes.
taxpointdateoverrideBooleanFalseNoIndicates whether the tax point date was manually overridden.
tosubsidiaryStringFalseNoTarget subsidiary for intercompany transactions, if applicable.
trandateDateFalseNoTransaction date of the journal entry.
tranidStringFalseNoUnique transaction ID for this journal entry.
voidStringFalseNoIndicates whether the journal entry is voided.
voidedStringFalseNoSpecifies whether the journal entry has been fully voided.

Return to Top

kititem 

NameTypeReadOnlyReferencesFilterOnlyDescription
auctionquantityStringFalseNoQuantity available for auction listings.
auctiontypeStringFalseNoType of auction listing (such as fixed price, highest bid).
availabletopartnersBooleanFalseNoIndicates whether the item is available for partners.
billingscheduleStringFalseNoBilling schedule applied to this item.
buyitnowpriceDecimalFalseNoBuy-it-now price for auction listings.
classStringFalseNoClassification category for tracking and reporting.
conditionenabledStringFalseNoSpecifies whether condition-based selling is enabled.
conditionhelpurlStringFalseNoURL for additional information about item conditions.
contingentrevenuehandlingBooleanFalseNoIndicates whether revenue recognition is contingent on fulfillment.
costestimateDecimalFalseNoEstimated cost of the item.
costestimatetypeStringFalseNoMethod used for cost estimation (such as standard, average).
countryofmanufactureStringFalseNoCountry where the item is manufactured.
createddateDatetimeFalseNoTimestamp indicating when the item record was created.
createrevenueplansonStringFalseNoSpecifies when revenue plans are created for this item.
customformStringFalseNoCustom form template used for this item record.
deferredrevenueaccountStringFalseNoAccount used for deferred revenue recognition.
deferrevrecBooleanFalseNoIndicates whether revenue recognition is deferred.
departmentStringFalseNoDepartment associated with this item.
descriptionStringFalseNoDetailed description of the item.
directrevenuepostingBooleanFalseNoIndicates whether revenue is posted directly without deferral.
displayinebaystoreBooleanFalseNoSpecifies whether the item is displayed in the eBay store.
displaynameStringFalseNoPublic-facing name of the item.
dontshowpriceBooleanFalseNoDetermines if the item price is hidden in the store.
ebayhandlingtimeStringFalseNoHandling time before the item is shipped on eBay.
ebayintlinsurancefeeDecimalFalseNoFee for international shipping insurance on eBay.
ebayintlpackagehandlingfeeDecimalFalseNoHandling fee for international shipments on eBay.
ebayintlshipinsuranceStringFalseNoSpecifies international shipping insurance options on eBay.
ebayintlshippingitem1StringFalseNoFirst international shipping method available on eBay.
ebayintlshippingitem2StringFalseNoSecond international shipping method available on eBay.
ebayintlshippingitem3StringFalseNoThird international shipping method available on eBay.
ebayisintlcalculatedrateStringFalseNoIndicates whether international shipping rates are calculated automatically on eBay.
ebayisirregularpackageBooleanFalseNoSpecifies whether the item is considered an irregular package for eBay shipping.
ebayitemdescriptionStringFalseNoDetailed item description for eBay listings.
ebayitemlocdisplayStringFalseNoSpecifies how the item location is displayed on eBay.
ebayitemloczipcodeStringFalseNoZip code of the item’s location for eBay listings.
ebayitemlotsIntegerFalseNoNumber of lots available for the eBay listing.
ebayitemsubtitleStringFalseNoSubtitle displayed for the eBay listing.
ebayitemtitleStringFalseNoTitle of the item listing on eBay.
ebayitemweightamtStringFalseNoWeight of the item for eBay shipping calculations.
ebaylayoutStringFalseNoLayout template applied to the eBay listing.
ebaypackagetypeStringFalseNoType of packaging used for eBay shipments.
ebaypagecounterStringFalseNoCounter tracking the number of page views on eBay.
ebayrelistingoptionStringFalseNoRelisting option selected for the eBay listing.
ebaythemeStringFalseNoTheme used for displaying the item on eBay.
ebaythemegroupStringFalseNoTheme group applied to the eBay listing.
endauctionswhenoutofstockBooleanFalseNoSpecifies whether auctions automatically end when the item is out of stock.
enforceminqtyinternallyBooleanFalseNoIndicates whether a minimum quantity is enforced internally for sales.
excludefromsitemapBooleanFalseNoSpecifies whether the item should be excluded from the sitemap for SEO.
externalidStringFalseNoExternal identifier used for integrations with other systems.
featureddescriptionStringFalseNoHighlighted description used for promotions and featured listings.
froogleproductfeedStringFalseNoCategory or group for submitting the item to Google Shopping (formerly Froogle).
galleryBooleanFalseNoIndicates whether the item is featured in a gallery view.
galleryfeaturedBooleanFalseNoSpecifies whether the item is highlighted as a featured gallery item.
gifttypeexpressshipBooleanFalseNoIndicates whether express shipping is available for gift orders.
gifttypegiftwrapBooleanFalseNoSpecifies whether gift-wrapping options are available.
gifttypeshiptorecipientBooleanFalseNoIndicates whether the item can be shipped directly to the recipient as a gift.
handlingcostDecimalFalseNoAdditional handling cost applied to the item.
handlinggroupStringFalseNoGroup to which this item belongs for handling fee calculations.
imagesgroupStringFalseNoGroup of images associated with the item.
imageslocationStringFalseNoLocation or URL where images of the item are stored.
includechildrenBooleanFalseNoSpecifies whether child items are included in the listing.
incomeaccountStringFalseNoAccount used to record revenue from item sales.
internalidIntegerFalseNoUnique internal identifier assigned to the item.
iscalculatedrateStringFalseNoIndicates whether the shipping rate is calculated dynamically.
isdonationitemBooleanFalseNoSpecifies whether the item is designated as a donation item.
isfulfillableBooleanFalseNoIndicates whether the item can be fulfilled from inventory.
isgcocompliantBooleanFalseNoSpecifies whether the item meets Google Checkout compliance standards.
isinactiveBooleanFalseNoIndicates whether the item is inactive in the system.
isonlineBooleanFalseNoSpecifies whether the item is available for sale online.
issueproductStringFalseNoProduct issued when this item is sold.
itemconditionStringFalseNoCondition of the item (such as new, refurbished, used).
itemhandlingfeeDecimalFalseNoHandling fee applied per unit of this item.
itemidStringFalseNoUnique identifier for the item within the system.
iteminsurancefeeDecimalFalseNoFee for shipping insurance on this item.
itemoptionsStringFalseNoAvailable customization or configuration options for the item.
itemrevenuecategoryStringFalseNoRevenue category associated with this item for financial reporting.
itemshipinsuranceStringFalseNoIndicates whether shipping insurance is available for this item.
itemtypeStringFalseNoType of item (such as inventory, non-inventory, service, kit).
lastmodifieddateDatetimeFalseNoTimestamp indicating the last time the item record was updated.
listimmediateStringFalseNoSpecifies whether the item should be listed immediately after creation.
listingdurationStringFalseNoDuration for which the item listing is active.
listingstartdateDateFalseNoDate when the item listing becomes active.
listingstarttimeStringFalseNoTime when the item listing becomes active.
locationStringFalseNoLocation where the item is stored or fulfilled from.
manufacturerStringFalseNoName of the manufacturer of the item.
manufactureraddr1StringFalseNoFirst line of the manufacturer's address.
manufacturercityStringFalseNoCity where the manufacturer is located.
manufacturerstateStringFalseNoState or region where the manufacturer is located.
manufacturertariffStringFalseNoTariff code applicable to this item for customs and taxation.
manufacturertaxidStringFalseNoTax identification number of the manufacturer.
manufacturerzipStringFalseNoPostal code of the manufacturer's location.
maxdonationamountDecimalFalseNoMaximum amount allowed for donation purchases of this item.
maximumquantityStringFalseNoMaximum quantity allowed per purchase or transaction.
metataghtmlStringFalseNoMeta tag HTML content for SEO purposes.
minimumquantityStringFalseNoMinimum quantity required per purchase.
mossappliesBooleanFalseNoIndicates whether the item is subject to the Mini One Stop Shop (MOSS) VAT scheme.
mpnStringFalseNoManufacturer part number (MPN) assigned to this item.
multmanufactureaddrBooleanFalseNoSpecifies whether multiple manufacturing addresses are associated with this item.
nextagcategoryStringFalseNoCategory assigned to the item for Nextag product listings.
nextagproductfeedStringFalseNoSpecifies whether the item is included in the Nextag product feed.
nopricemessageStringFalseNoMessage displayed when the item price is not shown.
numactivelistingsIntegerFalseNoNumber of active listings available for this item.
numcurrentlylistedIntegerFalseNoNumber of units currently listed for sale.
offersupportBooleanFalseNoIndicates whether customer support is offered for this item.
outofstockbehaviorStringFalseNoDefines how the item behaves when out of stock (such as allow backorders).
outofstockmessageStringFalseNoMessage displayed when the item is out of stock.
overallquantitypricingtypeStringFalseNoPricing type based on overall quantity purchased.
packageheightStringFalseNoHeight of the package for shipping purposes.
packagelengthStringFalseNoLength of the package for shipping purposes.
packagewidthStringFalseNoWidth of the package for shipping purposes.
pagetitleStringFalseNoTitle of the item's product page for SEO and display.
parentStringFalseNoParent item or category associated with this item.
preferencecriterionStringFalseNoPreference criteria for recommending this item.
pricinggroupStringFalseNoPricing group to which the item belongs.
primarycatdisplaynameStringFalseNoDisplay name of the item's primary category.
primarycategoryIntegerFalseNoUnique identifier of the primary category assigned to this item.
printitemsBooleanFalseNoIndicates whether this item is printable.
producerBooleanFalseNoSpecifies whether the item is considered a producer-type item.
productfeedStringFalseNoSpecifies whether the item is included in product feed exports.
quantitypricingscheduleStringFalseNoPricing schedule based on quantity breaks.
refundgivenasStringFalseNoDefines how refunds are issued for this item (such as store credit, cash).
relateditemsdescriptionStringFalseNoDescription of related items that may be purchased together.
reservepriceDecimalFalseNoMinimum price set for auction listings.
returnpolicyStringFalseNoReturn policy associated with this item.
returnpolicydetailsStringFalseNoDetailed terms and conditions of the return policy.
returnshippingpaidbyStringFalseNoIndicates who is responsible for return shipping costs (such as buyer, seller).
returnswithinStringFalseNoTimeframe within which returns are accepted.
revenueallocationgroupStringFalseNoGroup used for revenue allocation purposes.
revenuerecognitionruleStringFalseNoRevenue recognition rule applied to this item.
revrecforecastruleStringFalseNoForecasting rule used for revenue recognition.
revreclassfxaccountStringFalseNoForeign exchange account used for revenue reclassification.
revrecscheduleStringFalseNoRevenue recognition schedule assigned to this item.
schedulebcodeStringFalseNoSchedule B code used for export classification.
schedulebnumberStringFalseNoExport classification number from the Schedule B list.
schedulebquantityStringFalseNoUnit of measure for the Schedule B classification.
searchkeywordsStringFalseNoSearch keywords associated with this item for SEO and internal search.
secondarycatdisplaynameStringFalseNoDisplay name of the item's secondary category.
secondarycategoryIntegerFalseNoUnique identifier of the secondary category assigned to this item.
sellonebayBooleanFalseNoIndicates whether the item is listed for sale on eBay.
shipasiaBooleanFalseNoSpecifies whether the item can be shipped to Asia.
shipaustraliaBooleanFalseNoSpecifies whether the item can be shipped to Australia.
shipcanadaBooleanFalseNoSpecifies whether the item can be shipped to Canada.
shipeuropeBooleanFalseNoSpecifies whether the item can be shipped to Europe.
shipgermanyBooleanFalseNoSpecifies whether the item can be shipped to Germany.
shipindividuallyBooleanFalseNoIndicates whether the item must be shipped separately.
shipjapanBooleanFalseNoSpecifies whether the item can be shipped to Japan.
shipmexicoBooleanFalseNoSpecifies whether the item can be shipped to Mexico.
shipnorthsouthamericaBooleanFalseNoSpecifies whether the item can be shipped to North and South America.
shippackageStringFalseNoPackage type used when shipping this item.
shippingcostDecimalFalseNoCost of shipping the item.
shippingdomesticmethodsgroupStringFalseNoGroup of domestic shipping methods available for this item.
shippingdomgroupStringFalseNoDomestic shipping group assigned to the item.
shippingintlgroupStringFalseNoInternational shipping group assigned to the item.
shippingintlgroup1StringFalseNoFirst group of international shipping methods available.
shippingintlgroup2StringFalseNoSecond group of international shipping methods available.
shippingintlgroup3StringFalseNoThird group of international shipping methods available.
shippingitem1StringFalseNoFirst shipping method available for this item.
shippingitem2StringFalseNoSecond shipping method available for this item.
shippingitem3StringFalseNoThird shipping method available for this item.
shippinglocationsgroupStringFalseNoGroup of locations where the item can be shipped.
shippingpackaginggroupStringFalseNoGroup of packaging options available for shipping.
shippingrate1DecimalFalseNoFirst shipping rate tier for this item.
shippingrate2DecimalFalseNoSecond shipping rate tier for this item.
shippingrate3DecimalFalseNoThird shipping rate tier for this item.
shipukBooleanFalseNoSpecifies whether the item can be shipped to the United Kingdom.
shipworldwideBooleanFalseNoIndicates whether the item can be shipped globally.
shoppingdotcomcategoryStringFalseNoCategory assigned for Shopping.com product listings.
shoppingproductfeedStringFalseNoSpecifies whether the item is included in the Shopping.com product feed.
shopzillacategoryidIntegerFalseNoUnique category identifier for Shopzilla product listings.
shopzillaproductfeedStringFalseNoSpecifies whether the item is included in the Shopzilla product feed.
showasgiftBooleanFalseNoIndicates whether the item can be purchased as a gift.
showdefaultdonationamountBooleanFalseNoSpecifies whether the default donation amount should be displayed.
sitemappriorityStringFalseNoPriority level for the item in the website sitemap.
softdescriptorStringFalseNoCustom soft descriptor used for transaction processing.
standardimagesStringFalseNoStandard image set associated with the item.
startingpriceDecimalFalseNoStarting bid price for auction listings.
stockdescriptionStringFalseNoDescription of the item's stock status or availability.
storecatdisplaynameStringFalseNoDisplay name of the item's primary store category.
storecatdisplayname2StringFalseNoDisplay name of the item's secondary store category.
storecategoryIntegerFalseNoUnique identifier for the primary store category.
storecategory2IntegerFalseNoUnique identifier for the secondary store category.
storedescriptionStringFalseNoDescription of the item as it appears in the online store.
storedetaileddescriptionStringFalseNoDetailed description used in the store listing.
storedisplayimageStringFalseNoURL or path to the main display image for the store listing.
storedisplaynameStringFalseNoItem name as displayed in the store.
storedisplaythumbnailStringFalseNoURL or path to the store listing thumbnail image.
storeitemtemplateStringFalseNoTemplate applied to the store listing.
subsidiaryStringFalseNoSubsidiary associated with this item.
supersizeimagesBooleanFalseNoSpecifies whether larger images are available for the item.
taxableBooleanFalseNoIndicates whether the item is subject to sales tax.
taxscheduleStringFalseNoTax schedule applied to the item for tax calculations.
templatesgroupStringFalseNoGroup of templates available for the item listing.
upccodeStringFalseNoUniversal Product Code (UPC) assigned to the item.
urlcomponentStringFalseNoSEO-friendly URL component for the item page.
usemarginalratesBooleanFalseNoIndicates whether marginal tax rates apply to this item.
vsoedeferralStringFalseNoSpecifies whether revenue deferral applies under VSOE accounting.
vsoedeliveredBooleanFalseNoIndicates whether the item is marked as delivered under VSOE.
vsoepermitdiscountStringFalseNoSpecifies whether discounts are permitted under VSOE accounting rules.
vsoepriceDecimalFalseNoPrice used for VSOE compliance calculations.
vsoesopgroupStringFalseNoStandard operating procedure group used for VSOE compliance.
weightDoubleFalseNoWeight of the item for shipping calculations.
weightunitStringFalseNoUnit of measurement for the item's weight.
willshipStringFalseNoIndicates the regions or countries where the item can be shipped.
yahooproductfeedStringFalseNoSpecifies whether the item is included in the Yahoo product feed.

Return to Top

kitItemCorrelateditem 

NameTypeReadOnlyReferencesFilterOnlyDescription
correlationfldDoubleFalseNoPercentage indicating the correlation strength between this item and another.
countfldIntegerFalseNoNumber of times this correlation has been recorded.
itemStringFalseNoIdentifier for the correlated item.
itemnkeyfldStringFalseNoUnique key or identifier for the item.
liftfldDoubleFalseNoPercentage indicating the lift effect, showing how much more likely items are purchased together.

Return to Top

kitItemItemAccountingBookDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoAccounting book associated with this item for financial reporting.
itemStringFalseNoIdentifier for the item linked to the accounting book.

Return to Top

kitItemItemQuantityPricingDiscount 

NameTypeReadOnlyReferencesFilterOnlyDescription
leveldiscountDoubleFalseNoDiscount percentage or amount applied at this pricing level.
levelpricenameStringFalseNoName of the price level associated with the discount.
parentitemStringFalseNoIdentifier for the item to which this quantity pricing discount applies.

Return to Top

kitItemItemQuantityPricingLevel 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoIdentifier for the item associated with this pricing level.
leveldiscountDoubleFalseNoDiscount percentage or amount applied at this quantity pricing level.

Return to Top

kitItemMember 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the kit item member.
dropshipmemberBooleanFalseNoIndicates whether this item is a drop-ship component of the kit.
itemStringFalseNoIdentifier for the item included in the kit.
linenumberIntegerFalseNoLine number of the item within the kit structure.
parentitemStringFalseNoIdentifier for the kit to which this item belongs.
quantityDoubleFalseNoQuantity of this item included in the kit.

Return to Top

kitItemPresentationItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
basepriceDecimalFalseNoStandard base price of the related item.
descriptionStringFalseNoDetailed description of the related item.
onlinepriceDecimalFalseNoPrice of the related item for online listings.
presentationitemStringFalseNoIdentifier for the related item presented alongside the main item.
presitemidIntegerFalseNoUnique internal identifier for the related item.
superitemStringFalseNoIdentifier for the main item associated with the related item.

Return to Top

kitItemPrice 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencypageStringFalseNoCurrency in which the item price is listed.
discountdisplayDoubleFalseNoDefault discount percentage applied to the item.
isinactiveBooleanFalseNoIndicates whether the price entry is inactive.
itemStringFalseNoIdentifier for the item associated with this price entry.
priceDecimalFalseNoBase price amount of the item in the specified currency.

Return to Top

kitItemQuantity 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoIdentifier for the item associated with quantity constraints.
maxcountIntegerFalseNoMaximum quantity allowed for this item in the kit.
mincountIntegerFalseNoMinimum quantity required for this item in the kit.

Return to Top

kitItemSiteCategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
categorydescriptionStringFalseNoDescription of the site category assigned to the item.
isdefaultBooleanFalseNoIndicates whether this is the preferred category for the item.
itemStringFalseNoIdentifier for the item associated with this category.
websiteStringFalseNoWebsite where this item category is applied.

Return to Top

kitItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoIdentifier for the item associated with subsidiary mapping.

Return to Top

kitItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoIdentifier for the item associated with translations.
displaynameStringFalseNoLocalized display name of the item.
languageStringFalseNoLanguage for which this translation applies.
nopricemessageStringFalseNoMessage displayed when the item price is unavailable in the selected language.
outofstockmessageStringFalseNoLocalized message displayed when the item is out of stock.
pagetitleStringFalseNoTranslated page title for the item.
salesdescriptionStringFalseNoLocalized sales description used for marketing and promotions.
storedescriptionStringFalseNoTranslated store description of the item.
featureddescriptionStringFalseNoLocalized featured description for promotional displays.
specialsdescriptionStringFalseNoLocalized description highlighting special offers or discounts.
storedisplaynameStringFalseNoTranslated name displayed in the online store.
storedetaileddescriptionStringFalseNoLocalized detailed description for the store listing.

Return to Top

knowledgeBaseSiteCategoryTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoLocalized brief description or greeting for the site category.
displaynameStringFalseNoTranslated name, title, or category label.
languageStringFalseNoLanguage for which this translation applies.
pagetitleStringFalseNoTranslated page title for the site category.
salesdescriptionStringFalseNoLocalized detailed description or message for the category.

Return to Top

laborbasedprojectrevenuerule 

NameTypeReadOnlyReferencesFilterOnlyDescription
customformStringFalseNoCustom form template applied to this revenue rule.
descriptionStringFalseNoDetailed description of the labor-based project revenue rule.
externalidStringFalseNoExternal identifier used for integrations or external systems.
isinactiveBooleanFalseNoIndicates whether the revenue rule is inactive.
nameStringFalseNoName of the labor-based project revenue rule.
projectStringFalseNoProject associated with this revenue rule.
ratemultiplierStringFalseNoMultiplier applied to labor rates for revenue calculations.
rateroundingtypeStringFalseNoMethod used for rounding calculated rates.
ratesourcetypeStringFalseNoDefines the source used for labor rate calculations.
revenuereconciledBooleanFalseNoIndicates whether revenue is reconciled for this rule.
savedsearchIntegerFalseNoIdentifier for the saved search associated with this rule.
serviceitemStringFalseNoService item linked to this revenue rule.

Return to Top

LagType 

NameTypeReadOnlyReferencesFilterOnlyDescription
inactiveBooleanFalseNoIndicates whether the lag type is inactive.
keyStringFalseNoUnique key identifier for the lag type.
nameStringFalseNoName of the lag type.
percentBooleanFalseNoSpecifies whether the lag is measured as a percentage.
seqnumIntegerFalseNoSequence number used for ordering lag types.

Return to Top

landedcost 

NameTypeReadOnlyReferencesFilterOnlyDescription
externalidStringFalseNoExternal identifier used for integrations or external systems.
itemStringFalseNoIdentifier for the item associated with the landed cost.
totalDecimalFalseNoTotal landed cost, including shipping, duties, and other fees.

Return to Top

LandedCostShipmentItemMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
recordStringFalseNoIdentifier for the shipment item record linked to landed costs.

Return to Top

lead 

NameTypeReadOnlyReferencesFilterOnlyDescription
accessroleStringFalseNoRole assigned for system access and permissions.
accountnumberStringFalseNoUnique account number associated with the lead.
altemailStringFalseNoAlternative email address for the lead.
altphoneStringFalseNoAlternative phone number for the lead.
assignedwebsiteStringFalseNoWebsite assigned to the lead for tracking purposes.
autonameBooleanFalseNoIndicates whether the lead's name is automatically generated.
balanceDecimalFalseNoCurrent outstanding balance for the lead.
buyingreasonStringFalseNoReason specified by the lead for making a purchase.
buyingtimeframeStringFalseNoTimeframe in which the lead intends to make a purchase.
campaigncategoryStringFalseNoMarketing campaign category associated with the lead.
categoryStringFalseNoCategory classification assigned to the lead.
clickstreamStringFalseNoRecorded website browsing history of the lead.
commentsStringFalseNoAdditional comments or notes related to the lead.
companynameStringFalseNoName of the company associated with the lead.
consolbalanceDecimalFalseNoConsolidated outstanding balance across subsidiaries.
consoldaysoverdueIntegerFalseNoNumber of overdue days across all subsidiaries.
consoldepositbalanceDecimalFalseNoConsolidated deposit balance for the lead.
consoloverduebalanceDecimalFalseNoTotal overdue balance across all subsidiaries.
consolunbilledordersDecimalFalseNoTotal unbilled orders for the lead across subsidiaries.
contactStringFalseNoPrimary contact person associated with the lead.
creditholdoverrideStringFalseNoIndicates whether credit hold is overridden for this lead.
creditlimitStringFalseNoCredit limit assigned to the lead.
currencyStringFalseNoCurrency in which transactions are conducted for the lead.
currencyprecisionStringFalseNoNumber of decimal places used for currency calculations.
customformStringFalseNoCustom form template assigned to the lead.
datecreatedDatetimeFalseNoTimestamp indicating when the lead was created.
daysoverdueIntegerFalseNoNumber of days the lead's balance has been overdue.
defaultaddressStringFalseNoDefault billing or shipping address for the lead.
defaultbankaccountStringFalseNoDefault bank account associated with the lead.
depositbalanceDecimalFalseNoTotal deposits held by the lead.
draccountStringFalseNoDefault debit account associated with transactions for this lead.
emailStringFalseNoPrimary email address of the lead.
emailpreferenceStringFalseNoPreferred format for receiving emails (such as HTML, plain text).
emailtransactionsBooleanFalseNoIndicates whether the lead receives transaction emails.
entityidStringFalseNoUnique identifier assigned to the lead.
entitystatusStringFalseNoCurrent status of the lead (such as prospect, customer).
estimatedbudgetDecimalFalseNoEstimated budget allocated by the lead for purchases.
externalidStringFalseNoExternal identifier used for integrations or third-party systems.
faxStringFalseNoFax number associated with the lead.
faxtransactionsBooleanFalseNoIndicates whether the lead receives transaction documents via fax.
firstnameStringFalseNoFirst name of the lead contact.
firstvisitDatetimeFalseNoDate and time of the lead's first recorded website visit.
fxaccountStringFalseNoForeign exchange account associated with the lead.
giveaccessBooleanFalseNoIndicates whether the lead has system login access.
globalsubscriptionstatusStringFalseNoGlobal subscription status for marketing emails and notifications.
homephoneStringFalseNoHome phone number of the lead contact.
imageStringFalseNoProfile or company logo image associated with the lead.
isbudgetapprovedBooleanFalseNoIndicates whether the lead's budget has been approved.
isinactiveBooleanFalseNoSpecifies whether the lead is marked as inactive.
isjobStringFalseNoIndicates whether the lead is associated with a project or job.
ispersonStringFalseNoIndicates whether the lead represents an individual rather than a company.
keywordsStringFalseNoSearch keywords associated with the lead for marketing purposes.
languageStringFalseNoPreferred language for communication with the lead.
lastmodifieddateDatetimeFalseNoTimestamp indicating the last update made to the lead's record.
lastnameStringFalseNoLast name of the lead contact.
lastpagevisitedStringFalseNoLast webpage visited by the lead.
lastvisitDatetimeFalseNoDate and time of the lead's most recent website visit.
leadsourceStringFalseNoMarketing source through which the lead was acquired.
middlenameStringFalseNoMiddle name of the lead contact.
mobilephoneStringFalseNoMobile phone number of the lead contact.
monthlyclosingStringFalseNoSpecifies the closing period used for financial reporting.
negativenumberformatStringFalseNoFormat used to display negative numbers for this lead.
numberformatStringFalseNoPreferred number format for this lead's transactions.
otherrelationshipsStringFalseNoOther business relationships linked to this lead.
overduebalanceDecimalFalseNoTotal overdue balance for this lead.
parentStringFalseNoParent company or entity associated with the lead.
partnerStringFalseNoPartner associated with this lead, if applicable.
phoneStringFalseNoPrimary phone number of the lead.
phoneticnameStringFalseNoPhonetic representation of the lead's name.
prefccprocessorStringFalseNoPreferred credit card processor for this lead.
pricelevelStringFalseNoPrice level assigned to this lead for transactions.
printoncheckasStringFalseNoName format used when printing checks for this lead.
printtransactionsBooleanFalseNoIndicates whether transaction documents are printed for this lead.
receivablesaccountStringFalseNoAccounts receivable account linked to this lead.
referrerStringFalseNoReferring source or person who introduced this lead.
resalenumberStringFalseNoResale certificate number for tax-exempt transactions.
salesgroupStringFalseNoSales group assigned to manage this lead.
salesreadinessStringFalseNoAssessment of the lead's readiness to make a purchase.
salesrepIntegerFalseNoIdentifier of the sales representative managing this lead.
salutationStringFalseNoSalutation or title (such as Mr., Ms., Dr.) of the lead contact.
sendemailBooleanFalseNoIndicates whether emails can be sent to this lead.
sourcewebsiteStringFalseNoWebsite from which this lead originated.
stageStringFalseNoCurrent stage of the lead in the sales funnel.
strengthStringFalseNoAssessment of the lead's potential strength as a customer.
subsidiaryStringFalseNoSubsidiary associated with this lead, if applicable.
syncpartnerteamsBooleanFalseNoIndicates whether the lead's data syncs with partner teams.
syncsalesteamsBooleanFalseNoIndicates whether the lead's data syncs with sales teams.
taxableBooleanFalseNoSpecifies whether the lead is subject to sales tax.
taxexemptBooleanFalseNoIndicates whether the lead is tax-exempt.
taxfractionunitStringFalseNoFractional unit used for tax calculations.
taxitemStringFalseNoTax item or rate assigned to this lead.
taxroundingStringFalseNoMethod used for rounding tax amounts in transactions.
termsStringFalseNoPayment terms assigned to this lead.
territoryStringFalseNoSales territory associated with this lead.
titleStringFalseNoJob title of the lead contact.
unbilledordersDecimalFalseNoTotal value of unbilled orders associated with the lead.
unsubscribeStringFalseNoIndicates whether the lead has unsubscribed from communications.
urlStringFalseNoWebsite URL associated with the lead.
vatregnumberStringFalseNoValue-added tax (VAT) registration number for the lead.
visitsIntegerFalseNoTotal number of website visits by the lead.
webleadStringFalseNoIndicates whether the lead originated from an online form or website.

Return to Top

librariesAction 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file associated with the library action.

Return to Top

librariesAdvancedRevRec 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for advanced revenue recognition processes.

Return to Top

librariesBundleInstallation 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for managing bundle installation processes.

Return to Top

librariesClient 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoClient-side script file used for library functions.

Return to Top

librariesConsolRateAdjustor 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for consolidated rate adjustment processes.

Return to Top

librariesCustomGlLines 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for generating custom general ledger (GL) lines.

Return to Top

librariesEmailCapture 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for capturing and processing emails.

Return to Top

librariesMassUpdate 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for executing mass update operations.

Return to Top

librariesPaymentGateway 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for integrating with a payment gateway.

Return to Top

librariesPlugInType 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file associated with the plugin type.

Return to Top

librariesPlugInTypeImpl 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for implementing a specific plugin type.

Return to Top

librariesPortlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for managing and displaying portlets.

Return to Top

librariesPromotions 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for managing promotional campaigns and discounts.

Return to Top

librariesRestlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for executing RESTlet-based integrations.

Return to Top

librariesScheduled 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for executing scheduled scripts and tasks.

Return to Top

librariesShippingPartners 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for integrating with shipping partners.

Return to Top

librariesSuitelet 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for managing Suitelet-based applications.

Return to Top

librariesTaxCalculation 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for calculating taxes in transactions.

Return to Top

librariesTestPlugin 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for testing and validating plugins.

Return to Top

librariesUserEvent 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for handling user event scripts.

Return to Top

librariesWebApp 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoScript file used for managing web applications.

Return to Top

LinkedTrackingNumberMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
trackingnumberStringFalseNoUnique tracking number associated with a shipment or order.

Return to Top

LocalizedTemplate 

NameTypeReadOnlyReferencesFilterOnlyDescription
contentStringFalseNoLocalized content of the template.
localeStringFalseNoLanguage or region associated with this template.
mediaitemStringFalseNoMedia item linked to the template.
templateStringFalseNoIdentifier for the template being localized.

Return to Top

locAssignConfBackorderRulesItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
backorderStringFalseNoSpecifies the backorder handling rule for the item.
lineitemsavedsearchStringFalseNoSaved search used for filtering line items.
lineitemvalidsavedsearchStringFalseNoSaved search used for validating line items.
locationassignmentconfigurationStringFalseNoIdentifier for the location assignment configuration.
rankingStringFalseNoRanking value used for prioritizing backorder rules.
ranking_displayStringFalseNoEvaluation order in which the backorder rules are applied.

Return to Top

location 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the location.
defaultallocationpriorityDoubleFalseNoDefault priority used for inventory allocation.
externalidStringFalseNoExternal identifier used for integrations or external systems.
fullnameStringFalseNoFull name of the location.
includeincontroltowerBooleanFalseNoIndicates whether the location is included in the control tower for monitoring.
includeinsupplyplanningBooleanFalseNoSpecifies whether the location is considered in supply planning.
isinactiveBooleanFalseNoIndicates whether the location is inactive.
lastmodifieddateDatetimeFalseNoTimestamp indicating when the location record was last modified.
latitudeDoubleFalseNoGeographical latitude of the location.
locationtypeIntegerFalseNoType of location (such as warehouse, store, distribution center).
longitudeDoubleFalseNoGeographical longitude of the location.
mainaddressStringFalseNoPrimary address associated with the location.
makeinventoryavailableBooleanFalseNoIndicates whether inventory at this location is available for orders.
makeinventoryavailablestoreBooleanFalseNoSpecifies whether inventory is available in the online store.
nameStringFalseNoShort name of the location.
parentIntegerFalseNoIdentifier for the parent location, if applicable.
returnaddressStringFalseNoAddress used for product returns.
sopredconfidenceDoubleFalseNoPredicted confidence level of sales order fulfillment risk.
sopredicteddaysIntegerFalseNoEstimated number of days a sales order is predicted to be late or early.
subsidiaryStringFalseNoSubsidiary associated with this location.
topredconfidenceDoubleFalseNoPredicted confidence level of transfer order fulfillment risk.
topredicteddaysIntegerFalseNoEstimated number of days a transfer order is predicted to be late or early.
tranprefixStringFalseNoPrefix used for document numbers generated at this location.
usebinsBooleanFalseNoIndicates whether bin management is enabled for this location.

Return to Top

LocationMainAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoUnique identifier for the address record.
addr1StringFalseNoPrimary address line for the location.
addr2StringFalseNoSecondary address line for additional details.
addr3StringFalseNoTertiary address line, if applicable.
addresseeStringFalseNoName of the recipient or entity associated with the address.
attentionStringFalseNoAttention line for directing correspondence to a specific person or department.
cityStringFalseNoCity where the location is situated.
countryStringFalseNoCountry where the location is registered.
dropdownstateStringFalseNoState or region selected from a predefined dropdown list.
overrideBooleanFalseNoIndicates whether the address override option is enabled.
stateStringFalseNoState or province of the location.

Return to Top

LocationReturnAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoUnique identifier for the return address record.
addr1StringFalseNoPrimary return address line.
addr2StringFalseNoSecondary return address line for additional details.
addr3StringFalseNoTertiary return address line, if applicable.
addresseeStringFalseNoName of the recipient or entity for returned shipments.
attentionStringFalseNoAttention line for directing returns to a specific person or department.
cityStringFalseNoCity where the return location is situated.
countryStringFalseNoCountry where the return location is registered.
dropdownstateStringFalseNoState or region selected from a predefined dropdown list.
overrideBooleanFalseNoIndicates whether the return address override option is enabled.
stateStringFalseNoState or province of the return location.

Return to Top

locationSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
locationStringFalseNoIdentifier for the location associated with the subsidiary mapping.

Return to Top

LocationType 

NameTypeReadOnlyReferencesFilterOnlyDescription
idIntegerFalseNoUnique identifier for the location type.

Return to Top

LoginAudit 

NameTypeReadOnlyReferencesFilterOnlyDescription
dateDateFalseNoDate of the login attempt.
detailStringFalseNoAdditional details about the login attempt.
emailaddressStringFalseNoEmail address used for login.
ipaddressStringFalseNoIP address from which the login attempt was made.
oauthaccesstokennameStringFalseNoName of the token-based access token used for authentication.
oauthappnameStringFalseNoName of the token-based authentication application.
requesturiStringFalseNoRequested URI during the login attempt.
roleStringFalseNoUser role associated with the login session.
secchallengeStringFalseNoSecurity challenge encountered during login (such as CAPTCHA, multi-factor authentication).
statusStringFalseNoStatus of the login attempt (such as Success, Failed, Locked).

Return to Top

lotnumberedassemblyitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
alternatedemandsourceitemStringFalseNoAlternative demand source item used in case of shortages.
assetaccountStringFalseNoAsset account associated with this item.
atpmethodStringFalseNoAvailable-to-promise method used for inventory calculations.
auctionquantityStringFalseNoQuantity available for auction listings.
auctiontypeStringFalseNoType of auction listing (such as fixed price, highest bid).
autoleadtimeBooleanFalseNoIndicates whether lead time is automatically calculated.
autopreferredstocklevelBooleanFalseNoSpecifies whether the preferred stock level is automatically determined.
autoreorderpointBooleanFalseNoIndicates whether the reorder point is automatically calculated.
availabletopartnersBooleanFalseNoSpecifies whether the item is available to partners.
averagecostDecimalFalseNoAverage cost of the item based on historical purchases.
billexchratevarianceacctStringFalseNoAccount used for tracking bill exchange rate variances.
billingscheduleStringFalseNoBilling schedule applied to this item.
billpricevarianceacctStringFalseNoAccount used for tracking bill price variances.
billqtyvarianceacctStringFalseNoAccount used for tracking bill quantity variances.
buildentireassemblyBooleanFalseNoIndicates whether the entire assembly must be built at once.
buildtimeDoubleFalseNoTime required to build the assembly.
buildtimelotsizeDoubleFalseNoLot size used when calculating build time.
buyitnowpriceDecimalFalseNoBuy-it-now price for auction listings.
classStringFalseNoClassification category for tracking and reporting purposes.
cogsaccountStringFalseNoCost of Goods Sold (COGS) account associated with this item.
conditionenabledStringFalseNoIndicates whether condition-based selling is enabled.
conditionhelpurlStringFalseNoURL for additional information about item conditions.
consumptionunitStringFalseNoUnit of measure for item consumption.
copydescriptionBooleanFalseNoIndicates whether the description is copied from the parent item.
costDecimalFalseNoStandard cost of the item.
costcategoryStringFalseNoCost category associated with this item.
costestimateDecimalFalseNoEstimated cost of the item.
costestimatetypeStringFalseNoMethod used for cost estimation (such as standard, average).
costingmethodStringFalseNoCosting method applied to this item (such as FIFO, LIFO, Average).
costingmethoddisplayStringFalseNoHuman-readable display of the costing method.
costunitsStringFalseNoUnit of measure for cost calculations.
countryofmanufactureStringFalseNoCountry where the item is manufactured.
createddateDatetimeFalseNoTimestamp indicating when the item record was created.
createrevenueplansonStringFalseNoDefines when revenue plans are created for this item.
currencyStringFalseNoCurrency used for transactions involving this item.
customformStringFalseNoCustom form template applied to this item.
custreturnvarianceaccountStringFalseNoAccount used for tracking variances in customer returns.
defaultrevisionStringFalseNoDefault revision assigned to this item.
deferredrevenueaccountStringFalseNoAccount used for deferred revenue recognition.
deferrevrecBooleanFalseNoIndicates whether revenue recognition is deferred.
demandmodifierStringFalseNoModifier applied to demand calculations.
demandtimefenceIntegerFalseNoTime fence (in days) for demand planning.
departmentStringFalseNoDepartment associated with this item.
descriptionStringFalseNoDetailed description of the item.
directrevenuepostingBooleanFalseNoIndicates whether revenue is posted directly without deferral.
displayinebaystoreBooleanFalseNoSpecifies whether the item is displayed in the eBay store.
displaynameStringFalseNoPublic-facing name of the item.
distributioncategoryStringFalseNoDistribution category assigned to this item.
distributionnetworkStringFalseNoDistribution network where the item is available.
dontshowpriceBooleanFalseNoIndicates whether the item price is hidden in the store.
dropshipexpenseaccountStringFalseNoExpense account associated with drop-ship orders for this item.
ebayhandlingtimeStringFalseNoHandling time before the item is shipped on eBay.
ebayintlinsurancefeeDecimalFalseNoFee for international shipping insurance on eBay.
ebayintlpackagehandlingfeeDecimalFalseNoHandling fee for international shipments on eBay.
ebayintlshipinsuranceStringFalseNoSpecifies international shipping insurance options on eBay.
ebayintlshippingitem1StringFalseNoFirst international shipping method available on eBay.
ebayintlshippingitem2StringFalseNoSecond international shipping method available on eBay.
ebayintlshippingitem3StringFalseNoThird international shipping method available on eBay.
ebayisintlcalculatedrateStringFalseNoIndicates whether international shipping rates are calculated automatically on eBay.
ebayisirregularpackageBooleanFalseNoSpecifies whether the item is considered an irregular package for eBay shipping.
ebayitemdescriptionStringFalseNoDetailed item description for eBay listings.
ebayitemlocdisplayStringFalseNoSpecifies how the item location is displayed on eBay.
ebayitemloczipcodeStringFalseNoZip code of the item’s location for eBay listings.
ebayitemlotsIntegerFalseNoNumber of lots available for the eBay listing.
ebayitemsubtitleStringFalseNoSubtitle displayed for the eBay listing.
ebayitemtitleStringFalseNoTitle of the item listing on eBay.
ebayitemweightamtStringFalseNoWeight of the item for eBay shipping calculations.
ebaylayoutStringFalseNoLayout template applied to the eBay listing.
ebaypackagetypeStringFalseNoType of packaging used for eBay shipments.
ebaypagecounterStringFalseNoCounter tracking the number of page views on eBay.
ebayrelistingoptionStringFalseNoRelisting option selected for the eBay listing.
ebaythemeStringFalseNoTheme used for displaying the item on eBay.
ebaythemegroupStringFalseNoTheme group applied to the eBay listing.
effectivebomcontrolStringFalseNoIndicates the bill of materials (BOM) control method used.
endauctionswhenoutofstockBooleanFalseNoSpecifies whether auctions automatically end when the item is out of stock.
enforceminqtyinternallyBooleanFalseNoIndicates whether a minimum quantity is enforced internally for sales.
excludefromsitemapBooleanFalseNoSpecifies whether the item should be excluded from the sitemap for SEO.
externalidStringFalseNoExternal identifier used for integrations with other systems.
featureddescriptionStringFalseNoHighlighted description used for promotions and featured listings.
fixedbuildtimeDoubleFalseNoFixed build time required for assembling this item.
froogleproductfeedStringFalseNoCategory or group for submitting the item to Google Shopping (formerly Froogle).
futurehorizonStringFalseNoTime horizon used for future demand forecasting.
gainlossaccountStringFalseNoAccount used for tracking gains or losses related to this item.
galleryBooleanFalseNoIndicates whether the item is featured in a gallery view.
galleryfeaturedBooleanFalseNoSpecifies whether the item is highlighted as a featured gallery item.
gifttypeexpressshipBooleanFalseNoIndicates whether express shipping is available for gift orders.
gifttypegiftwrapBooleanFalseNoSpecifies whether gift-wrapping options are available.
gifttypeshiptorecipientBooleanFalseNoIndicates whether the item can be shipped directly to the recipient as a gift.
handlingcostDecimalFalseNoAdditional handling cost applied to the item.
handlingcostunitsStringFalseNoUnit of measure used for handling cost calculations.
handlinggroupStringFalseNoGroup to which this item belongs for handling fee calculations.
imagesgroupStringFalseNoGroup of images associated with the item.
imageslocationStringFalseNoLocation or URL where images of the item are stored.
includechildrenBooleanFalseNoSpecifies whether child items are included in the listing.
incomeaccountStringFalseNoAccount used to record revenue from item sales.
intercocogsaccountStringFalseNoIntercompany Cost of Goods Sold (COGS) account.
intercoincomeaccountStringFalseNoIntercompany income account associated with this item.
internalidIntegerFalseNoUnique internal identifier assigned to the item.
iscalculatedrateStringFalseNoIndicates whether the shipping rate is calculated dynamically.
isdonationitemBooleanFalseNoSpecifies whether the item is designated as a donation item.
isdropshipitemBooleanFalseNoIndicates whether the item is eligible for drop shipping.
isgcocompliantBooleanFalseNoSpecifies whether the item meets Google Checkout compliance standards.
isinactiveBooleanFalseNoIndicates whether the item is inactive in the system.
isonlineBooleanFalseNoSpecifies whether the item is available for sale online.
isphantomBooleanFalseNoIndicates whether the item is a phantom assembly.
isspecialorderitemBooleanFalseNoSpecifies whether the item is only available via special order.
isspecialworkorderitemBooleanFalseNoIndicates whether the item is a special work order item.
isstorepickupallowedBooleanFalseNoSpecifies whether the item can be picked up in-store.
issueproductStringFalseNoProduct issued when this item is sold.
itemconditionStringFalseNoCondition of the item (such as new, refurbished, used).
itemhandlingfeeDecimalFalseNoHandling fee applied per unit of this item.
itemidStringFalseNoUnique identifier for the item within the system.
iteminsurancefeeDecimalFalseNoFee for shipping insurance on this item.
itemnumberoptionsStringFalseNoAvailable numbering options for this item.
itemoptionsStringFalseNoAvailable customization or configuration options for the item.
itemprocessfamilyStringFalseNoProcess family classification for manufacturing workflows.
itemprocessgroupStringFalseNoProcess group classification for production planning.
itemrevenuecategoryStringFalseNoRevenue category associated with this item for financial reporting.
itemshipinsuranceStringFalseNoIndicates whether shipping insurance is available for this item.
itemtypeStringFalseNoType of item (such as inventory, non-inventory, service, kit).
lastmodifieddateDatetimeFalseNoTimestamp indicating the last modification made to the item record.
lastpurchasepriceDecimalFalseNoLast recorded purchase price of the item.
leadtimeIntegerFalseNoLead time required for replenishment of this item.
listimmediateStringFalseNoSpecifies whether the item should be listed immediately after creation.
listingdurationStringFalseNoDuration for which the item listing is active.
listingstartdateDateFalseNoDate when the item listing becomes active.
listingstarttimeStringFalseNoTime when the item listing becomes active.
locationStringFalseNoLocation where the item is stored or fulfilled from.
manufacturerStringFalseNoName of the manufacturer of the item.
manufactureraddr1StringFalseNoFirst line of the manufacturer's address.
manufacturercityStringFalseNoCity where the manufacturer is located.
manufacturerstateStringFalseNoState or region where the manufacturer is located.
manufacturertariffStringFalseNoTariff code applicable to this item for customs and taxation.
manufacturertaxidStringFalseNoTax identification number of the manufacturer.
manufacturerzipStringFalseNoPostal code of the manufacturer's location.
matchbilltoreceiptBooleanFalseNoSpecifies whether bills should be matched to receipts for this item.
matrixitemnametemplateStringFalseNoTemplate used for naming matrix items.
maxdonationamountDecimalFalseNoMaximum amount allowed for donation purchases of this item.
maximumquantityStringFalseNoMaximum quantity allowed per purchase or transaction.
metataghtmlStringFalseNoMeta tag HTML content for SEO purposes.
minimumquantityStringFalseNoMinimum quantity required per purchase.
minimumquantityunitsStringFalseNoUnit of measure for the minimum quantity.
mpnStringFalseNoManufacturer part number (MPN) assigned to this item.
multmanufactureaddrBooleanFalseNoSpecifies whether multiple manufacturing addresses are associated with this item.
nextagcategoryStringFalseNoCategory assigned to the item for Nextag product listings.
nextagproductfeedStringFalseNoSpecifies whether the item is included in the Nextag product feed.
nopricemessageStringFalseNoMessage displayed when the item price is not shown.
numactivelistingsIntegerFalseNoNumber of active listings available for this item.
numcurrentlylistedIntegerFalseNoNumber of units currently listed for sale.
offersupportBooleanFalseNoIndicates whether customer support is offered for this item.
outofstockbehaviorStringFalseNoDefines how the item behaves when out of stock (such as allow backorders).
outofstockmessageStringFalseNoMessage displayed when the item is out of stock.
overallquantitypricingtypeStringFalseNoPricing type based on overall quantity purchased.
packageheightStringFalseNoHeight of the package for shipping purposes.
packagelengthStringFalseNoLength of the package for shipping purposes.
packagewidthStringFalseNoWidth of the package for shipping purposes.
pagetitleStringFalseNoTitle of the item's product page for SEO and display.
parentStringFalseNoParent item or category associated with this item.
planningitemcategoryStringFalseNoCategory used for planning inventory and production.
preferencecriterionStringFalseNoPreference criteria for recommending this item.
preferredlocationStringFalseNoPreferred location for storing or fulfilling this item.
preferredstockleveldaysDoubleFalseNoNumber of days of stock to maintain as preferred inventory.
pricinggroupStringFalseNoPricing group to which the item belongs.
primarycatdisplaynameStringFalseNoDisplay name of the item's primary category.
primarycategoryIntegerFalseNoUnique identifier of the primary category assigned to this item.
printitemsBooleanFalseNoIndicates whether this item is printable.
prodpricevarianceacctStringFalseNoAccount used to track production price variances.
prodqtyvarianceacctStringFalseNoAccount used to track production quantity variances.
producerBooleanFalseNoSpecifies whether the item is considered a producer-type item.
productfeedStringFalseNoSpecifies whether the item is included in product feed exports.
purchasedescriptionStringFalseNoDescription used for purchase transactions.
purchaseorderamountStringFalseNoTotal amount of purchase orders for this item.
purchaseorderquantityStringFalseNoTotal quantity of purchase orders for this item.
purchaseorderquantitydiffStringFalseNoDifference in purchase order quantities versus expectations.
purchasepricevarianceacctStringFalseNoAccount used for tracking purchase price variances.
purchaseunitStringFalseNoUnit of measure used for purchase transactions.
quantitypricingscheduleStringFalseNoPricing schedule based on quantity breaks.
quantityreorderunitsStringFalseNoUnit of measure for reorder quantities.
receiptamountStringFalseNoTotal amount of received shipments for this item.
receiptquantityStringFalseNoTotal quantity received for this item.
receiptquantitydiffStringFalseNoDifference in received quantity versus expected quantity.
refundgivenasStringFalseNoDefines how refunds are issued for this item (such as store credit, cash).
relateditemsdescriptionStringFalseNoDescription of related items that may be purchased together.
reordermultipleStringFalseNoMultiple quantity used when reordering this item.
rescheduleindaysIntegerFalseNoNumber of days for inbound rescheduling of supply orders.
rescheduleoutdaysIntegerFalseNoNumber of days for outbound rescheduling of demand orders.
reservepriceDecimalFalseNoMinimum price set for auction listings.
returnpolicyStringFalseNoReturn policy associated with this item.
returnpolicydetailsStringFalseNoDetailed terms and conditions of the return policy.
returnshippingpaidbyStringFalseNoIndicates who is responsible for return shipping costs (such as buyer, seller).
returnswithinStringFalseNoTimeframe within which returns are accepted.
revenueallocationgroupStringFalseNoGroup used for revenue allocation purposes.
revenuerecognitionruleStringFalseNoRevenue recognition rule applied to this item.
revrecforecastruleStringFalseNoForecasting rule used for revenue recognition.
revrecscheduleStringFalseNoRevenue recognition schedule assigned to this item.
rotationtypeStringFalseNoInventory rotation method used (such as FIFO, LIFO).
safetystocklevelDoubleFalseNoMinimum quantity to keep in stock to prevent shortages.
safetystockleveldaysIntegerFalseNoNumber of days of stock to maintain as safety stock.
safetystocklevelunitsStringFalseNoUnit of measure for safety stock levels.
saleunitStringFalseNoUnit of measure used for sales transactions.
schedulebcodeStringFalseNoSchedule B code used for export classification.
schedulebnumberStringFalseNoExport classification number from the Schedule B list.
schedulebquantityStringFalseNoUnit of measure for the Schedule B classification.
scrapacctStringFalseNoAccount used to record scrapped inventory.
searchkeywordsStringFalseNoSearch keywords associated with the item for SEO and internal search.
seasonaldemandBooleanFalseNoIndicates whether the item has seasonal demand fluctuations.
secondarycatdisplaynameStringFalseNoDisplay name of the item's secondary category.
secondarycategoryIntegerFalseNoUnique identifier of the secondary category assigned to this item.
sellonebayBooleanFalseNoIndicates whether the item is listed for sale on eBay.
shipasiaBooleanFalseNoSpecifies whether the item can be shipped to Asia.
shipaustraliaBooleanFalseNoSpecifies whether the item can be shipped to Australia.
shipcanadaBooleanFalseNoSpecifies whether the item can be shipped to Canada.
shipeuropeBooleanFalseNoSpecifies whether the item can be shipped to Europe.
shipgermanyBooleanFalseNoSpecifies whether the item can be shipped to Germany.
shipindividuallyBooleanFalseNoIndicates whether the item must be shipped separately.
shipjapanBooleanFalseNoSpecifies whether the item can be shipped to Japan.
shipmexicoBooleanFalseNoSpecifies whether the item can be shipped to Mexico.
shipnorthsouthamericaBooleanFalseNoSpecifies whether the item can be shipped to North and South America.
shippackageStringFalseNoPackage type used when shipping this item.
shippingcostDecimalFalseNoCost of shipping the item.
shippingcostunitsStringFalseNoUnit of measure used for shipping cost calculations.
shippingdomesticmethodsgroupStringFalseNoGroup of domestic shipping methods available for this item.
shippingdomgroupStringFalseNoDomestic shipping group assigned to the item.
shippingintlgroupStringFalseNoInternational shipping group assigned to the item.
shippingintlgroup1StringFalseNoFirst group of international shipping methods available.
shippingintlgroup2StringFalseNoSecond group of international shipping methods available.
shippingintlgroup3StringFalseNoThird group of international shipping methods available.
shippingitem1StringFalseNoFirst shipping method available for this item.
shippingitem2StringFalseNoSecond shipping method available for this item.
shippingitem3StringFalseNoThird shipping method available for this item.
shippinglocationsgroupStringFalseNoGroup of locations where the item can be shipped.
shippingpackaginggroupStringFalseNoGroup of packaging options available for shipping.
shippingrate1DecimalFalseNoFirst shipping rate tier for this item.
shippingrate2DecimalFalseNoSecond shipping rate tier for this item.
shippingrate3DecimalFalseNoThird shipping rate tier for this item.
shipukBooleanFalseNoSpecifies whether the item can be shipped to the United Kingdom.
shipworldwideBooleanFalseNoIndicates whether the item can be shipped globally.
shoppingdotcomcategoryStringFalseNoCategory assigned for Shopping.com product listings.
shoppingproductfeedStringFalseNoSpecifies whether the item is included in the Shopping.com product feed.
shopzillacategoryidIntegerFalseNoUnique category identifier for Shopzilla product listings.
shopzillaproductfeedStringFalseNoSpecifies whether the item is included in the Shopzilla product feed.
showasgiftBooleanFalseNoIndicates whether the item can be purchased as a gift.
showdefaultdonationamountBooleanFalseNoSpecifies whether the default donation amount should be displayed.
sitemappriorityStringFalseNoPriority level for the item in the website sitemap.
softdescriptorStringFalseNoCustom soft descriptor used for transaction processing.
standardimagesStringFalseNoStandard image set associated with the item.
startingpriceDecimalFalseNoStarting bid price for auction listings.
stockdescriptionStringFalseNoDescription of the item's stock status or availability.
stockunitStringFalseNoUnit of measure used for stock tracking.
storecatdisplaynameStringFalseNoDisplay name of the item's primary store category.
storecatdisplayname2StringFalseNoDisplay name of the item's secondary store category.
storecategoryIntegerFalseNoUnique identifier for the primary store category.
storecategory2IntegerFalseNoUnique identifier for the secondary store category.
storedescriptionStringFalseNoDescription of the item as it appears in the online store.
storedetaileddescriptionStringFalseNoDetailed description used in the store listing.
storedisplayimageStringFalseNoURL or path to the main display image for the store listing.
storedisplaynameStringFalseNoItem name as displayed in the store.
storedisplaythumbnailStringFalseNoURL or path to the store listing thumbnail image.
storeitemtemplateStringFalseNoTemplate applied to the store listing.
subsidiaryStringFalseNoSubsidiary associated with this item.
supersizeimagesBooleanFalseNoSpecifies whether larger images are available for the item.
supplyreplenishmentmethodStringFalseNoMethod used for replenishing inventory supply.
supplytimefenceIntegerFalseNoNumber of days within which supply changes are restricted.
taxableBooleanFalseNoIndicates whether the item is subject to sales tax.
taxscheduleStringFalseNoTax schedule applied to the item for tax calculations.
templatesgroupStringFalseNoGroup of templates available for the item listing.
totalvalueDecimalFalseNoTotal inventory value of the item.
tracklandedcostBooleanFalseNoIndicates whether landed cost tracking is enabled for this item.
transferpriceDecimalFalseNoPrice used for intercompany transfers of this item.
transferpriceunitsStringFalseNoUnit of measure used for transfer pricing calculations.
unbuildvarianceaccountStringFalseNoAccount used to track variances when unbuilding assemblies.
unitstypeStringFalseNoUnit type associated with this item.
upccodeStringFalseNoUniversal Product Code (UPC) assigned to the item.
urlcomponentStringFalseNoSEO-friendly URL component for the item page.
usebinsBooleanFalseNoIndicates whether bin management is enabled for this item.
usemarginalratesBooleanFalseNoIndicates whether marginal tax rates apply to this item.
vendornameStringFalseNoName of the preferred vendor for this item.
vendreturnvarianceaccountStringFalseNoAccount used to track variances in vendor returns.
vsoedeferralStringFalseNoSpecifies whether revenue deferral applies under VSOE accounting.
vsoedeliveredBooleanFalseNoIndicates whether the item is marked as delivered under VSOE.
vsoepermitdiscountStringFalseNoSpecifies whether discounts are permitted under VSOE accounting rules.
vsoepriceDecimalFalseNoPrice used for VSOE compliance calculations.
vsoesopgroupStringFalseNoStandard operating procedure group used for VSOE compliance.
weightDoubleFalseNoWeight of the item for shipping calculations.
weightunitStringFalseNoUnit of measurement for the item's weight.
weightunitsStringFalseNoSpecific units used to measure weight.
willshipStringFalseNoIndicates the regions or countries where the item can be shipped.
wipacctStringFalseNoWork-in-progress (WIP) account used for tracking production costs.
wipvarianceacctStringFalseNoAccount used to track variances in WIP inventory.
yahooproductfeedStringFalseNoSpecifies whether the item is included in the Yahoo product feed.

Return to Top

lotnumberedinventoryitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
alternatedemandsourceitemStringFalseNoAlternative demand source item used in case of shortages.
assetaccountStringFalseNoAsset account associated with this inventory item.
atpmethodStringFalseNoAvailable-to-promise (ATP) method used for inventory calculations.
auctionquantityStringFalseNoQuantity available for auction listings.
auctiontypeStringFalseNoType of auction listing (such as fixed price, highest bid).
autoleadtimeBooleanFalseNoIndicates whether lead time is automatically calculated.
autopreferredstocklevelBooleanFalseNoSpecifies whether the preferred stock level is automatically determined.
autoreorderpointBooleanFalseNoIndicates whether the reorder point is automatically calculated.
availabletopartnersBooleanFalseNoSpecifies whether the item is available to partners.
averagecostDecimalFalseNoAverage cost of the item based on historical purchases.
billexchratevarianceacctStringFalseNoAccount used for tracking bill exchange rate variances.
billingscheduleStringFalseNoBilling schedule applied to this item.
billpricevarianceacctStringFalseNoAccount used for tracking bill price variances.
billqtyvarianceacctStringFalseNoAccount used for tracking bill quantity variances.
buyitnowpriceDecimalFalseNoBuy-it-now price for auction listings.
classStringFalseNoClassification category for tracking and reporting purposes.
cogsaccountStringFalseNoCost of Goods Sold (COGS) account associated with this item.
conditionenabledStringFalseNoIndicates whether condition-based selling is enabled.
conditionhelpurlStringFalseNoURL for additional information about item conditions.
consumptionunitStringFalseNoUnit of measure for item consumption.
conversionrateStringFalseNoConversion rate used for unit conversions.
copydescriptionBooleanFalseNoIndicates whether the description is copied from the parent item.
costDecimalFalseNoStandard cost of the item.
costcategoryStringFalseNoCost category associated with this item.
costestimateDecimalFalseNoEstimated cost of the item.
costestimatetypeStringFalseNoMethod used for cost estimation (such as standard, average).
costingmethodStringFalseNoCosting method applied to this item (such as FIFO, LIFO, Average).
costingmethoddisplayStringFalseNoHuman-readable display of the costing method.
costunitsStringFalseNoUnit of measure for cost calculations.
countryofmanufactureStringFalseNoCountry where the item is manufactured.
createddateDatetimeFalseNoTimestamp indicating when the item record was created.
createrevenueplansonStringFalseNoDefines when revenue plans are created for this item.
currencyStringFalseNoCurrency used for transactions involving this item.
customformStringFalseNoCustom form template applied to this item.
custreturnvarianceaccountStringFalseNoAccount used for tracking variances in customer returns.
deferredrevenueaccountStringFalseNoAccount used for deferred revenue recognition.
deferrevrecBooleanFalseNoIndicates whether revenue recognition is deferred.
demandmodifierStringFalseNoModifier applied to demand calculations.
demandtimefenceIntegerFalseNoTime fence (in days) for demand planning.
departmentStringFalseNoDepartment associated with this item.
directrevenuepostingBooleanFalseNoIndicates whether revenue is posted directly without deferral.
displayinebaystoreBooleanFalseNoSpecifies whether the item is displayed in the eBay store.
displaynameStringFalseNoPublic-facing name of the item.
distributioncategoryStringFalseNoDistribution category assigned to this item.
distributionnetworkStringFalseNoDistribution network where the item is available.
dontshowpriceBooleanFalseNoIndicates whether the item price is hidden in the store.
dropshipexpenseaccountStringFalseNoExpense account associated with drop-ship orders for this item.
ebayhandlingtimeStringFalseNoHandling time before the item is shipped on eBay.
ebayintlinsurancefeeDecimalFalseNoFee for international shipping insurance on eBay.
ebayintlpackagehandlingfeeDecimalFalseNoHandling fee for international shipments on eBay.
ebayintlshipinsuranceStringFalseNoSpecifies international shipping insurance options on eBay.
ebayintlshippingitem1StringFalseNoFirst international shipping method available on eBay.
ebayintlshippingitem2StringFalseNoSecond international shipping method available on eBay.
ebayintlshippingitem3StringFalseNoThird international shipping method available on eBay.
ebayisintlcalculatedrateStringFalseNoIndicates whether international shipping rates are calculated automatically on eBay.
ebayisirregularpackageBooleanFalseNoSpecifies whether the item is considered an irregular package for eBay shipping.
ebayitemdescriptionStringFalseNoDetailed item description for eBay listings.
ebayitemlocdisplayStringFalseNoSpecifies how the item location is displayed on eBay.
ebayitemloczipcodeStringFalseNoZip code of the item’s location for eBay listings.
ebayitemlotsIntegerFalseNoNumber of lots available for the eBay listing.
ebayitemsubtitleStringFalseNoSubtitle displayed for the eBay listing.
ebayitemtitleStringFalseNoTitle of the item listing on eBay.
ebayitemweightamtStringFalseNoWeight of the item for eBay shipping calculations.
ebaylayoutStringFalseNoLayout template applied to the eBay listing.
ebaypackagetypeStringFalseNoType of packaging used for eBay shipments.
ebaypagecounterStringFalseNoCounter tracking the number of page views on eBay.
ebayrelistingoptionStringFalseNoRelisting option selected for the eBay listing.
ebaythemeStringFalseNoTheme used for displaying the item on eBay.
ebaythemegroupStringFalseNoTheme group applied to the eBay listing.
enablecatchweightBooleanFalseNoIndicates whether catch weight functionality is enabled for this item.
endauctionswhenoutofstockBooleanFalseNoSpecifies whether auctions automatically end when the item is out of stock.
enforceminqtyinternallyBooleanFalseNoIndicates whether a minimum quantity is enforced internally for sales.
excludefromsitemapBooleanFalseNoSpecifies whether the item should be excluded from the sitemap for SEO.
externalidStringFalseNoExternal identifier used for integrations with other systems.
featureddescriptionStringFalseNoHighlighted description used for promotions and featured listings.
fraudriskStringFalseNoSpecifies the fraud risk level associated with this item.
froogleproductfeedStringFalseNoCategory or group for submitting the item to Google Shopping (formerly Froogle).
futurehorizonStringFalseNoTime horizon used for future demand forecasting.
gainlossaccountStringFalseNoAccount used for tracking gains or losses related to this item.
galleryBooleanFalseNoIndicates whether the item is featured in a gallery view.
galleryfeaturedBooleanFalseNoSpecifies whether the item is highlighted as a featured gallery item.
gifttypeexpressshipBooleanFalseNoIndicates whether express shipping is available for gift orders.
gifttypegiftwrapBooleanFalseNoSpecifies whether gift-wrapping options are available.
gifttypeshiptorecipientBooleanFalseNoIndicates whether the item can be shipped directly to the recipient as a gift.
handlingcostDecimalFalseNoAdditional handling cost applied to the item.
handlingcostunitsStringFalseNoUnit of measure used for handling cost calculations.
handlinggroupStringFalseNoGroup to which this item belongs for handling fee calculations.
imagesgroupStringFalseNoGroup of images associated with the item.
imageslocationStringFalseNoLocation or URL where images of the item are stored.
includechildrenBooleanFalseNoSpecifies whether child items are included in the listing.
incomeaccountStringFalseNoAccount used to record revenue from item sales.
intercocogsaccountStringFalseNoIntercompany Cost of Goods Sold (COGS) account.
intercoincomeaccountStringFalseNoIntercompany income account associated with this item.
internalidIntegerFalseNoUnique internal identifier assigned to the item.
iscalculatedrateStringFalseNoIndicates whether the shipping rate is calculated dynamically.
isdonationitemBooleanFalseNoSpecifies whether the item is designated as a donation item.
isdropshipitemBooleanFalseNoIndicates whether the item is eligible for drop shipping.
isgcocompliantBooleanFalseNoSpecifies whether the item meets Google Checkout compliance standards.
isinactiveBooleanFalseNoIndicates whether the item is inactive in the system.
isonlineBooleanFalseNoSpecifies whether the item is available for sale online.
isspecialorderitemBooleanFalseNoSpecifies whether the item is only available via special order.
isstorepickupallowedBooleanFalseNoSpecifies whether the item can be picked up in-store.
issueproductStringFalseNoProduct issued when this item is sold.
itemconditionStringFalseNoCondition of the item (such as new, refurbished, used).
itemhandlingfeeDecimalFalseNoHandling fee applied per unit of this item.
itemidStringFalseNoUnique identifier for the item within the system.
iteminsurancefeeDecimalFalseNoFee for shipping insurance on this item.
itemnumberoptionsStringFalseNoAvailable numbering options for this item.
itemoptionsStringFalseNoAvailable customization or configuration options for the item.
itemprocessfamilyStringFalseNoProcess family classification for manufacturing workflows.
itemprocessgroupStringFalseNoProcess group classification for production planning.
itemrevenuecategoryStringFalseNoRevenue category associated with this item for financial reporting.
itemshipinsuranceStringFalseNoIndicates whether shipping insurance is available for this item.
itemtypeStringFalseNoType of item (such as inventory, non-inventory, service, kit).
lastmodifieddateDatetimeFalseNoTimestamp indicating the last modification made to the item record.
lastpurchasepriceDecimalFalseNoLast recorded purchase price of the item.
leadtimeIntegerFalseNoLead time required for replenishment of this item.
listimmediateStringFalseNoSpecifies whether the item should be listed immediately after creation.
listingdurationStringFalseNoDuration for which the item listing is active.
listingstartdateDateFalseNoDate when the item listing becomes active.
listingstarttimeStringFalseNoTime when the item listing becomes active.
locationStringFalseNoLocation where the item is stored or fulfilled from.
lowerwarninglimitDoubleFalseNoLower threshold limit for inventory warnings.
manufacturerStringFalseNoName of the manufacturer of the item.
manufactureraddr1StringFalseNoFirst line of the manufacturer's address.
manufacturercityStringFalseNoCity where the manufacturer is located.
manufacturerstateStringFalseNoState or region where the manufacturer is located.
manufacturertariffStringFalseNoTariff code applicable to this item for customs and taxation.
manufacturertaxidStringFalseNoTax identification number of the manufacturer.
manufacturerzipStringFalseNoPostal code of the manufacturer's location.
matchbilltoreceiptBooleanFalseNoSpecifies whether bills should be matched to receipts for this item.
matrixitemnametemplateStringFalseNoTemplate used for naming matrix items.
matrixtypeStringFalseNoType of matrix relationship used for this item.
maxdonationamountDecimalFalseNoMaximum amount allowed for donation purchases of this item.
maximumquantityStringFalseNoMaximum quantity allowed per purchase or transaction.
metataghtmlStringFalseNoMeta tag HTML content for SEO purposes.
minimumquantityStringFalseNoMinimum quantity required per purchase.
minimumquantityunitsStringFalseNoUnit of measure for the minimum quantity.
mossappliesBooleanFalseNoIndicates whether the Mini One Stop Shop (MOSS) VAT scheme applies to this item.
mpnStringFalseNoManufacturer part number (MPN) assigned to this item.
multmanufactureaddrBooleanFalseNoSpecifies whether multiple manufacturing addresses are associated with this item.
nextagcategoryStringFalseNoCategory assigned to the item for Nextag product listings.
nextagproductfeedStringFalseNoSpecifies whether the item is included in the Nextag product feed.
nopricemessageStringFalseNoMessage displayed when the item price is not shown.
numactivelistingsIntegerFalseNoNumber of active listings available for this item.
numcurrentlylistedIntegerFalseNoNumber of units currently listed for sale.
offersupportBooleanFalseNoIndicates whether customer support is offered for this item.
outofstockbehaviorStringFalseNoDefines how the item behaves when out of stock (such as allow backorders).
outofstockmessageStringFalseNoMessage displayed when the item is out of stock.
overallquantitypricingtypeStringFalseNoPricing type based on overall quantity purchased.
packageheightStringFalseNoHeight of the package for shipping purposes.
packagelengthStringFalseNoLength of the package for shipping purposes.
packagewidthStringFalseNoWidth of the package for shipping purposes.
pagetitleStringFalseNoTitle of the item's product page for SEO and display.
parentStringFalseNoParent item or category associated with this item.
planningitemcategoryStringFalseNoCategory used for planning inventory and production.
preferencecriterionStringFalseNoPreference criteria for recommending this item.
preferredlocationStringFalseNoPreferred location for storing or fulfilling this item.
preferredstockleveldaysDoubleFalseNoNumber of days of stock to maintain as preferred inventory.
pricinggroupStringFalseNoPricing group to which the item belongs.
primarycatdisplaynameStringFalseNoDisplay name of the item's primary category.
primarycategoryIntegerFalseNoUnique identifier of the primary category assigned to this item.
producerBooleanFalseNoSpecifies whether the item is considered a producer-type item.
productfeedStringFalseNoSpecifies whether the item is included in product feed exports.
purchasedescriptionStringFalseNoDescription used for purchase transactions.
purchaseorderamountStringFalseNoTotal amount of purchase orders for this item.
purchaseorderquantityStringFalseNoTotal quantity of purchase orders for this item.
purchaseorderquantitydiffStringFalseNoDifference in purchase order quantities versus expectations.
purchasepricevarianceacctStringFalseNoAccount used for tracking purchase price variances.
purchaseunitStringFalseNoUnit of measure used for purchase transactions.
quantitypricingscheduleStringFalseNoPricing schedule based on quantity breaks.
quantityreorderunitsStringFalseNoUnit of measure for reorder quantities.
receiptamountStringFalseNoTotal amount of received shipments for this item.
receiptquantityStringFalseNoTotal quantity received for this item.
receiptquantitydiffStringFalseNoDifference in received quantity versus expected quantity.
refundgivenasStringFalseNoDefines how refunds are issued for this item (such as store credit, cash).
relateditemsdescriptionStringFalseNoDescription of related items that may be purchased together.
reordermultipleStringFalseNoMultiple quantity used when reordering this item.
rescheduleindaysIntegerFalseNoNumber of days for inbound rescheduling of supply orders.
rescheduleoutdaysIntegerFalseNoNumber of days for outbound rescheduling of demand orders.
reservepriceDecimalFalseNoMinimum price set for auction listings.
returnpolicyStringFalseNoReturn policy associated with this item.
returnpolicydetailsStringFalseNoDetailed terms and conditions of the return policy.
returnshippingpaidbyStringFalseNoIndicates who is responsible for return shipping costs (such as buyer, seller).
returnswithinStringFalseNoTimeframe within which returns are accepted.
revenueallocationgroupStringFalseNoGroup used for revenue allocation purposes.
revenuerecognitionruleStringFalseNoRevenue recognition rule applied to this item.
revrecforecastruleStringFalseNoForecasting rule used for revenue recognition.
revrecscheduleStringFalseNoRevenue recognition schedule assigned to this item.
rotationtypeStringFalseNoInventory rotation method used (such as FIFO, LIFO).
safetystocklevelDoubleFalseNoMinimum quantity to keep in stock to prevent shortages.
safetystockleveldaysIntegerFalseNoNumber of days of stock to maintain as safety stock.
safetystocklevelunitsStringFalseNoUnit of measure for safety stock levels.
salesdescriptionStringFalseNoDescription used for sales transactions.
saleunitStringFalseNoUnit of measure used for sales transactions.
schedulebcodeStringFalseNoSchedule B code used for export classification.
schedulebnumberStringFalseNoExport classification number from the Schedule B list.
schedulebquantityStringFalseNoUnit of measure for the Schedule B classification.
searchkeywordsStringFalseNoSearch keywords associated with the item for SEO and internal search.
seasonaldemandBooleanFalseNoIndicates whether the item has seasonal demand fluctuations.
secondarybaseunitStringFalseNoSecondary unit of measure used as the base unit.
secondarycatdisplaynameStringFalseNoDisplay name of the item's secondary category.
secondarycategoryIntegerFalseNoUnique identifier of the secondary category assigned to this item.
secondaryconsumptionunitStringFalseNoAlternative unit of measure for item consumption.
secondarypurchaseunitStringFalseNoAlternative unit of measure for purchase transactions.
secondarysaleunitStringFalseNoAlternative unit of measure for sales transactions.
secondarystockunitStringFalseNoAlternative unit of measure for stock tracking.
secondaryunitstypeStringFalseNoAlternative unit type classification for this item.
sellonebayBooleanFalseNoIndicates whether the item is listed for sale on eBay.
shipasiaBooleanFalseNoSpecifies whether the item can be shipped to Asia.
shipaustraliaBooleanFalseNoSpecifies whether the item can be shipped to Australia.
shipcanadaBooleanFalseNoSpecifies whether the item can be shipped to Canada.
shipeuropeBooleanFalseNoSpecifies whether the item can be shipped to Europe.
shipgermanyBooleanFalseNoSpecifies whether the item can be shipped to Germany.
shipindividuallyBooleanFalseNoIndicates whether the item must be shipped separately.
shipjapanBooleanFalseNoSpecifies whether the item can be shipped to Japan.
shipmexicoBooleanFalseNoSpecifies whether the item can be shipped to Mexico.
shipnorthsouthamericaBooleanFalseNoSpecifies whether the item can be shipped to North and South America.
shippackageStringFalseNoPackage type used when shipping this item.
shippingcostDecimalFalseNoCost of shipping the item.
shippingcostunitsStringFalseNoUnit of measure used for shipping cost calculations.
shippingdomesticmethodsgroupStringFalseNoGroup of domestic shipping methods available for this item.
shippingdomgroupStringFalseNoDomestic shipping group assigned to the item.
shippingintlgroupStringFalseNoInternational shipping group assigned to the item.
shippingintlgroup1StringFalseNoFirst group of international shipping methods available.
shippingintlgroup2StringFalseNoSecond group of international shipping methods available.
shippingintlgroup3StringFalseNoThird group of international shipping methods available.
shippingitem1StringFalseNoFirst shipping method available for this item.
shippingitem2StringFalseNoSecond shipping method available for this item.
shippingitem3StringFalseNoThird shipping method available for this item.
shippinglocationsgroupStringFalseNoGroup of locations where the item can be shipped.
shippingpackaginggroupStringFalseNoGroup of packaging options available for shipping.
shippingrate1DecimalFalseNoFirst shipping rate tier for this item.
shippingrate2DecimalFalseNoSecond shipping rate tier for this item.
shippingrate3DecimalFalseNoThird shipping rate tier for this item.
shipukBooleanFalseNoSpecifies whether the item can be shipped to the United Kingdom.
shipworldwideBooleanFalseNoIndicates whether the item can be shipped globally.
shoppingdotcomcategoryStringFalseNoCategory assigned for Shopping.com product listings.
shoppingproductfeedStringFalseNoSpecifies whether the item is included in the Shopping.com product feed.
shopzillacategoryidIntegerFalseNoUnique category identifier for Shopzilla product listings.
shopzillaproductfeedStringFalseNoSpecifies whether the item is included in the Shopzilla product feed.
showasgiftBooleanFalseNoIndicates whether the item can be purchased as a gift.
showdefaultdonationamountBooleanFalseNoSpecifies whether the default donation amount should be displayed.
sitemappriorityStringFalseNoPriority level for the item in the website sitemap.
softdescriptorStringFalseNoCustom soft descriptor used for transaction processing.
standardimagesStringFalseNoStandard image set associated with the item.
startingpriceDecimalFalseNoStarting bid price for auction listings.
stockdescriptionStringFalseNoDescription of the item's stock status or availability.
stockunitStringFalseNoUnit of measure used for stock tracking.
storecatdisplaynameStringFalseNoDisplay name of the item's primary store category.
storecatdisplayname2StringFalseNoDisplay name of the item's secondary store category.
storecategoryIntegerFalseNoUnique identifier for the primary store category.
storecategory2IntegerFalseNoUnique identifier for the secondary store category.
storedescriptionStringFalseNoDescription of the item as it appears in the online store.
storedetaileddescriptionStringFalseNoDetailed description used in the store listing.
storedisplayimageStringFalseNoURL or path to the main display image for the store listing.
storedisplaynameStringFalseNoItem name as displayed in the store.
storedisplaythumbnailStringFalseNoURL or path to the store listing thumbnail image.
storeitemtemplateStringFalseNoTemplate applied to the store listing.
subsidiaryStringFalseNoSubsidiary associated with this item.
supersizeimagesBooleanFalseNoSpecifies whether larger images are available for the item.
supplyreplenishmentmethodStringFalseNoMethod used for replenishing inventory supply.
supplytimefenceIntegerFalseNoNumber of days within which supply changes are restricted.
taxableBooleanFalseNoIndicates whether the item is subject to sales tax.
taxscheduleStringFalseNoTax schedule applied to the item for tax calculations.
templatesgroupStringFalseNoGroup of templates available for the item listing.
totalvalueDecimalFalseNoTotal inventory value of the item.
tracklandedcostBooleanFalseNoIndicates whether landed cost tracking is enabled for this item.
transferpriceDecimalFalseNoPrice used for intercompany transfers of this item.
transferpriceunitsStringFalseNoUnit of measure used for transfer pricing calculations.
unitstypeStringFalseNoUnit type associated with this item.
upccodeStringFalseNoUniversal Product Code (UPC) assigned to the item.
upperwarninglimitDoubleFalseNoUpper threshold limit for inventory warnings.
urlcomponentStringFalseNoSEO-friendly URL component for the item page.
usebinsBooleanFalseNoIndicates whether bin management is enabled for this item.
usemarginalratesBooleanFalseNoIndicates whether marginal tax rates apply to this item.
vendornameStringFalseNoName of the preferred vendor for this item.
vendreturnvarianceaccountStringFalseNoAccount used to track variances in vendor returns.
vsoedeferralStringFalseNoSpecifies whether revenue deferral applies under VSOE accounting.
vsoedeliveredBooleanFalseNoIndicates whether the item is marked as delivered under VSOE.
vsoepermitdiscountStringFalseNoSpecifies whether discounts are permitted under VSOE accounting rules.
vsoepriceDecimalFalseNoPrice used for VSOE compliance calculations.
vsoesopgroupStringFalseNoStandard operating procedure group used for VSOE compliance.
weightDoubleFalseNoWeight of the item for shipping calculations.
weightunitStringFalseNoUnit of measurement for the item's weight.
weightunitsStringFalseNoSpecific units used to measure weight.
willshipStringFalseNoIndicates the regions or countries where the item can be shipped.
yahooproductfeedStringFalseNoSpecifies whether the item is included in the Yahoo product feed.

Return to Top

MailTemplate 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the email template.
descriptionStringFalseNoBrief description of the email template's purpose or content.
isinactiveBooleanFalseNoIndicates whether the template is inactive.
isprivateBooleanFalseNoSpecifies whether the template is private and restricted to certain users.
mediaitemStringFalseNoAssociated media item (such as images, attachments) linked to the template.
nameStringFalseNoName of the email template.
recordtypeStringFalseNoType of record this email template is associated with (such as customer, transaction).
subjectStringFalseNoDefault subject line for emails using this template.

Return to Top

manufacturingComponent 

NameTypeReadOnlyReferencesFilterOnlyDescription
availableDoubleFalseNoQuantity of the component currently available for use.
backorderedDoubleFalseNoQuantity of the component that is back-ordered.
buildvarianceDoubleFalseNoVariance between planned and actual component usage in a build.
itemStringFalseNoComponent item used in the manufacturing process.
onhandDoubleFalseNoTotal quantity of the component currently in stock.
quantityDoubleFalseNoRequired quantity of the component for the build process.
sequencenumberIntegerFalseNoLine number indicating the component’s sequence in the manufacturing process.
transactionStringFalseNoTransaction ID associated with the component usage.
usedinbuildDoubleFalseNoActual quantity of the component used in the build process.

Return to Top

manufacturingcosttemplate 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the manufacturing cost template.
externalidStringFalseNoExternal identifier used for integrations or external systems.
isinactiveBooleanFalseNoIndicates whether the cost template is inactive.
memoStringFalseNoAdditional notes or comments related to the cost template.
nameStringFalseNoName of the manufacturing cost template.

Return to Top

ManufacturingCostTemplateCostDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
costcategoryStringFalseNoCategory of cost associated with this manufacturing process (such as labor, materials).
fixedrateDecimalFalseNoFixed cost rate applied to the manufacturing process.
itemStringFalseNoItem associated with this cost detail in the manufacturing template.
manufacturingcosttemplateStringFalseNoManufacturing cost template to which this cost detail belongs.

Return to Top

manufacturingoperationtask 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the manufacturing operation task.
actualruntimeDoubleFalseNoActual time taken to run the operation (in minutes).
actualsetuptimeDoubleFalseNoActual time spent on setup before the operation (in minutes).
actualworkDoubleFalseNoTotal actual work performed for this operation.
autocalculatelagBooleanFalseNoIndicates whether lag time is auto-calculated between operations.
completedquantityDoubleFalseNoTotal quantity completed for this operation task.
enddateDateFalseNoDate when the operation task was completed.
estimatedworkDoubleFalseNoEstimated amount of work required for the operation.
externalidStringFalseNoExternal identifier used for integrations or external systems.
inputquantityDoubleFalseNoQuantity of input materials required for this task.
laborresourcesDoubleFalseNoNumber of labor resources assigned to this operation.
machineresourcesDoubleFalseNoNumber of machine resources used for this operation.
manufacturingcosttemplateStringFalseNoManufacturing cost template associated with this operation.
manufacturingworkcenterStringFalseNoManufacturing work center where this operation takes place.
messageStringFalseNoAdditional comments or notes about this operation task.
operationsequenceIntegerFalseNoSequence order of the operation in the manufacturing process.
remainingworkDoubleFalseNoAmount of work still required to complete the task.
runrateDoubleFalseNoProduction rate measured in minutes per unit.
setuptimeDoubleFalseNoEstimated time required to set up the operation (in minutes).
startdatetimeDateFalseNoStart date of the manufacturing operation task.
statusStringFalseNoCurrent status of the operation task (such as pending, in progress, completed).
titleStringFalseNoName or title of the manufacturing operation task.

Return to Top

ManufacturingOperationTaskCostDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the operation task cost detail.
accountIntegerFalseNoAccount associated with the cost incurred for this operation task.
costcategoryStringFalseNoCategory of cost (such as labor, materials, overhead) associated with the operation.
fixedrateDecimalFalseNoFixed cost rate applied to this manufacturing operation task.
itemStringFalseNoItem related to this cost detail in the manufacturing process.
manufacturingoperationtaskStringFalseNoManufacturing operation task to which this cost detail is linked.

Return to Top

manufacturingOperationTaskPredecessor 

NameTypeReadOnlyReferencesFilterOnlyDescription
enddateDateFalseNoEnd date of the predecessor operation task.
lagamountIntegerFalseNoAmount of lag time between tasks.
lagtypeStringFalseNoType of lag applied between tasks (such as fixed, percentage-based).
lagunitsStringFalseNoUnits of lag time (such as minutes, hours, days).
manufacturingoperationtaskStringFalseNoManufacturing operation task that depends on the predecessor task.
startdateDateFalseNoStart date of the predecessor operation task.
taskStringFalseNoPredecessor task that must be completed before the current task begins.

Return to Top

manufacturingrouting 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the manufacturing routing.
autocalculatelagBooleanFalseNoIndicates whether lag time between operations is auto-calculated.
billofmaterialsStringFalseNoBill of materials (BOM) associated with this routing.
externalidStringFalseNoExternal identifier used for integrations or external systems.
isdefaultBooleanFalseNoSpecifies whether this is the default routing for the associated item.
isinactiveBooleanFalseNoIndicates whether this routing is inactive.
locationStringFalseNoLocations where this routing is applicable.
memoStringFalseNoAdditional notes or comments related to the routing.
nameStringFalseNoName of the manufacturing routing.

Return to Top

ManufacturingRoutingComponent 

NameTypeReadOnlyReferencesFilterOnlyDescription
bomquantityDoubleFalseNoQuantity of the component required per bill of materials (BOM).
descriptionStringFalseNoDescription of the component used in the routing.
itemStringFalseNoComponent item used in the manufacturing routing.
itemnameStringFalseNoName of the component item.
manufacturingroutingStringFalseNoManufacturing routing to which this component belongs.
operationdisplaytextStringFalseNoName or description of the operation in which this component is used.
operationsequencenumberIntegerFalseNoSequence number indicating the order of operations in the routing.
quantityDoubleFalseNoTotal quantity of the component required for the routing.
revisionStringFalseNoRevision number of the component used in the routing.
unitsStringFalseNoUnit of measure for the component quantity.

Return to Top

ManufacturingRoutingLocationMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
locationStringFalseNoLocation where the manufacturing routing is applicable.

Return to Top

ManufacturingRoutingRoutingStep 

NameTypeReadOnlyReferencesFilterOnlyDescription
lagamountIntegerFalseNoAmount of lag time before the next operation step.
lagtypeStringFalseNoType of lag applied between operation steps (such as fixed, percentage-based).
lagunitsStringFalseNoUnits used to measure the lag time (such as minutes, hours, days).
manufacturingcosttemplateStringFalseNoManufacturing cost template associated with this routing step.
manufacturingroutingStringFalseNoManufacturing routing to which this operation step belongs.
manufacturingworkcenterStringFalseNoWork center where this operation step is performed.
operationnameStringFalseNoName of the operation performed in this routing step.
operationsequenceIntegerFalseNoSequence number indicating the order of this operation step.
runrateDoubleFalseNoProduction rate measured in minutes per unit.

Return to Top

manufacturingTransaction 

NameTypeReadOnlyReferencesFilterOnlyDescription
assemblyStringFalseNoAssembly item being manufactured.
billofmaterialsStringFalseNoBill of Materials (BOM) used for this manufacturing transaction.
billofmaterialsrevisionStringFalseNoRevision of the BOM used.
builtDoubleFalseNoTotal quantity of the assembly that has been built.
classStringFalseNoClassification category for tracking and reporting purposes.
committedDoubleFalseNoTotal quantity available to build based on committed inventory.
dateDateFalseNoDate of the manufacturing transaction.
departmentStringFalseNoDepartment associated with this manufacturing transaction.
locationStringFalseNoLocation where the manufacturing process takes place.
memoStringFalseNoAdditional notes or comments related to the transaction.
postingperiodStringFalseNoFinancial posting period for this transaction.
productionenddateDateFalseNoDate when the manufacturing process is expected to be completed.
productionstartdateDateFalseNoDate when the manufacturing process begins.
quantityDoubleFalseNoTotal quantity involved in this manufacturing transaction.
referenceStringFalseNoReference number or identifier for this transaction.
routingStringFalseNoManufacturing routing used for this production process.
subsidiaryStringFalseNoSubsidiary associated with this manufacturing transaction.
transactionStringFalseNoUnique identifier for the transaction record.
trantypeStringFalseNoType of manufacturing transaction (such as work order, build transaction).
unitsStringFalseNoUnit of measure for the transaction quantity.

Return to Top

mapreducescript 

NameTypeReadOnlyReferencesFilterOnlyDescription
apiversionStringFalseNoAPI version used for the map/reduce script.
descriptionStringFalseNoBrief description of the script's functionality.
externalidStringFalseNoExternal identifier used for integrations or external systems.
isinactiveBooleanFalseNoIndicates whether the script is inactive.
nameStringFalseNoName of the map/reduce script.
notifyadminsBooleanFalseNoSpecifies whether administrators should be notified of script execution.
notifyemailsStringFalseNoEmail addresses to receive notifications about the script's execution.
notifygroupStringFalseNoUser group designated to receive script execution notifications.
notifyownerBooleanFalseNoIndicates whether the script owner should receive execution notifications.
ownerStringFalseNoOwner of the map/reduce script.
scriptfileStringFalseNoFile path or identifier of the script file.
scriptidStringFalseNoUnique script ID assigned to the map/reduce script.

Return to Top

markupitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoGeneral ledger account associated with the markup item.
availabletopartnersBooleanFalseNoIndicates whether the markup item is available to partners.
classStringFalseNoClassification category used for reporting purposes.
createddateDatetimeFalseNoDate when the markup item was created.
customformStringFalseNoCustom form template applied to this markup item.
departmentStringFalseNoDepartment associated with this markup item.
descriptionStringFalseNoBrief description of the markup item.
displaynameStringFalseNoPublic-facing display name of the markup item.
externalidStringFalseNoExternal identifier used for integrations or external systems.
includechildrenBooleanFalseNoIndicates whether child items are included in the markup.
isinactiveBooleanFalseNoIndicates whether the markup item is inactive.
ispretaxBooleanFalseNoSpecifies whether the markup is applied before tax calculation.
issueproductStringFalseNoProduct associated with this markup item.
itemidStringFalseNoUnique identifier for the markup item.
itemtypeStringFalseNoType of item (such as markup, service, discount).
lastmodifieddateDatetimeFalseNoTimestamp of the last modification made to the markup item.
locationStringFalseNoLocation where the markup item is applied.
nonpostingStringFalseNoIndicates whether the markup is a non-posting transaction.
parentStringFalseNoParent item associated with this markup item.
rateStringFalseNoMarkup rate applied to transactions.
subsidiaryStringFalseNoSubsidiary associated with this markup item.
taxscheduleStringFalseNoTax schedule applied to this markup item.
upccodeStringFalseNoUniversal Product Code (UPC) assigned to the markup item.
vendornameStringFalseNoName of the vendor associated with this markup item.

Return to Top

markupItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoMarkup item associated with a specific subsidiary.

Return to Top

markupItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
displaynameStringFalseNoLocalized display name of the markup item.
featureddescriptionStringFalseNoHighlighted description for promotional use.
itemStringFalseNoMarkup item associated with the translation.
languageStringFalseNoLanguage for the translation.
nopricemessageStringFalseNoMessage displayed when the price is unavailable.
outofstockmessageStringFalseNoMessage displayed when the item is out of stock.
pagetitleStringFalseNoSEO-friendly page title for the translated item.
salesdescriptionStringFalseNoLocalized sales description of the markup item.
specialsdescriptionStringFalseNoSpecial offer or promotional description.
storedescriptionStringFalseNoShort description used in the online store.
storedetaileddescriptionStringFalseNoDetailed product description used in the store.
storedisplaynameStringFalseNoLocalized store display name of the markup item.

Return to Top

massupdatescript 

NameTypeReadOnlyReferencesFilterOnlyDescription
defaultfunctionStringFalseNoDefault function executed by the mass update script.
descriptionStringFalseNoBrief description of the script's purpose.
externalidStringFalseNoExternal identifier used for integrations or external systems.
isinactiveBooleanFalseNoIndicates whether the script is inactive.
nameStringFalseNoName of the mass update script.
notifyadminsBooleanFalseNoSpecifies whether administrators should be notified when the script runs.
notifyemailsStringFalseNoEmail addresses that will receive notifications about script execution.
notifygroupStringFalseNoUser group designated to receive script execution notifications.
notifyownerBooleanFalseNoIndicates whether the script owner should receive notifications.
notifyuserBooleanFalseNoSpecifies whether the executing user should receive notifications.
ownerStringFalseNoOwner of the mass update script.
scriptfileStringFalseNoFile path or identifier of the script file.
scriptidStringFalseNoUnique script ID assigned to the mass update script.
scripttypeStringFalseNoType of script (such as user event, scheduled, client).

Return to Top

MediaItemFolder 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the media folder.
appfolderStringFalseNoSpecifies whether the folder is an application folder.
bundleableBooleanFalseNoIndicates whether the folder is available for SuiteBundles.
chromasubsamplingBooleanFalseNoSpecifies whether chroma subsampling is applied to images.
classStringFalseNoClass restriction applied to this folder.
compressedimagequalityStringFalseNoQuality setting for compressed images stored in this folder.
departmentStringFalseNoDepartment restriction applied to this folder.
descriptionStringFalseNoBrief description of the media folder's contents or purpose.
enablecompressionBooleanFalseNoIndicates whether website images in this folder are compressed.
externalidStringFalseNoExternal identifier used for integrations or external systems.
foldersizeDoubleFalseNoTotal size of the folder in kilobytes (kB).
groupStringFalseNoGroup restriction applied to this folder.
isinactiveBooleanFalseNoIndicates whether the folder is inactive.
isprivateBooleanFalseNoSpecifies whether the folder is private and restricted to certain users.
istoplevelBooleanFalseNoIndicates whether this is a top-level folder.
lastmodifieddateDateFalseNoDate when the folder was last modified.
locationStringFalseNoLocation restriction applied to this folder.
nameStringFalseNoName of the media folder.
numfolderfilesIntegerFalseNoTotal number of files stored in the folder.
ownerStringFalseNoOwner of the folder.
parentStringFalseNoSpecifies the parent folder if this is a sub-folder.
stripmetadataBooleanFalseNoIndicates whether metadata is removed from images in this folder.
subsidiaryStringFalseNoSubsidiary restriction applied to this folder.

Return to Top

MediaType 

NameTypeReadOnlyReferencesFilterOnlyDescription
altcontenttypeStringFalseNoAlternate content type associated with the media file.
chardataBooleanFalseNoIndicates whether the file is a text-based file.
contenttypeStringFalseNoPrimary content type of the media file.
extensionStringFalseNoFile extension associated with this media type.
keyStringFalseNoUnique key identifier for the media type.
typedescrStringFalseNoDescription of the media type.

Return to Top

memdoc 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the memorized transaction.
actionStringFalseNoAction performed by the memorized transaction (such as create, update).
everyIntegerFalseNoFrequency interval for repeating the memorized transaction.
externalidStringFalseNoExternal identifier used for integrations or external systems.
hasremainingBooleanFalseNoIndicates whether there are remaining transactions to process.
indefiniteBooleanFalseNoSpecifies whether the transaction repeats indefinitely.
inprogressBooleanFalseNoIndicates whether the transaction is currently being processed.
isinactiveBooleanFalseNoIndicates whether the memorized transaction is inactive.
nameStringFalseNoName of the memorized transaction.
nextdateDateFalseNoDate of the next scheduled occurrence of the transaction.
nexttrandateDateFalseNoNext scheduled transaction date.
numberremainingIntegerFalseNoNumber of remaining occurrences for the memorized transaction.
overridetransactiondateBooleanFalseNoSpecifies whether the transaction date can be overridden.
repeateveryIntegerFalseNoDefines the repeat interval for the transaction.
subsequentDateFalseNoDate of the next subsequent transaction.
subsequentpostingdateDateFalseNoNext posting date for the subsequent transaction.
timeperiodStringFalseNoTime period associated with the transaction's recurrence.
transactiontemplateStringFalseNoTemplate used for the memorized transaction.
unitStringFalseNoUnit of measure related to the transaction recurrence.
updateaddressesBooleanFalseNoSpecifies whether addresses are updated for each occurrence.

Return to Top

MemDocCustomRecurrence 

NameTypeReadOnlyReferencesFilterOnlyDescription
memdocStringFalseNoMemorized transaction definition associated with this recurrence.
nextdateDateFalseNoNext scheduled date for the memorized transaction.

Return to Top

memDocTransactionTemplate 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the memorized transaction template.
abbrevtypeStringFalseNoAbbreviated transaction type (such as invoice, bill, journal entry).
approvalstatusStringFalseNoCurrent approval status of the transaction template.
asofdateDateFalseNoEffective date for the transaction template.
classStringFalseNoClassification category assigned to the transaction.
createdbyStringFalseNoUser who created the transaction template.
createddateDateFalseNoDate when the transaction template was created.
currencyStringFalseNoCurrency used for the transaction template.
departmentStringFalseNoDepartment associated with the transaction template.
employeeStringFalseNoSales representative assigned to the transaction.
entityStringFalseNoCustomer, vendor, or other entity related to the transaction.
exchangerateDecimalFalseNoExchange rate applied to the transaction.
externalidStringFalseNoExternal identifier used for integrations or external systems.
incotermStringFalseNoInternational commercial term (Incoterm) applicable to the transaction.
isbookspecificBooleanFalseNoIndicates whether the transaction is specific to a certain accounting book.
lastmodifiedbyStringFalseNoUser who last modified the transaction template.
lastmodifieddateDateFalseNoDate when the transaction template was last modified.
leadsourceStringFalseNoLead source associated with the transaction.
locationStringFalseNoLocation where the transaction is recorded or processed.
memoStringFalseNoAdditional notes or comments related to the transaction template.
nextapproverStringFalseNoNext designated approver for the transaction.
partnerStringFalseNoPartner entity associated with the transaction.
paymentmethodStringFalseNoPayment method specified for the transaction.
postingBooleanFalseNoIndicates whether the transaction is a posting transaction.
postingperiodStringFalseNoAccounting period in which the transaction is posted.
sourceStringFalseNoSource of the transaction (such as manual entry, system-generated).
subsidiaryStringFalseNoSubsidiary associated with the transaction.
trandateDateFalseNoDate of the transaction.
trandisplaynameStringFalseNoDisplay name of the transaction for user reference.
visibletocustomerBooleanFalseNoIndicates whether the transaction is visible in the Customer Center.

Return to Top

MemDocTransactionTemplateAccountingLine 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoGeneral ledger account associated with this transaction line.
accountingbookStringFalseNoAccounting book to which this transaction applies.
amountDecimalFalseNoTotal amount recorded for this transaction line.
amountpaidDecimalFalseNoTotal amount that has been paid for this transaction line.
amountunpaidDecimalFalseNoTotal outstanding amount remaining for this transaction line.
creditDecimalFalseNoCredit amount applied to the transaction.
debitDecimalFalseNoDebit amount applied to the transaction.
exchangerateDecimalFalseNoExchange rate used for currency conversion in this transaction line.
memdoctransactiontemplateStringFalseNoMemorized transaction template associated with this line.
memdoctransactiontemplatelineStringFalseNoSpecific line item within the memorized transaction template.
netamountDecimalFalseNoNet amount after adjustments and applicable deductions.
paymentamountunusedDecimalFalseNoUnused portion of the payment amount.
paymentamountusedDecimalFalseNoPortion of the payment amount that has been applied.

Return to Top

memDocTransactionTemplateLine 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the transaction template line.
classStringFalseNoClassification category associated with this transaction line.
createdfromStringFalseNoSource transaction from which this line was created.
departmentStringFalseNoDepartment associated with this transaction line.
entityStringFalseNoCustomer, vendor, or other entity related to the transaction line.
expectedreceiptdateDateFalseNoExpected date for receipt of goods or services.
expectedshipdateDateFalseNoExpected date for shipment of goods.
foreignamountDecimalFalseNoTransaction amount in foreign currency.
itemStringFalseNoItem associated with this transaction line.
itemtypeStringFalseNoType of item (such as inventory, service, non-inventory).
linesequencenumberIntegerFalseNoSequence number of this line within the transaction.
locationStringFalseNoLocation where the transaction line applies.
mainlineBooleanFalseNoIndicates whether this line is the main transaction line.
memoStringFalseNoAdditional notes or comments related to this line item.
netamountDecimalFalseNoNet amount in the transaction currency after adjustments.
postingBooleanFalseNoIndicates whether this line is part of a posting transaction.
quantityDoubleFalseNoQuantity of the item in this transaction line.
rateDecimalFalseNoUnit rate applied to this transaction line.
shipmethodStringFalseNoShipping method used for this transaction.
subsidiaryStringFalseNoSubsidiary associated with this transaction line.
transactionStringFalseNoTransaction to which this line belongs.
transactiondiscountBooleanFalseNoIndicates whether this line includes a discount.
transactionlinetypeStringFalseNoType of transaction line (such as item, subtotal, discount).

Return to Top

memDocTransactionTemplatePartner 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoPercentage contribution of the partner to the transaction.
isprimaryBooleanFalseNoIndicates whether this partner is the primary partner for the transaction.
partnerStringFalseNoPartner associated with the memorized transaction template.
partnerroleStringFalseNoRole of the partner in this transaction (such as reseller, distributor).

Return to Top

memDocTransactionTemplateSalesTeam 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoPercentage contribution of the sales team member to the transaction.
employeeStringFalseNoSales employee associated with the memorized transaction template.
isprimaryBooleanFalseNoIndicates whether this sales team member is the primary contributor.
salesroleStringFalseNoRole of the sales team member in the transaction (such as account manager, sales rep).

Return to Top

memDocTransactionTemplateTranPromotion 

NameTypeReadOnlyReferencesFilterOnlyDescription
couponcodeStringFalseNoCoupon code applied to the transaction template.
promocodeStringFalseNoPromotion associated with the memorized transaction template.
promotiontypeStringFalseNoType of promotion applied (such as discount, free shipping, special offer).

Return to Top

merchandisehierarchylevel 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoBrief description of the merchandise hierarchy level.
externalidStringFalseNoExternal identifier used for integrations or external systems.
insertbeforeStringFalseNoSpecifies the level before which this hierarchy level should be inserted.
nameStringFalseNoName of the merchandise hierarchy level.
rankIntegerFalseNoPosition or ranking of the hierarchy level within the merchandise structure.

Return to Top

merchandisehierarchynode 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoBrief description of the merchandise hierarchy node.
externalidStringFalseNoExternal identifier used for integrations or external systems.
nameStringFalseNoName of the merchandise hierarchy node.

Return to Top

merchandisehierarchyversion 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoBrief description of the merchandise hierarchy version.
enddateDateFalseNoDate when this merchandise hierarchy version becomes inactive.
externalidStringFalseNoExternal identifier used for integrations or external systems.
nameStringFalseNoName of the merchandise hierarchy version.
startdateDateFalseNoDate when this merchandise hierarchy version becomes active.

Return to Top

message 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the message.
activityStringFalseNoActivity or record associated with the message.
attachmentsStringFalseNoList of attachments included with the message.
authorStringFalseNoSender of the message.
authoremailStringFalseNoEmail address of the sender.
datetimeDateFalseNoDate and time when the message was created.
emailedBooleanFalseNoIndicates whether the message was sent via email.
externalidStringFalseNoExternal identifier used for integrations or external systems.
hasattachmentBooleanFalseNoSpecifies whether the message includes attachments.
incomingBooleanFalseNoIndicates whether the message is an incoming message.
internalonlyBooleanFalseNoSpecifies whether the message is visible only to internal users.
messageStringFalseNoContent of the message.
primaryrecipientStringFalseNoMain recipient of the message.
subjectStringFalseNoSubject line of the message.
templateStringFalseNoTemplate used for the message, if applicable.
toStringFalseNoList of recipients to whom the message was sent.

Return to Top

MessageFile 

NameTypeReadOnlyReferencesFilterOnlyDescription
fileStringFalseNoFile attached to the message.

Return to Top

MessageType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoUnique key identifier for the message type.
nameStringFalseNoName of the message type.

Return to Top

methods 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoUnique identifier for the method.
descriptionStringFalseNoBrief description of the method's purpose or functionality.
methodStringFalseNoName of the method.
ownerStringFalseNoOwner or entity responsible for the method.

Return to Top

mfgplannedtime 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoUnique internal identifier for the planned manufacturing time record.
dateDateFalseNoDate when the manufacturing operation is planned.
durationDoubleFalseNoPlanned duration of the manufacturing operation (in hours).
externalidStringFalseNoExternal identifier used for integrations or external systems.
manufacturingoperationtaskStringFalseNoManufacturing operation task associated with this planned time.
manufacturingworkcenterStringFalseNoWork center where the manufacturing operation will take place.

Return to Top

MfgProjectAddressbook 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoUnique internal identifier for the address book entry.
addressbookaddressStringFalseNoAddress associated with the manufacturing project entity.
defaultbillingBooleanFalseNoIndicates whether this is the default billing address.
defaultshippingBooleanFalseNoIndicates whether this is the default shipping address.
entityStringFalseNoEntity associated with this address book entry.
labelStringFalseNoCustom label assigned to this address entry for identification.

Return to Top

MfgProjectAddressbookEntityAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoUnique identifier for the address entry.
addr1StringFalseNoPrimary street address line.
addr2StringFalseNoSecondary street address line (if applicable).
addr3StringFalseNoAdditional street address line (if applicable).
addresseeStringFalseNoName of the recipient or entity at this address.
attentionStringFalseNoPerson or department for whom the address is intended.
cityStringFalseNoCity where the address is located.
countryStringFalseNoCountry of the address.
dropdownstateStringFalseNoState selection from dropdown options.
overrideBooleanFalseNoIndicates whether the address overrides an existing entry.
stateStringFalseNoState or province associated with this address.

Return to Top

MfgProjectBulkMerge 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoEntity associated with the bulk merge process.
mergedateDateFalseNoDate and time when the bulk merge was performed.
mergetypeStringFalseNoType of merge operation conducted (such as mass update, record consolidation).
statusStringFalseNoCurrent status of the bulk merge process (such as completed, pending, failed).
subjectStringFalseNoSubject or title associated with the bulk merge operation.
templateStringFalseNoTemplate used for the bulk merge process.
usernameStringFalseNoUser who initiated or performed the bulk merge.

Return to Top

MfgProjectCompanyContact 

NameTypeReadOnlyReferencesFilterOnlyDescription
contactStringFalseNoCompany contact associated with the manufacturing project.

Return to Top

MfgProjectJobResources 

NameTypeReadOnlyReferencesFilterOnlyDescription
jobresourceStringFalseNoName of the job resource assigned to the manufacturing project.
projectStringFalseNoManufacturing job or project associated with the resource.

Return to Top

MfgProjectJobResourcesJobResourceJobResourceMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
jobresourceStringFalseNoJob resource mapped to the manufacturing project.

Return to Top

mitPurpose 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoUnique key identifier for the purpose entry.

Return to Top

MonthsOfYear 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoUnique key identifier for the month.

Return to Top

NegativeNumberFormat 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoUnique identifier for each record in the NegativeNumberFormat table.
nameStringFalseNoThe name associated with the negative number format.
prefixStringFalseNoA prefix added to negative numbers for formatting purposes.

Return to Top

NextTransactionLineLink 

NameTypeReadOnlyReferencesFilterOnlyDescription
foreignamountDecimalFalseNoThe transaction amount in the original currency before conversion to the base currency.
linktypeStringFalseNoSpecifies the type of relationship between linked transactions, such as a payment applied to an invoice.
nextdocStringFalseNoThe identifier of the next transaction linked to this one, if applicable.
nextlineStringFalseNoThe line item number in the next linked transaction.
previousdocStringFalseNoThe identifier of the previous related transaction in the sequence.
previouslineStringFalseNoThe line item number in the previous related transaction.
previoustypeStringFalseNoThe type of the previous related transaction, such as an invoice, payment, or credit memo.

Return to Top

NextTransactionLink 

NameTypeReadOnlyReferencesFilterOnlyDescription
nextdocStringFalseNoNext Doc
previousdocStringFalseNoPrevious Doc
linktypeStringFalseNoLink Type

Return to Top

nexus 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to each record.
countryStringFalseNoThe country associated with this record, typically for tax or regional purposes.
descriptionStringFalseNoA detailed explanation or label for this record.
stateStringFalseNoThe state, province, or county related to the record, used for regional classification.
taxagencyStringFalseNoThe preferred tax agency associated with this record for tax calculations and reporting.

Return to Top

noninventoryitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
amortizationperiodIntegerFalseNoThe number of periods over which the cost is amortized.
amortizationtemplateStringFalseNoThe template used for amortization schedules.
auctionquantityStringFalseNoThe quantity of items available in an auction listing.
auctiontypeStringFalseNoThe type of auction, such as standard or reserve.
availabletopartnersBooleanFalseNoIndicates whether the item is available to partners.
billexchratevarianceacctStringFalseNoThe account used for bill exchange rate variance adjustments.
billingscheduleStringFalseNoThe billing schedule applied to this item.
billpricevarianceacctStringFalseNoThe account for tracking price variances on bills.
billqtyvarianceacctStringFalseNoThe account for tracking quantity variances on bills.
buyitnowpriceDecimalFalseNoThe price at which an item can be purchased immediately in an auction.
classStringFalseNoThe classification category assigned to the item.
conditionenabledStringFalseNoIndicates whether item condition settings are enabled.
conditionhelpurlStringFalseNoThe URL providing help information about item conditions.
consumptionunitStringFalseNoThe unit of measurement for item consumption, such as liters or kilograms.
contingentrevenuehandlingBooleanFalseNoIndicates whether revenue recognition is contingent on conditions being met.
copydescriptionBooleanFalseNoIndicates whether the item description is copied from another source.
costDecimalFalseNoThe base cost of the item.
costcategoryStringFalseNoThe cost category associated with the item.
costestimateDecimalFalseNoThe estimated cost of the item based on standard calculations.
costestimatetypeStringFalseNoThe method used to estimate costs, such as standard or average.
costunitsStringFalseNoThe unit of measurement for cost calculations.
countryofmanufactureStringFalseNoThe country where the item was manufactured.
createddateDatetimeFalseNoThe date and time when the record was created.
createrevenueplansonStringFalseNoSpecifies when revenue plans should be created for this item.
currencyStringFalseNoThe currency associated with the item's financial transactions.
customformStringFalseNoThe custom form used for entering or displaying this record.
deferralaccountStringFalseNoThe account used for deferring revenue or expenses.
deferredrevenueaccountStringFalseNoThe account used for recognizing deferred revenue.
deferrevrecBooleanFalseNoIndicates whether revenue recognition should be deferred.
departmentStringFalseNoThe department associated with this item.
directrevenuepostingBooleanFalseNoIndicates whether revenue is posted directly to accounts without deferrals.
displayinebaystoreBooleanFalseNoSpecifies whether the item is displayed in an eBay store.
displaynameStringFalseNoThe name displayed for the item in listings and reports.
dontshowpriceBooleanFalseNoIndicates whether the price should be hidden from customer views.
dropshipexpenseaccountStringFalseNoThe account used for expenses related to drop-shipped items.
ebayhandlingtimeStringFalseNoThe estimated handling time before the item is shipped on eBay.
ebayintlinsurancefeeDecimalFalseNoThe international insurance fee for eBay shipments.
ebayintlpackagehandlingfeeDecimalFalseNoThe additional handling fee for international shipments on eBay.
ebayintlshipinsuranceStringFalseNoSpecifies whether international shipping insurance is offered on eBay.
ebayintlshippingitem1StringFalseNoThe first international shipping option for eBay listings.
ebayintlshippingitem2StringFalseNoThe second international shipping option for eBay listings.
ebayintlshippingitem3StringFalseNoThe third international shipping option for eBay listings.
ebayisintlcalculatedrateStringFalseNoIndicates whether international shipping rates are calculated automatically on eBay.
ebayisirregularpackageBooleanFalseNoIndicates whether the package has irregular dimensions for eBay shipping.
ebayitemdescriptionStringFalseNoThe detailed description of the item as listed on eBay.
ebayitemlocdisplayStringFalseNoThe location information displayed on the eBay listing.
ebayitemloczipcodeStringFalseNoThe ZIP code of the item's location for eBay shipping.
ebayitemlotsIntegerFalseNoThe number of lots available for this item on eBay.
ebayitemsubtitleStringFalseNoThe optional subtitle displayed on the eBay listing.
ebayitemtitleStringFalseNoThe main title of the item in eBay listings.
ebayitemweightamtStringFalseNoThe weight of the item for eBay shipping calculations.
ebaylayoutStringFalseNoThe layout template used for displaying the item on eBay.
ebaypackagetypeStringFalseNoThe type of packaging used for the eBay shipment.
ebaypagecounterStringFalseNoThe page counter setting for tracking eBay listing views.
ebayrelistingoptionStringFalseNoSpecifies whether and how the item should be relisted on eBay.
ebaythemeStringFalseNoThe visual theme applied to the eBay listing.
ebaythemegroupStringFalseNoThe theme group associated with the eBay listing.
endauctionswhenoutofstockBooleanFalseNoIndicates whether auctions automatically end when the item is out of stock.
enforceminqtyinternallyBooleanFalseNoSpecifies if the system enforces a minimum quantity for transactions.
excludefromsitemapBooleanFalseNoIndicates whether this item should be excluded from website sitemaps.
expenseaccountStringFalseNoThe account used for tracking expenses related to the item.
externalidStringFalseNoAn external identifier for integration with other systems.
featureddescriptionStringFalseNoA highlighted description used for marketing or special display purposes.
froogleproductfeedStringFalseNoSpecifies whether the item is included in Google Shopping product feeds.
galleryBooleanFalseNoIndicates whether the item is displayed in a gallery format.
galleryfeaturedBooleanFalseNoIndicates whether the item is featured in the gallery display.
generateaccrualsBooleanFalseNoSpecifies if accruals should be automatically generated for this item.
gifttypeexpressshipBooleanFalseNoIndicates whether express shipping is available for gift orders.
gifttypegiftwrapBooleanFalseNoIndicates whether gift wrapping is available for this item.
gifttypeshiptorecipientBooleanFalseNoIndicates whether the gift can be shipped directly to the recipient.
handlingcostDecimalFalseNoThe handling cost associated with shipping this item.
handlingcostunitsStringFalseNoThe unit of measurement used for handling cost calculations.
handlinggroupStringFalseNoThe grouping used for handling charges.
imagesgroupStringFalseNoThe image group assigned to this item.
imageslocationStringFalseNoThe location where the item's images are stored.
includechildrenBooleanFalseNoSpecifies if child items should be included in item listings.
incomeaccountStringFalseNoThe income account associated with the item.
intercodefrevaccountStringFalseNoThe intercompany deferred revenue account for financial transactions.
intercoexpenseaccountStringFalseNoThe intercompany expense account used for cost tracking.
intercoincomeaccountStringFalseNoThe intercompany income account for revenue tracking.
internalidIntegerFalseNoThe unique system-generated identifier for this record.
iscalculatedrateStringFalseNoIndicates whether the rate is calculated automatically.
isdonationitemBooleanFalseNoSpecifies if this item is designated as a donation item.
isdropshipitemBooleanFalseNoIndicates whether this item is drop-shipped directly to customers.
isfulfillableBooleanFalseNoSpecifies if this item can be fulfilled through standard order processing.
isgcocompliantBooleanFalseNoIndicates whether the item complies with Google Checkout requirements.
isinactiveBooleanFalseNoIndicates whether the item is inactive in the system.
isonlineBooleanFalseNoSpecifies if the item is available for online sales.
isspecialorderitemBooleanFalseNoIndicates whether the item is designated for special order fulfillment.
issueproductStringFalseNoThe associated product that is issued as part of this item.
itemconditionStringFalseNoThe condition of the item, such as new, used, or refurbished.
itemhandlingfeeDecimalFalseNoThe handling fee associated with processing this item.
itemidStringFalseNoThe unique identifier for the item in the system.
iteminsurancefeeDecimalFalseNoThe fee for insuring the item during shipping.
itemoptionsStringFalseNoThe available options or variations for the item.
itemrevenuecategoryStringFalseNoThe revenue category assigned to this item.
itemshipinsuranceStringFalseNoSpecifies whether shipping insurance is required for this item.
itemtypeStringFalseNoThe type of item, such as inventory, service, or non-inventory.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified.
listimmediateStringFalseNoIndicates whether the item is immediately available for listing.
listingdurationStringFalseNoThe duration for which the item will remain listed.
listingstartdateDateFalseNoThe date when the listing becomes active.
listingstarttimeStringFalseNoThe time when the listing becomes active.
locationStringFalseNoThe storage location or warehouse where the item is kept.
manufacturerStringFalseNoThe name of the company that manufactures the item.
manufactureraddr1StringFalseNoThe primary address of the manufacturer.
manufacturercityStringFalseNoThe city where the manufacturer is located.
manufacturerstateStringFalseNoThe state or region where the manufacturer operates.
manufacturertariffStringFalseNoThe tariff classification code assigned to the manufacturer.
manufacturertaxidStringFalseNoThe tax identification number of the manufacturer.
manufacturerzipStringFalseNoThe postal code for the manufacturer’s location.
matrixitemnametemplateStringFalseNoThe template used for generating matrix item names.
matrixtypeStringFalseNoIndicates whether the item is part of a matrix structure, such as parent or child.
maxdonationamountDecimalFalseNoThe maximum allowable donation amount for the item.
maximumquantityStringFalseNoThe highest quantity of this item that can be purchased in a single transaction.
metataghtmlStringFalseNoHTML metadata tags for search engine optimization (SEO).
minimumquantityStringFalseNoThe minimum quantity of this item that can be purchased in a single transaction.
minimumquantityunitsStringFalseNoThe unit of measure associated with the minimum quantity.
mossappliesBooleanFalseNoIndicates whether the Mini One Stop Shop (MOSS) VAT rules apply to this item.
mpnStringFalseNoThe manufacturer’s part number (MPN) for the item.
multmanufactureaddrBooleanFalseNoIndicates whether the item is manufactured at multiple addresses.
nextagcategoryStringFalseNoThe Nextag category associated with this item for product listings.
nextagproductfeedStringFalseNoSpecifies if the item is included in Nextag product feeds.
nopricemessageStringFalseNoThe message displayed when the item has no listed price.
numactivelistingsIntegerFalseNoThe number of active listings for this item.
numcurrentlylistedIntegerFalseNoThe number of times the item is currently listed for sale.
offersupportBooleanFalseNoIndicates whether customer support is offered for this item.
outofstockbehaviorStringFalseNoSpecifies how the system handles out-of-stock situations.
outofstockmessageStringFalseNoThe message displayed when the item is out of stock.
overallquantitypricingtypeStringFalseNoThe pricing strategy applied based on total quantity purchased.
overheadtypeStringFalseNoThe type of overhead costs associated with the item.
packageheightStringFalseNoThe height of the item’s package.
packagelengthStringFalseNoThe length of the item’s package.
packagewidthStringFalseNoThe width of the item’s package.
pagetitleStringFalseNoThe title displayed on the webpage for this item.
parentStringFalseNoThe parent item in a hierarchical product structure.
preferencecriterionStringFalseNoThe criterion used for sorting or prioritizing the item.
pricinggroupStringFalseNoThe pricing group to which the item belongs.
primarycatdisplaynameStringFalseNoThe primary category display name for the item.
primarycategoryIntegerFalseNoThe main category identifier for the item.
producerBooleanFalseNoIndicates whether the entity producing this item is also its vendor.
productfeedStringFalseNoSpecifies if the item is included in product feed submissions.
purchasedescriptionStringFalseNoThe description of the item used in purchase transactions.
purchaseorderamountStringFalseNoThe total amount associated with purchase orders for this item.
purchaseorderquantityStringFalseNoThe quantity of this item specified in purchase orders.
purchaseorderquantitydiffStringFalseNoThe variance between ordered and received quantities.
purchaseunitStringFalseNoThe unit of measure used for purchasing this item.
quantitypricingscheduleStringFalseNoThe pricing schedule based on purchase quantity tiers.
receiptamountStringFalseNoThe total value of received inventory for this item.
receiptquantityStringFalseNoThe total quantity of this item received.
receiptquantitydiffStringFalseNoThe difference between expected and received item quantities.
refundgivenasStringFalseNoThe form in which refunds are issued, such as credit or cash.
relateditemsdescriptionStringFalseNoA description of related or complementary items.
reservepriceDecimalFalseNoThe minimum price required for an auction to be completed.
residualStringFalseNoThe remaining value or cost after deductions.
returnpolicyStringFalseNoThe general return policy applicable to this item.
returnpolicydetailsStringFalseNoAdditional details about the item’s return policy.
returnshippingpaidbyStringFalseNoSpecifies whether the buyer or seller pays for return shipping.
returnswithinStringFalseNoThe timeframe within which returns are accepted.
revenueallocationgroupStringFalseNoThe group used for revenue allocation across multiple items.
revenuerecognitionruleStringFalseNoThe rule governing when and how revenue is recognized.
revrecforecastruleStringFalseNoThe rule used for forecasting revenue recognition.
revreclassfxaccountStringFalseNoThe account used for foreign exchange reclassification of revenue.
revrecscheduleStringFalseNoThe schedule for recognizing revenue over time.
salesdescriptionStringFalseNoThe description of the item used in sales transactions.
saleunitStringFalseNoThe unit of measure used when selling this item.
schedulebcodeStringFalseNoThe Schedule B classification code for export reporting.
schedulebnumberStringFalseNoThe Schedule B number assigned for export transactions.
schedulebquantityStringFalseNoThe quantity associated with Schedule B export reporting.
searchkeywordsStringFalseNoKeywords used for improving item search visibility.
secondarycatdisplaynameStringFalseNoThe secondary category display name for the item.
secondarycategoryIntegerFalseNoThe secondary category identifier for the item.
sellonebayBooleanFalseNoIndicates whether this item is available for sale on eBay.
shipasiaBooleanFalseNoIndicates whether the item can be shipped to Asia.
shipaustraliaBooleanFalseNoIndicates whether the item can be shipped to Australia.
shipcanadaBooleanFalseNoIndicates whether the item can be shipped to Canada.
shipeuropeBooleanFalseNoIndicates whether the item can be shipped to Europe.
shipgermanyBooleanFalseNoIndicates whether the item can be shipped to Germany.
shipindividuallyBooleanFalseNoSpecifies if this item requires separate shipping from other items.
shipjapanBooleanFalseNoIndicates whether the item can be shipped to Japan.
shipmexicoBooleanFalseNoIndicates whether the item can be shipped to Mexico.
shipnorthsouthamericaBooleanFalseNoIndicates whether the item can be shipped to North and South America.
shippackageStringFalseNoThe shipping package type used for this item.
shippingcostDecimalFalseNoThe cost associated with shipping this item.
shippingcostunitsStringFalseNoThe unit of measurement used for shipping cost calculations.
shippingdomesticmethodsgroupStringFalseNoThe group of available domestic shipping methods.
shippingdomgroupStringFalseNoThe shipping group used for domestic shipments.
shippingintlgroupStringFalseNoThe shipping group used for international shipments.
shippingintlgroup1StringFalseNoThe first predefined international shipping group.
shippingintlgroup2StringFalseNoThe second predefined international shipping group.
shippingintlgroup3StringFalseNoThe third predefined international shipping group.
shippingitem1StringFalseNoThe first shipping method available for this item.
shippingitem2StringFalseNoThe second shipping method available for this item.
shippingitem3StringFalseNoThe third shipping method available for this item.
shippinglocationsgroupStringFalseNoThe group of geographical locations where the item ships.
shippingpackaginggroupStringFalseNoThe group that determines the packaging type for shipping.
shippingrate1DecimalFalseNoThe primary shipping rate applied to this item.
shippingrate2DecimalFalseNoThe secondary shipping rate applied to this item.
shippingrate3DecimalFalseNoThe tertiary shipping rate applied to this item.
shipukBooleanFalseNoIndicates whether the item can be shipped to the United Kingdom.
shipworldwideBooleanFalseNoIndicates whether the item is available for worldwide shipping.
shoppingdotcomcategoryStringFalseNoThe Shopping.com category assigned to this item.
shoppingproductfeedStringFalseNoSpecifies whether the item is included in Shopping.com product feeds.
shopzillacategoryidIntegerFalseNoThe Shopzilla category ID for this item.
shopzillaproductfeedStringFalseNoIndicates whether the item is included in the Shopzilla product feed.
showasgiftBooleanFalseNoSpecifies whether the item can be purchased as a gift.
showdefaultdonationamountBooleanFalseNoIndicates whether the default donation amount is displayed for this item.
sitemappriorityStringFalseNoThe priority level assigned to the item in the website’s sitemap.
softdescriptorStringFalseNoThe billing descriptor that appears on customer statements.
standardimagesStringFalseNoThe standard images associated with the item.
startingpriceDecimalFalseNoThe initial listing price for the item in auctions.
stockdescriptionStringFalseNoA brief description of the item’s stock status or availability.
storecatdisplaynameStringFalseNoThe display name of the primary store category.
storecatdisplayname2StringFalseNoThe display name of the secondary store category.
storecategoryIntegerFalseNoThe primary store category assigned to the item.
storecategory2IntegerFalseNoThe secondary store category assigned to the item.
storedescriptionStringFalseNoThe description of the item as displayed in the online store.
storedetaileddescriptionStringFalseNoA detailed description of the item for the store listing.
storedisplayimageStringFalseNoThe main image displayed for the item in the store.
storedisplaynameStringFalseNoThe name of the item displayed in the store.
storedisplaythumbnailStringFalseNoThe thumbnail image used for the item in the store.
storeitemtemplateStringFalseNoThe template applied to the store’s item listing.
subsidiaryStringFalseNoThe subsidiary company associated with this item.
subtypeStringFalseNoThe subtype of the item, if applicable.
supersizeimagesBooleanFalseNoIndicates whether larger images are available for the item.
taxableBooleanFalseNoSpecifies if the item is subject to taxation.
taxscheduleStringFalseNoThe tax schedule that applies to this item.
templatesgroupStringFalseNoThe group of templates used for displaying the item.
unitstypeStringFalseNoThe type of unit measurement used for the item.
upccodeStringFalseNoThe Universal Product Code (UPC) assigned to the item.
urlcomponentStringFalseNoThe SEO-friendly URL component used for the item’s web address.
usemarginalratesBooleanFalseNoIndicates whether marginal tax rates are applied to this item.
vendornameStringFalseNoThe name of the vendor supplying this item.
vsoedeferralStringFalseNoThe method used for deferring revenue under VSOE rules.
vsoedeliveredBooleanFalseNoIndicates whether the item has been delivered under VSOE accounting rules.
vsoepermitdiscountStringFalseNoSpecifies if discounts are permitted under VSOE rules.
vsoepriceDecimalFalseNoThe VSOE-compliant price of the item.
vsoesopgroupStringFalseNoThe VSOE Statement of Position group assigned to the item.
weightDoubleFalseNoThe weight of the item.
weightunitStringFalseNoThe unit of measurement for the item's weight.
weightunitsStringFalseNoThe number of weight units applicable to the item.
willshipStringFalseNoSpecifies the regions or conditions under which the item will ship.
yahooproductfeedStringFalseNoIndicates whether the item is included in Yahoo product feeds.

Return to Top

nonInventoryItemCorrelateditem 

NameTypeReadOnlyReferencesFilterOnlyDescription
correlationfldDoubleFalseNoThe correlation percentage indicating the strength of the relationship between variables.
countfldIntegerFalseNoThe total count of occurrences for the given item.
itemStringFalseNoAn unlabeled item field, possibly representing a generic item identifier.
itemnkeyfldStringFalseNoThe unique key or identifier associated with the item.
liftfldDoubleFalseNoThe lift percentage, representing the strength of association between variables in predictive analysis.

Return to Top

nonInventoryItemItemAccountingBookDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with financial transactions.
itemStringFalseNoAn unlabeled item field, possibly representing a generic item identifier or reference.

Return to Top

nonInventoryItemItemQuantityPricingDiscount 

NameTypeReadOnlyReferencesFilterOnlyDescription
leveldiscountDoubleFalseNoThe discount percentage or amount applied at a specific price level.
levelpricenameStringFalseNoThe name of the price level associated with the item.
parentitemStringFalseNoThe parent item in a hierarchical item structure.

Return to Top

nonInventoryItemItemQuantityPricingLevel 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
leveldiscountDoubleFalseNoThe discount percentage or amount applied at a specific price level.

Return to Top

nonInventoryItemItemVendor 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
preferredvendorBooleanFalseNoIndicates whether this vendor is the preferred supplier for the item.
purchasepriceStringFalseNoThe standard purchase price of the item.
scheduleStringFalseNoThe pricing or procurement schedule associated with the item.
subsidiaryStringFalseNoThe subsidiary entity associated with the item.
vendorStringFalseNoThe name of the vendor supplying the item.
vendorcodeStringFalseNoThe unique code assigned to the vendor.
vendorcostenteredDecimalFalseNoThe item price as entered by the vendor.
vendorcurrencyidStringFalseNoThe currency in which the vendor's pricing is recorded.

Return to Top

nonInventoryItemPresentationItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
basepriceDecimalFalseNoThe standard base price of the item before any discounts or adjustments.
descriptionStringFalseNoThe description of the item, providing details about its features or purpose.
onlinepriceDecimalFalseNoThe price of the item when sold through an online store or e-commerce platform.
presentationitemStringFalseNoA related item that is presented alongside the main item for cross-selling or upselling.
presitemidIntegerFalseNoThe internal system-generated ID associated with the related item.
superitemStringFalseNoAn unlabeled item field, potentially representing a parent or grouped item.

Return to Top

nonInventoryItemPrice 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencypageStringFalseNoThe currency associated with the item's pricing.
discountdisplayDoubleFalseNoThe default discount percentage applied to the item.
isinactiveBooleanFalseNoIndicates whether the item is inactive and not available for transactions.
itemStringFalseNoThe name or identifier of the item.
priceDecimalFalseNoThe amount or price assigned to the item.

Return to Top

nonInventoryItemQuantity 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
maxcountIntegerFalseNoThe maximum allowable count or quantity for the item.
mincountIntegerFalseNoThe minimum required count or quantity for the item.

Return to Top

nonInventoryItemSiteCategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
categorydescriptionStringFalseNoThe description of the item category.
isdefaultBooleanFalseNoIndicates whether this is the preferred or default category.
itemStringFalseNoAn unlabeled item field, potentially representing a product or reference.
websiteStringFalseNoThe website or online platform associated with the item.

Return to Top

nonInventoryItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoAn unlabeled item field, potentially representing a product, identifier, or reference.

Return to Top

nonInventoryItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe name or identifier of the item.
displaynameStringFalseNoThe name of the item displayed in listings and online stores.
languageStringFalseNoThe language setting for the item’s content.
nopricemessageStringFalseNoThe message displayed when the item's price is unavailable.
outofstockmessageStringFalseNoThe message displayed when the item is out of stock.
pagetitleStringFalseNoThe title of the webpage where the item is listed.
salesdescriptionStringFalseNoThe description of the item used for sales purposes.
storedescriptionStringFalseNoThe description of the item as shown in the online store.
featureddescriptionStringFalseNoA highlighted description of the item for marketing or promotions.
specialsdescriptionStringFalseNoA description of special promotions or offers related to the item.
storedisplaynameStringFalseNoThe name of the item as displayed in the store.
storedetaileddescriptionStringFalseNoA detailed description of the item for the store listing.

Return to Top

nonInventoryPurchaseItemItemAccountingBookDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with financial transactions.
itemStringFalseNoAn unlabeled item field, potentially representing a product, identifier, or reference.

Return to Top

nonInventoryPurchaseItemItemVendor 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
preferredvendorBooleanFalseNoIndicates whether this vendor is the preferred supplier for the item.
purchasepriceStringFalseNoThe standard purchase price of the item.
scheduleStringFalseNoThe pricing or procurement schedule associated with the item.
subsidiaryStringFalseNoThe subsidiary entity associated with the item.
vendorStringFalseNoThe name of the vendor supplying the item.
vendorcodeStringFalseNoThe unique code assigned to the vendor.
vendorcostenteredDecimalFalseNoThe item price as entered by the vendor.
vendorcurrencyidStringFalseNoThe currency in which the vendor's pricing is recorded.

Return to Top

nonInventoryPurchaseItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoAn unlabeled item field, potentially representing a product, identifier, or reference.

Return to Top

nonInventoryPurchaseItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe name or identifier of the item.
displaynameStringFalseNoThe name of the item displayed in listings and online stores.
languageStringFalseNoThe language in which the item details are presented.
nopricemessageStringFalseNoThe message displayed when the item's price is unavailable.
outofstockmessageStringFalseNoThe message displayed when the item is out of stock.
pagetitleStringFalseNoThe title of the webpage where the item is listed.
salesdescriptionStringFalseNoThe description of the item used for sales purposes.
storedescriptionStringFalseNoThe description of the item as shown in the online store.
featureddescriptionStringFalseNoA highlighted description of the item for marketing or promotions.
specialsdescriptionStringFalseNoA description of special promotions or offers related to the item.
storedisplaynameStringFalseNoThe name of the item as displayed in the store.
storedetaileddescriptionStringFalseNoA detailed description of the item for the store listing.

Return to Top

nonInventoryResaleItemCorrelateditem 

NameTypeReadOnlyReferencesFilterOnlyDescription
correlationfldDoubleFalseNoThe correlation percentage indicating the strength of the relationship between variables.
countfldIntegerFalseNoThe total count of occurrences for the given item.
itemStringFalseNoAn unlabeled item field, potentially representing a product or reference.
itemnkeyfldStringFalseNoThe unique key or identifier associated with the item.
liftfldDoubleFalseNoThe lift percentage, representing the impact of the item in predictive analysis.

Return to Top

nonInventoryResaleItemItemAccountingBookDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with financial transactions.
itemStringFalseNoAn unlabeled item field, potentially representing a product, identifier, or reference.

Return to Top

nonInventoryResaleItemItemQuantityPricingDiscount 

NameTypeReadOnlyReferencesFilterOnlyDescription
leveldiscountDoubleFalseNoThe discount percentage or amount applied at a specific price level.
levelpricenameStringFalseNoThe name of the price level associated with the item.
parentitemStringFalseNoThe parent item in a hierarchical item structure.

Return to Top

nonInventoryResaleItemItemQuantityPricingLevel 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
leveldiscountDoubleFalseNoThe discount percentage or amount applied at a specific price level.

Return to Top

nonInventoryResaleItemItemVendor 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
preferredvendorBooleanFalseNoIndicates whether this vendor is the preferred supplier for the item.
purchasepriceStringFalseNoThe standard purchase price of the item.
scheduleStringFalseNoThe pricing or procurement schedule associated with the item.
subsidiaryStringFalseNoThe subsidiary entity associated with the item.
vendorStringFalseNoThe name of the vendor supplying the item.
vendorcodeStringFalseNoThe unique code assigned to the vendor.
vendorcostenteredDecimalFalseNoThe item price as entered by the vendor.
vendorcurrencyidStringFalseNoThe currency in which the vendor's pricing is recorded.

Return to Top

nonInventoryResaleItemPresentationItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
basepriceDecimalFalseNoThe standard base price of the item before any discounts or adjustments.
descriptionStringFalseNoThe description of the item, providing details about its features or purpose.
onlinepriceDecimalFalseNoThe price of the item when sold through an online store or e-commerce platform.
presentationitemStringFalseNoA related item that is presented alongside the main item for cross-selling or upselling.
presitemidIntegerFalseNoThe internal system-generated ID associated with the related item.
superitemStringFalseNoAn unlabeled item field, potentially representing a parent or grouped item.

Return to Top

nonInventoryResaleItemPrice 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencypageStringFalseNoThe currency associated with the item's pricing.
discountdisplayDoubleFalseNoThe default discount percentage applied to the item.
isinactiveBooleanFalseNoIndicates whether the item is inactive and not available for transactions.
itemStringFalseNoThe name or identifier of the item.
priceDecimalFalseNoThe assigned price or amount for the item.

Return to Top

nonInventoryResaleItemQuantity 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
maxcountIntegerFalseNoThe maximum allowable quantity for the item.
mincountIntegerFalseNoThe minimum required quantity for the item.

Return to Top

nonInventoryResaleItemSiteCategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
categorydescriptionStringFalseNoThe description of the item category.
isdefaultBooleanFalseNoIndicates whether this is the preferred or default category for the item.
itemStringFalseNoAn unlabeled item field, potentially representing a product or reference.
websiteStringFalseNoThe website or online platform associated with the item.

Return to Top

nonInventoryResaleItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoAn unlabeled item field, potentially representing a product, identifier, or reference.

Return to Top

nonInventoryResaleItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe name or identifier of the item.
displaynameStringFalseNoThe name of the item displayed in listings and online stores.
languageStringFalseNoThe language in which the item details are presented.
nopricemessageStringFalseNoThe message displayed when the item's price is unavailable.
outofstockmessageStringFalseNoThe message displayed when the item is out of stock.
pagetitleStringFalseNoThe title of the webpage where the item is listed.
salesdescriptionStringFalseNoThe description of the item used for sales purposes.
storedescriptionStringFalseNoThe description of the item as shown in the online store.
featureddescriptionStringFalseNoA highlighted description of the item for marketing or promotions.
specialsdescriptionStringFalseNoA description of special promotions or offers related to the item.
storedisplaynameStringFalseNoThe name of the item as displayed in the store.
storedetaileddescriptionStringFalseNoA detailed description of the item for the store listing.

Return to Top

nonInventorySaleItemCorrelateditem 

NameTypeReadOnlyReferencesFilterOnlyDescription
correlationfldDoubleFalseNoThe correlation percentage indicating the strength of the relationship between variables.
countfldIntegerFalseNoThe total count of occurrences for the given item.
itemStringFalseNoAn unlabeled item field, potentially representing a product or reference.
itemnkeyfldStringFalseNoThe unique key or identifier associated with the item.
liftfldDoubleFalseNoThe lift percentage, representing the impact of the item in predictive analysis.

Return to Top

nonInventorySaleItemItemAccountingBookDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with financial transactions.
itemStringFalseNoAn unlabeled item field, potentially representing a product, identifier, or reference.

Return to Top

nonInventorySaleItemItemQuantityPricingDiscount 

NameTypeReadOnlyReferencesFilterOnlyDescription
leveldiscountDoubleFalseNoThe discount percentage or amount applied at a specific price level.
levelpricenameStringFalseNoThe name of the price level associated with the item.
parentitemStringFalseNoThe parent item in a hierarchical item structure.

Return to Top

nonInventorySaleItemItemQuantityPricingLevel 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
leveldiscountDoubleFalseNoThe discount percentage or amount applied at a specific price level.

Return to Top

nonInventorySaleItemPresentationItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
basepriceDecimalFalseNoThe standard base price of the item before any discounts or adjustments.
descriptionStringFalseNoA detailed description of the item, including its features or purpose.
onlinepriceDecimalFalseNoThe price of the item when sold through an online store or e-commerce platform.
presentationitemStringFalseNoA related item that is presented alongside the main item for cross-selling or upselling.
presitemidIntegerFalseNoThe internal system-generated identifier associated with the related item.
superitemStringFalseNoAn unlabeled item field, potentially representing a parent or grouped item.

Return to Top

nonInventorySaleItemPrice 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencypageStringFalseNoThe currency associated with the item's pricing.
discountdisplayDoubleFalseNoThe default discount percentage applied to the item.
isinactiveBooleanFalseNoIndicates whether the item is inactive and unavailable for transactions.
itemStringFalseNoThe name or identifier of the item.
priceDecimalFalseNoThe assigned price or amount for the item.

Return to Top

nonInventorySaleItemQuantity 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
maxcountIntegerFalseNoThe maximum allowable quantity for the item.
mincountIntegerFalseNoThe minimum required quantity for the item.

Return to Top

nonInventorySaleItemSiteCategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
categorydescriptionStringFalseNoThe description of the item category.
isdefaultBooleanFalseNoIndicates whether this is the preferred or default category for the item.
itemStringFalseNoAn unlabeled item field, potentially representing a product, identifier, or reference.
websiteStringFalseNoThe website or online platform associated with the item.

Return to Top

nonInventorySaleItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoAn unlabeled item field, potentially representing a product, identifier, or reference.

Return to Top

nonInventorySaleItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe name or identifier of the item.
displaynameStringFalseNoThe name of the item displayed in listings and online stores.
featureddescriptionStringFalseNoA highlighted description of the item for marketing or promotions.
languageStringFalseNoThe language in which the item details are presented.
nopricemessageStringFalseNoThe message displayed when the item's price is unavailable.
outofstockmessageStringFalseNoThe message displayed when the item is out of stock.
pagetitleStringFalseNoThe title of the webpage where the item is listed.
salesdescriptionStringFalseNoThe description of the item used for sales purposes.
specialsdescriptionStringFalseNoA description of special promotions or offers related to the item.
storedescriptionStringFalseNoThe description of the item as shown in the online store.
storedetaileddescriptionStringFalseNoA detailed description of the item for the store listing.
storedisplaynameStringFalseNoThe name of the item as displayed in the store.

Return to Top

note 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal system-generated identifier for the record.
accountingperiodStringFalseNoThe accounting period associated with the transaction or record.
activityStringFalseNoThe Customer Relationship Management (CRM) or support-related record linked to the item.
entityStringFalseNoThe entity associated with this record, such as a customer or vendor.
externalidStringFalseNoAn external identifier used for integrations with other systems.
folderStringFalseNoThe folder where this record or file is stored.
itemStringFalseNoThe name or identifier of the item.
mediaStringFalseNoThe media file or attachment linked to this record.
topicStringFalseNoThe subject or topic related to this record.

Return to Top

NoteDirectionType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier or reference key associated with the record.

Return to Top

notetype 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoA detailed description of the record or item.
externalidStringFalseNoAn external identifier used for integrations with other systems.
isinactiveBooleanFalseNoIndicates whether the record or item is inactive.
nameStringFalseNoThe name assigned to the record or item.

Return to Top

NumberFormat 

NameTypeReadOnlyReferencesFilterOnlyDescription
decimalseparatorStringFalseNoThe character used as a decimal separator in numerical values.
groupseparatorStringFalseNoThe character used to separate groups of digits in large numbers.
keyIntegerFalseNoA unique identifier or reference key associated with the record.

Return to Top

NumberingSequenceSubsidMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
numberingStringFalseNoThe general ledger (GL) sequence number used for tracking financial transactions.

Return to Top

OAuthToken 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal system-generated identifier for the record.
binactiveBooleanFalseNoIndicates whether the record is inactive.
brevokedBooleanFalseNoIndicates whether access or permissions have been revoked.
createdbyStringFalseNoThe name or identifier of the user who created the record.
dcreatedDateFalseNoThe date when the record was created.
drevokedDateFalseNoThe date when access or permissions were revoked.
role_nameStringFalseNoThe role associated with the record or user.
tba_app_nameStringFalseNoThe name of the application associated with the token-based authentication (TBA).
tba_token_nameStringFalseNoThe name of the token used for authentication.

Return to Top

onlineFormTemplate 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal system-generated identifier for the record.
contentStringFalseNoThe main content or body of the record.
descriptionStringFalseNoA brief description of the record or media item.
isinactiveBooleanFalseNoIndicates whether the record or media item is inactive.
isprivateBooleanFalseNoIndicates whether the record or media item is private and restricted from public access.
mediaitemStringFalseNoThe associated media file or attachment.
nameStringFalseNoThe name assigned to the record or media item.
subjectStringFalseNoThe subject or title associated with the record.

Return to Top

onlineLeadFormEvent 

NameTypeReadOnlyReferencesFilterOnlyDescription
actionStringFalseNoThe type of action performed in the campaign or customer interaction.
campaigneventStringFalseNoThe specific campaign event associated with the record.
contactStringFalseNoThe contact person linked to the campaign or customer record.
entityStringFalseNoThe customer associated with the campaign event or interaction.
leadsourceStringFalseNoThe source from which the lead was generated.
logdateDateFalseNoThe date when the action or event was logged.

Return to Top

onlineLeadFormField 

NameTypeReadOnlyReferencesFilterOnlyDescription
fielddescriptionStringFalseNoA detailed description of the field and its purpose.
fieldlabelStringFalseNoThe label displayed for the field in the user interface.
iscustomfieldBooleanFalseNoIndicates whether the field is a custom field.
ishiddenBooleanFalseNoIndicates whether the field is hidden from view.
ismandatoryBooleanFalseNoIndicates whether the field is required to be filled.

Return to Top

opportunity 

NameTypeReadOnlyReferencesFilterOnlyDescription
actionitemStringFalseNoThe specific action item related to the transaction or record.
altsalesrangehighDecimalFalseNoThe upper range of the alternative sales amount.
altsalesrangelowDecimalFalseNoThe lower range of the alternative sales amount.
altsalestotalStringFalseNoThe total alternative sales amount.
balanceDecimalFalseNoThe current balance associated with the entity or transaction.
billaddressStringFalseNoThe billing address for the transaction or entity.
billaddresslistStringFalseNoA list of available billing addresses for selection.
billingaddressStringFalseNoThe primary billing address associated with the record.
billisresidentialStringFalseNoIndicates whether the billing address is residential.
buyingreasonStringFalseNoThe reason provided for making a purchase.
buyingtimeframeStringFalseNoThe timeframe in which a purchase is expected to occur.
classStringFalseNoThe classification category assigned to the record or transaction.
consolidatebalanceDecimalFalseNoThe consolidated balance for an entity or account.
createddateDatetimeFalseNoThe date and time when the record was created.
currencyStringFalseNoThe currency used for the transaction or record.
currencynameStringFalseNoThe name of the currency used in the transaction.
currencysymbolStringFalseNoThe symbol of the currency used in the transaction.
customformStringFalseNoThe custom form template used for this record.
departmentStringFalseNoThe department associated with the transaction or entity.
documentstatusStringFalseNoThe current status of the document, such as pending or approved.
entityStringFalseNoThe entity associated with the record, such as a customer or vendor.
entitynexusStringFalseNoThe tax nexus applicable to the entity.
entitystatusStringFalseNoThe status of the entity, such as lead, prospect, or customer.
entitytaxregnumStringFalseNoThe tax registration number associated with the entity.
estgrossprofitDecimalFalseNoThe estimated gross profit from the transaction.
estgrossprofitpercentStringFalseNoThe estimated gross profit percentage.
estimatedbudgetDecimalFalseNoThe estimated budget for the transaction or project.
exchangerateDecimalFalseNoThe exchange rate applied to the transaction.
expectedclosedateDateFalseNoThe expected closing date for the transaction or opportunity.
externalidStringFalseNoAn external identifier used for integrations with other systems.
forecasttypeStringFalseNoThe type of forecast applied to the transaction.
isbasecurrencyBooleanFalseNoIndicates whether the currency is the base currency.
isbudgetapprovedBooleanFalseNoIndicates whether the budget has been approved.
jobStringFalseNoThe job or project associated with the transaction.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified.
leadsourceStringFalseNoThe source from which the lead originated.
locationStringFalseNoThe physical location associated with the transaction.
memoStringFalseNoA memo or note related to the transaction.
nexusStringFalseNoThe tax jurisdiction or nexus applicable to the transaction.
onetimeDecimalFalseNoThe one-time revenue or cost associated with the transaction.
partnerStringFalseNoThe partner associated with the transaction or entity.
probabilityStringFalseNoThe probability percentage of closing a deal or transaction.
projaltsalesamtDecimalFalseNoThe projected alternative sales amount.
projectedtotalDecimalFalseNoThe projected total amount for the transaction.
rangehighDecimalFalseNoThe high-end value of a specified range.
rangelowDecimalFalseNoThe low-end value of a specified range.
recurannuallyDecimalFalseNoThe recurring annual revenue or cost.
recurmonthlyDecimalFalseNoThe recurring monthly revenue or cost.
recurquarterlyDecimalFalseNoThe recurring quarterly revenue or cost.
recurweeklyDecimalFalseNoThe recurring weekly revenue or cost.
salesgroupStringFalseNoThe sales group responsible for the transaction.
salesreadinessStringFalseNoThe readiness level of the sales opportunity.
salesrepStringFalseNoThe sales representative assigned to the transaction.
shipaddressStringFalseNoThe shipping address for the transaction or entity.
shipaddresslistStringFalseNoA list of available shipping addresses for selection.
shipisresidentialStringFalseNoIndicates whether the shipping address is residential.
shipoverrideStringFalseNoIndicates whether the shipping method has been overridden.
shippingaddressStringFalseNoThe primary shipping address associated with the record.
sourceStringFalseNoThe source from which the transaction or record originated.
statusStringFalseNoThe current status of the transaction or opportunity.
statusrefStringFalseNoA reference code for the transaction status.
subsidiaryStringFalseNoThe subsidiary company associated with the record.
subsidiarytaxregnumStringFalseNoThe tax registration number of the subsidiary.
syncpartnerteamsBooleanFalseNoIndicates whether partner teams are synchronized.
syncsalesteamsBooleanFalseNoIndicates whether sales teams are synchronized.
taxdetailsoverrideBooleanFalseNoIndicates whether tax details have been manually overridden.
taxpointdateDateFalseNoThe tax point date used for tax reporting.
taxpointdateoverrideBooleanFalseNoIndicates whether the tax point date has been overridden.
taxregoverrideBooleanFalseNoIndicates whether the tax registration has been overridden.
titleStringFalseNoThe title or designation associated with the record.
totalStringFalseNoThe total amount for the transaction.
totalcostestimateDecimalFalseNoThe estimated total cost of the transaction.
trandateDateFalseNoThe date of the transaction.
tranidStringFalseNoThe transaction identifier or reference number.
unbilledordersDecimalFalseNoThe total value of unbilled orders.
weightedtotalDecimalFalseNoThe weighted total amount based on probability.
winlossreasonStringFalseNoThe reason provided for winning or losing a deal.

Return to Top

opportunityBillingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoAn unlabeled key field, potentially representing a unique identifier.
addr1StringFalseNoThe first line of the address, typically including street name and number.
addr2StringFalseNoThe second line of the address, used for apartment, suite, or building details.
addr3StringFalseNoThe third line of the address, used for additional location details.
addresseeStringFalseNoThe name of the recipient or business at the address.
attentionStringFalseNoThe name of the person or department receiving the correspondence.
cityStringFalseNoThe city where the address is located.
countryStringFalseNoThe country associated with the address.
dropdownstateStringFalseNoThe state or region, selectable from a dropdown menu.
overrideBooleanFalseNoIndicates whether the address can be manually overridden.
stateStringFalseNoThe state or province associated with the address.

Return to Top

OpportunityCompetitor 

NameTypeReadOnlyReferencesFilterOnlyDescription
competitorStringFalseNoThe name of the competitor associated with the opportunity.
notesStringFalseNoAdditional notes or remarks related to the opportunity or competitor.
opportunityStringFalseNoThe sales opportunity linked to the competitor analysis.

Return to Top

opportunityPartner 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage contribution of the partner in the transaction or deal.
isprimaryBooleanFalseNoIndicates whether this is the primary partner for the opportunity.
partnerStringFalseNoThe name or identifier of the partner involved.
partnerroleStringFalseNoThe role assigned to the partner in the transaction or project.

Return to Top

opportunitySalesTeam 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage contribution of the employee in the sales or transaction.
employeeStringFalseNoThe name or identifier of the employee involved.
isprimaryBooleanFalseNoIndicates whether this is the primary employee assigned to the role.
salesroleStringFalseNoThe specific sales role assigned to the employee.

Return to Top

opportunityShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoAn unlabeled key field, potentially representing a unique identifier.
addr1StringFalseNoThe first line of the address, typically including the street name and number.
addr2StringFalseNoThe second line of the address, used for apartment, suite, or building details.
addr3StringFalseNoThe third line of the address, used for additional location details.
addresseeStringFalseNoThe name of the recipient or business at the address.
attentionStringFalseNoThe name of the person or department receiving the correspondence.
cityStringFalseNoThe city where the address is located.
countryStringFalseNoThe country associated with the address.
dropdownstateStringFalseNoThe state or region, selectable from a dropdown menu.
overrideBooleanFalseNoIndicates whether the address can be manually overridden.
stateStringFalseNoThe state or province associated with the address.

Return to Top

orderFrequencyType 

NameTypeReadOnlyReferencesFilterOnlyDescription
defaultnameStringFalseNoThe default name assigned to the record or entity.

Return to Top

orderreservation 

NameTypeReadOnlyReferencesFilterOnlyDescription
allocateddemandDoubleFalseNoThe quantity of demand that has been allocated.
allocatedsupplyDoubleFalseNoThe quantity of supply that has been allocated.
approvalstatusStringFalseNoThe approval status of the transaction or record.
closedBooleanFalseNoIndicates whether the transaction or record is closed.
commitmentfirmBooleanFalseNoIndicates whether the commitment is firm and cannot be changed.
customformStringFalseNoThe custom form template used for this record.
enddateDateFalseNoThe end date of the transaction, process, or record.
externalidStringFalseNoAn external identifier used for integrations with other systems.
idIntegerFalseNoThe internal system-generated identifier for the record.
itemStringFalseNoThe name or identifier of the item associated with the transaction.
locationStringFalseNoThe location associated with the transaction or record.
nameStringFalseNoThe name assigned to the transaction or record.
nextapproverStringFalseNoThe next approver responsible for reviewing the transaction.
orderallocationstrategyStringFalseNoThe strategy used for allocating orders.
orderpriorityDoubleFalseNoThe priority level assigned to the order.
quantityDoubleFalseNoThe total quantity associated with the transaction or record.
quantitycommittedDoubleFalseNoThe quantity that has been committed for the order.
saleschannelStringFalseNoThe sales channel through which the transaction was processed.
startdateDateFalseNoThe start date of the transaction, process, or record.
subsidiaryStringFalseNoThe subsidiary entity associated with the transaction or record.
targetquantityDoubleFalseNoThe target quantity for fulfillment or production.
templatestoredBooleanFalseNoIndicates whether the template has been stored for future use.
tranidStringFalseNoThe transaction identifier or reference number.
transactiondateDateFalseNoThe date the transaction was recorded.
transactionnumberStringFalseNoThe unique transaction number assigned to the record.
unitsStringFalseNoThe unit of measure associated with the item in the transaction.

Return to Top

orderschedule 

NameTypeReadOnlyReferencesFilterOnlyDescription
createpurchaseorderStringFalseNoIndicates whether a purchase order is created for the item or transaction.
createscheduleStringFalseNoSpecifies whether a schedule is generated for the transaction or item.
currencyprecisionIntegerFalseNoThe number of decimal places used for currency values.
enddateDateFalseNoThe end date of the transaction, schedule, or process.
externalidStringFalseNoAn external identifier used for integrations with other systems.
itemIntegerFalseNoThe identifier or reference number for the associated item.
releasefrequencyStringFalseNoThe frequency at which releases or updates occur, such as daily, weekly, or monthly.
startdateDateFalseNoThe start date of the transaction, schedule, or process.
totalDoubleFalseNoThe total amount or quantity associated with the transaction or record.

Return to Top

ordertype 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoA detailed description of the record or entity.
isinactiveBooleanFalseNoIndicates whether the record or entity is inactive.
nameStringFalseNoThe name assigned to the record or entity.

Return to Top

otherchargeitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
amortizationperiodIntegerFalseNoThe number of periods over which the cost is amortized.
amortizationtemplateStringFalseNoThe template used for amortization schedules.
availabletopartnersBooleanFalseNoIndicates whether the item is available to partners.
billexchratevarianceacctStringFalseNoThe account used for bill exchange rate variance adjustments.
billingscheduleStringFalseNoThe billing schedule applied to this item.
billpricevarianceacctStringFalseNoThe account for tracking price variances on bills.
billqtyvarianceacctStringFalseNoThe account for tracking quantity variances on bills.
classStringFalseNoThe classification category assigned to the item.
consumptionunitStringFalseNoThe unit of measurement for item consumption, such as liters or kilograms.
contingentrevenuehandlingBooleanFalseNoIndicates whether revenue recognition is contingent on conditions being met.
costDecimalFalseNoThe base cost of the item.
costcategoryStringFalseNoThe cost category associated with the item.
costestimateDecimalFalseNoThe estimated cost of the item based on standard calculations.
costestimatetypeStringFalseNoThe method used to estimate costs, such as standard or average.
costunitsStringFalseNoThe unit of measurement for cost calculations.
createddateDatetimeFalseNoThe date and time when the record was created.
createrevenueplansonStringFalseNoSpecifies when revenue plans should be created for this item.
currencyStringFalseNoThe currency associated with the item's financial transactions.
customformStringFalseNoThe custom form used for entering or displaying this record.
deferralaccountStringFalseNoThe account used for deferring revenue or expenses.
deferredrevenueaccountStringFalseNoThe account used for recognizing deferred revenue.
deferrevrecBooleanFalseNoIndicates whether revenue recognition should be deferred.
departmentStringFalseNoThe department associated with this item.
directrevenuepostingBooleanFalseNoIndicates whether revenue is posted directly to accounts without deferrals.
displaynameStringFalseNoThe name displayed for the item in listings and reports.
enforceminqtyinternallyBooleanFalseNoSpecifies if the system enforces a minimum quantity for transactions.
expenseaccountStringFalseNoThe account used for tracking expenses related to the item.
externalidStringFalseNoAn external identifier for integration with other systems.
generateaccrualsBooleanFalseNoSpecifies if accruals should be automatically generated for this item.
includechildrenBooleanFalseNoSpecifies if child items should be included in item listings.
incomeaccountStringFalseNoThe income account associated with the item.
intercodefrevaccountStringFalseNoThe intercompany deferred revenue account for financial transactions.
intercoexpenseaccountStringFalseNoThe intercompany expense account used for cost tracking.
intercoincomeaccountStringFalseNoThe intercompany income account for revenue tracking.
isfulfillableBooleanFalseNoSpecifies if this item can be fulfilled through standard order processing.
isgcocompliantBooleanFalseNoIndicates whether the item complies with Google Checkout requirements.
isinactiveBooleanFalseNoIndicates whether the item is inactive in the system.
isonlineBooleanFalseNoSpecifies if the item is available for online sales.
issueproductStringFalseNoThe associated product that is issued as part of this item.
itemidStringFalseNoThe unique identifier for the item in the system.
itemoptionsStringFalseNoThe available options or variations for the item.
itemrevenuecategoryStringFalseNoThe revenue category assigned to this item.
itemtypeStringFalseNoThe type of item, such as inventory, service, or non-inventory.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified.
locationStringFalseNoThe physical location associated with the item.
matrixitemnametemplateStringFalseNoThe template used for naming matrix items.
matrixtypeStringFalseNoIndicates whether the item is a matrix parent or child.
maximumquantityStringFalseNoThe highest quantity of this item that can be purchased in a single transaction.
minimumquantityStringFalseNoThe minimum quantity of this item that can be purchased in a single transaction.
minimumquantityunitsStringFalseNoThe unit of measure associated with the minimum quantity.
mossappliesBooleanFalseNoIndicates whether the Mini One Stop Shop (MOSS) VAT rules apply to this item.
offersupportBooleanFalseNoIndicates whether customer support is offered for this item.
overallquantitypricingtypeStringFalseNoThe pricing strategy applied based on total quantity purchased.
overheadtypeStringFalseNoThe type of overhead costs associated with the item.
parentStringFalseNoThe parent item in a hierarchical product structure.
pricinggroupStringFalseNoThe pricing group to which the item belongs.
purchasedescriptionStringFalseNoThe description of the item used in purchase transactions.
purchaseorderamountStringFalseNoThe total amount associated with purchase orders for this item.
purchaseorderquantityStringFalseNoThe quantity of this item specified in purchase orders.
purchaseorderquantitydiffStringFalseNoThe variance between ordered and received quantities.
purchaseunitStringFalseNoThe unit of measure used for purchasing this item.
quantitypricingscheduleStringFalseNoThe pricing schedule based on purchase quantity tiers.
receiptamountStringFalseNoThe total value of received inventory for this item.
receiptquantityStringFalseNoThe total quantity of this item received.
receiptquantitydiffStringFalseNoThe difference between expected and received item quantities.
residualStringFalseNoThe remaining value or cost after deductions.
revenueallocationgroupStringFalseNoThe group used for revenue allocation across multiple items.
revenuerecognitionruleStringFalseNoThe rule governing when and how revenue is recognized.
revrecforecastruleStringFalseNoThe rule used for forecasting revenue recognition.
revreclassfxaccountStringFalseNoThe account used for foreign exchange reclassification of revenue.
revrecscheduleStringFalseNoThe schedule for recognizing revenue over time.
salesdescriptionStringFalseNoThe description of the item used in sales transactions.
saleunitStringFalseNoThe unit of measure used when selling this item.
softdescriptorStringFalseNoThe billing descriptor that appears on customer statements.
subsidiaryStringFalseNoThe subsidiary entity associated with the item.
subtypeStringFalseNoThe subtype of the item, if applicable.
taxscheduleStringFalseNoThe tax schedule that applies to this item.
unitstypeStringFalseNoThe type of unit measurement used for the item.
upccodeStringFalseNoThe Universal Product Code (UPC) assigned to the item.
usemarginalratesBooleanFalseNoIndicates whether marginal tax rates are applied to this item.
vendornameStringFalseNoThe name of the vendor supplying this item.
vsoedeferralStringFalseNoThe method used for deferring revenue under VSOE rules.
vsoedeliveredBooleanFalseNoIndicates whether the item has been delivered under VSOE accounting rules.
vsoepermitdiscountStringFalseNoSpecifies if discounts are permitted under VSOE rules.
vsoepriceDecimalFalseNoThe VSOE-compliant price of the item.
vsoesopgroupStringFalseNoThe VSOE Statement of Position group assigned to the item.

Return to Top

otherChargeItemItemAccountingBookDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with financial transactions.
itemStringFalseNoAn unlabeled item field, potentially representing a product, identifier, or reference.

Return to Top

otherChargeItemItemQuantityPricingDiscount 

NameTypeReadOnlyReferencesFilterOnlyDescription
leveldiscountDoubleFalseNoThe discount percentage or amount applied at a specific price level.
levelpricenameStringFalseNoThe name of the price level associated with the item.
parentitemStringFalseNoThe parent item in a hierarchical item structure.

Return to Top

otherChargeItemItemQuantityPricingLevel 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
leveldiscountDoubleFalseNoThe discount percentage or amount applied at a specific price level.

Return to Top

otherChargeItemItemVendor 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
preferredvendorBooleanFalseNoIndicates whether this vendor is the preferred supplier for the item.
purchasepriceStringFalseNoThe standard purchase price of the item.
scheduleStringFalseNoThe pricing or procurement schedule associated with the item.
subsidiaryStringFalseNoThe subsidiary entity associated with the item.
vendorStringFalseNoThe name of the vendor supplying the item.
vendorcodeStringFalseNoThe unique code assigned to the vendor.
vendorcostenteredDecimalFalseNoThe item price as entered by the vendor.
vendorcurrencyidStringFalseNoThe currency in which the vendor's pricing is recorded.

Return to Top

otherChargeItemPrice 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencypageStringFalseNoThe currency associated with the item's pricing.
discountdisplayDoubleFalseNoThe default discount percentage applied to the item.
isinactiveBooleanFalseNoIndicates whether the item is inactive and unavailable for transactions.
itemStringFalseNoThe name or identifier of the item.
priceDecimalFalseNoThe assigned price or amount for the item.

Return to Top

otherChargeItemQuantity 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
maxcountIntegerFalseNoThe maximum allowable quantity for the item.
mincountIntegerFalseNoThe minimum required quantity for the item.

Return to Top

otherChargeItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoAn unlabeled item field, potentially representing a product, identifier, or reference.

Return to Top

otherChargeItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe name or identifier of the item.
displaynameStringFalseNoThe name of the item displayed in listings and online stores.
languageStringFalseNoThe language in which the item details are presented.
nopricemessageStringFalseNoThe message displayed when the item's price is unavailable.
outofstockmessageStringFalseNoThe message displayed when the item is out of stock.
pagetitleStringFalseNoThe title of the webpage where the item is listed.
salesdescriptionStringFalseNoThe description of the item used for sales purposes.
storedescriptionStringFalseNoThe description of the item as shown in the online store.
featureddescriptionStringFalseNoA highlighted description of the item for marketing or promotions.
specialsdescriptionStringFalseNoA description of special promotions or offers related to the item.
storedisplaynameStringFalseNoThe name of the item as displayed in the store.
storedetaileddescriptionStringFalseNoA detailed description of the item for the store listing.

Return to Top

otherChargePurchaseItemItemAccountingBookDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with financial transactions.
itemStringFalseNoAn unlabeled item field, potentially representing a product, identifier, or reference.

Return to Top

otherChargePurchaseItemItemVendor 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
preferredvendorBooleanFalseNoIndicates whether this vendor is the preferred supplier for the item.
purchasepriceStringFalseNoThe standard purchase price of the item.
scheduleStringFalseNoThe pricing or procurement schedule associated with the item.
subsidiaryStringFalseNoThe subsidiary entity associated with the item.
vendorStringFalseNoThe name of the vendor supplying the item.
vendorcodeStringFalseNoThe unique code assigned to the vendor.
vendorcostenteredDecimalFalseNoThe item price as entered by the vendor.
vendorcurrencyidStringFalseNoThe currency in which the vendor's pricing is recorded.

Return to Top

otherChargePurchaseItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoAn unlabeled item field, potentially representing a product, identifier, or reference.

Return to Top

otherChargePurchaseItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe name or identifier of the item.
displaynameStringFalseNoThe name of the item displayed in listings and online stores.
languageStringFalseNoThe language in which the item details are presented.
nopricemessageStringFalseNoThe message displayed when the item's price is unavailable.
outofstockmessageStringFalseNoThe message displayed when the item is out of stock.
pagetitleStringFalseNoThe title of the webpage where the item is listed.
salesdescriptionStringFalseNoThe description of the item used for sales purposes.
storedescriptionStringFalseNoThe description of the item as shown in the online store.
featureddescriptionStringFalseNoA highlighted description of the item for marketing or promotions.
specialsdescriptionStringFalseNoA description of special promotions or offers related to the item.
storedisplaynameStringFalseNoThe name of the item as displayed in the store.
storedetaileddescriptionStringFalseNoA detailed description of the item for the store listing.

Return to Top

otherChargeResaleItemItemAccountingBookDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with financial transactions.
itemStringFalseNoAn unlabeled item field, potentially representing a product, identifier, or reference.

Return to Top

otherChargeResaleItemItemQuantityPricingDiscount 

NameTypeReadOnlyReferencesFilterOnlyDescription
leveldiscountDoubleFalseNoThe discount percentage or amount applied at a specific price level.
levelpricenameStringFalseNoThe name of the price level associated with the item.
parentitemStringFalseNoThe parent item in a hierarchical item structure.

Return to Top

otherChargeResaleItemItemQuantityPricingLevel 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
leveldiscountDoubleFalseNoThe discount percentage or amount applied at a specific price level.

Return to Top

otherChargeResaleItemItemVendor 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
preferredvendorBooleanFalseNoIndicates whether this vendor is the preferred supplier for the item.
purchasepriceStringFalseNoThe standard purchase price of the item.
scheduleStringFalseNoThe pricing or procurement schedule associated with the item.
subsidiaryStringFalseNoThe subsidiary entity associated with the item.
vendorStringFalseNoThe name of the vendor supplying the item.
vendorcodeStringFalseNoThe unique code assigned to the vendor.
vendorcostenteredDecimalFalseNoThe item price as entered by the vendor.
vendorcurrencyidStringFalseNoThe currency in which the vendor's pricing is recorded.

Return to Top

otherChargeResaleItemPrice 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencypageStringFalseNoThe currency associated with the item's pricing.
discountdisplayDoubleFalseNoThe default discount percentage applied to the item.
isinactiveBooleanFalseNoIndicates whether the item is inactive and unavailable for transactions.
itemStringFalseNoThe name or identifier of the item.
priceDecimalFalseNoThe assigned price or amount for the item.

Return to Top

otherChargeResaleItemQuantity 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
maxcountIntegerFalseNoThe maximum allowable quantity for the item.
mincountIntegerFalseNoThe minimum required quantity for the item.

Return to Top

otherChargeResaleItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoAn unlabeled item field, potentially representing a product, identifier, or reference.

Return to Top

otherChargeResaleItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe name or identifier of the item.
displaynameStringFalseNoThe name of the item displayed in listings and online stores.
featureddescriptionStringFalseNoA highlighted description of the item for marketing or promotions.
languageStringFalseNoThe language in which the item details are presented.
nopricemessageStringFalseNoThe message displayed when the item's price is unavailable.
outofstockmessageStringFalseNoThe message displayed when the item is out of stock.
pagetitleStringFalseNoThe title of the webpage where the item is listed.
salesdescriptionStringFalseNoThe description of the item used for sales purposes.
specialsdescriptionStringFalseNoA description of special promotions or offers related to the item.
storedescriptionStringFalseNoThe description of the item as shown in the online store.
storedetaileddescriptionStringFalseNoA detailed description of the item for the store listing.
storedisplaynameStringFalseNoThe name of the item as displayed in the store.

Return to Top

otherChargeSaleItemItemAccountingBookDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with financial transactions.
itemStringFalseNoAn unlabeled item field, potentially representing a product, identifier, or reference.

Return to Top

otherChargeSaleItemItemQuantityPricingDiscount 

NameTypeReadOnlyReferencesFilterOnlyDescription
leveldiscountDoubleFalseNoThe discount percentage or amount applied at a specific price level.
levelpricenameStringFalseNoThe name of the price level associated with the item.
parentitemStringFalseNoThe parent item in a hierarchical item structure.

Return to Top

otherChargeSaleItemItemQuantityPricingLevel 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
leveldiscountDoubleFalseNoThe discount percentage or amount applied at a specific price level.

Return to Top

otherChargeSaleItemPrice 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencypageStringFalseNoThe currency associated with the item's pricing.
discountdisplayDoubleFalseNoThe default discount percentage applied to the item.
isinactiveBooleanFalseNoIndicates whether the item is inactive and unavailable for transactions.
itemStringFalseNoThe name or identifier of the item.
priceDecimalFalseNoThe assigned price or amount for the item.

Return to Top

otherChargeSaleItemQuantity 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item.
maxcountIntegerFalseNoThe maximum allowable quantity for the item.
mincountIntegerFalseNoThe minimum required quantity for the item.

Return to Top

otherChargeSaleItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoAn unlabeled item field, potentially representing a product, identifier, or reference.

Return to Top

otherChargeSaleItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe name or identifier of the item.
displaynameStringFalseNoThe name of the item displayed in listings and online stores.
languageStringFalseNoThe language in which the item details are presented.
nopricemessageStringFalseNoThe message displayed when the item's price is unavailable.
outofstockmessageStringFalseNoThe message displayed when the item is out of stock.
pagetitleStringFalseNoThe title of the webpage where the item is listed.
salesdescriptionStringFalseNoThe description of the item used for sales purposes.
storedescriptionStringFalseNoThe description of the item as shown in the online store.
featureddescriptionStringFalseNoA highlighted description of the item for marketing or promotions.
specialsdescriptionStringFalseNoA description of special promotions or offers related to the item.
storedisplaynameStringFalseNoThe name of the item as displayed in the store.
storedetaileddescriptionStringFalseNoA detailed description of the item for the store listing.

Return to Top

othername 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal system-generated identifier for the record.
accountnumberStringFalseNoThe unique account identifier associated with the entity.
altemailStringFalseNoThe alternative email address for the contact.
altnameStringFalseNoAn alternate or secondary name for the entity.
categoryStringFalseNoThe category or classification assigned to the entity.
commentsStringFalseNoAdditional comments or notes related to the entity.
companynameStringFalseNoThe name of the company associated with the entity.
contactStringFalseNoThe primary contact person for the entity.
contactlistStringFalseNoA list of contacts associated with the entity.
creditlimitDecimalFalseNoThe maximum credit limit extended to the entity.
currencyStringFalseNoThe currency used for financial transactions with the entity.
datecreatedDateFalseNoThe date when the entity record was created.
defaultbillingaddressStringFalseNoThe default billing address for the entity.
defaultshippingaddressStringFalseNoThe default shipping address for the entity.
emailStringFalseNoThe email address associated with the entity or contact.
emailpreferenceStringFalseNoThe preferred method for receiving emails from the entity.
entityidStringFalseNoThe unique identifier assigned to the entity.
entitynumberIntegerFalseNoThe number assigned to the entity for internal tracking.
entitytitleStringFalseNoThe title associated with the entity or other name.
externalidStringFalseNoAn external identifier used for integrations with other systems.
firstnameStringFalseNoThe first name of the entity or individual.
globalsubscriptionstatusStringFalseNoThe global subscription status of the entity.
isinactiveBooleanFalseNoIndicates whether the entity is inactive and not currently in use.
ispersonBooleanFalseNoIndicates whether the entity is an individual (person) or not.
lastmodifieddateDateFalseNoThe date and time when the entity record was last modified.
lastnameStringFalseNoThe last name of the individual associated with the entity.
middlenameStringFalseNoThe middle name of the individual associated with the entity.
phoneticnameStringFalseNoThe phonetic version of the entity's name.
printoncheckasStringFalseNoThe name to be printed on checks issued to the entity.
salutationStringFalseNoThe formal salutation used for addressing the individual (for example, Mr., Ms.).
termsStringFalseNoThe payment terms associated with the entity.
titleStringFalseNoThe job title or role of the individual associated with the entity.

Return to Top

otherNameAddressbook 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoThe internal system-generated identifier for the record.
addressbookaddressStringFalseNoThe address associated with the entity in the address book.
defaultbillingBooleanFalseNoIndicates whether the address is set as the default billing address.
defaultshippingBooleanFalseNoIndicates whether the address is set as the default shipping address.
entityStringFalseNoThe name or identifier of the entity associated with the address.

Return to Top

otherNameAddressbookEntityAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoAn unlabeled key field, potentially representing a unique identifier.
addr1StringFalseNoThe first line of the address, typically including the street name and number.
addr2StringFalseNoThe second line of the address, used for apartment, suite, or building details.
addr3StringFalseNoThe third line of the address, used for additional location details.
addresseeStringFalseNoThe name of the recipient or business at the address.
attentionStringFalseNoThe name of the person or department receiving the correspondence.
cityStringFalseNoThe city where the address is located.
countryStringFalseNoThe country associated with the address.
dropdownstateStringFalseNoThe state or region, selectable from a dropdown menu.
overrideBooleanFalseNoIndicates whether the address can be manually overridden.
stateStringFalseNoThe state or province associated with the address.

Return to Top

otherNameBulkMerge 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoAn unlabeled field representing an entity, potentially a customer or other record.
mergedateDateFalseNoThe date and time when the records or entities were merged.
mergetypeStringFalseNoThe type of merge that was performed, such as full or partial merge.
statusStringFalseNoThe current status of the entity or record, such as active or inactive.
subjectStringFalseNoThe subject or topic associated with the entity or record.
templateStringFalseNoThe template used for the entity or record, such as email or document template.
usernameStringFalseNoAn unlabeled field representing the username associated with the entity.

Return to Top

otherNameCampaigns 

NameTypeReadOnlyReferencesFilterOnlyDescription
campaignStringFalseNoThe name or identifier of the campaign associated with the record.
campaigneventStringFalseNoThe specific event within the campaign, such as a launch or follow-up.
categoryStringFalseNoThe category or classification assigned to the campaign or event.
contactStringFalseNoThe contact person associated with the campaign or event.
datesentDateFalseNoThe date when the campaign or event was sent or initiated.
entityStringFalseNoAn unlabeled field potentially representing an entity, such as a customer or lead.
responseStringFalseNoDetails or content of the response received from the contact or entity.
responsedateDateFalseNoThe date when the response was received.

Return to Top

othernamecategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal system-generated identifier for the record.
externalidStringFalseNoAn external identifier used for integrations with other systems.
isinactiveBooleanFalseNoIndicates whether the record is inactive and unavailable for use.

Return to Top

otherNameCompanyContact 

NameTypeReadOnlyReferencesFilterOnlyDescription
contactStringFalseNoThe name or identifier of the contact person associated with the record.

Return to Top

otherNameSubscriptionMessageHistory 

NameTypeReadOnlyReferencesFilterOnlyDescription
emailStringFalseNoThe email address associated with the contact or communication.
memoStringFalseNoAdditional notes or comments related to the email or communication.
recipientStringFalseNoThe name or identifier of the recipient of the communication.
senddateDateFalseNoThe date when the email or communication was sent.
senderStringFalseNoThe name or identifier of the sender of the email or communication.

Return to Top

otherNameSubscriptions 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoThe entity associated with the record, such as a customer, lead, or other entity.
lastmodifieddateDateFalseNoThe date when the record was last modified.
subscriptionStringFalseNoThe campaign or service subscription associated with the entity.

Return to Top

OtherNameSubsidiaryRelationship 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal system-generated identifier for the record.
entityStringFalseNoThe entity associated with the record, such as a customer, lead, or other entity.
externalidStringFalseNoAn external identifier used for integrations with other systems.
isprimarysubBooleanFalseNoIndicates whether the entity is the primary subsidiary in a multi-subsidiary setup.
nameStringFalseNoAn unlabeled field representing the name of the entity or record.

Return to Top

outboundRequest 

NameTypeReadOnlyReferencesFilterOnlyDescription
elapsedIntegerFalseNoThe elapsed time in milliseconds for the request or process.
errorStringFalseNoThe error message or code associated with the request or process.
hostStringFalseNoThe hostname of the server processing the request.
keyIntegerFalseNoThe internal system-generated identifier for the record.
portIntegerFalseNoThe port number used for the connection.
protocolStringFalseNoThe communication protocol used, such as HTTP or HTTPS.
requestcontentlengthIntegerFalseNoThe length, in bytes, of the request content.
requestcontenttypeStringFalseNoThe type of content sent in the request, such as JSON or XML.
requestidStringFalseNoThe unique identifier for the request.
responsecontentlengthIntegerFalseNoThe length, in bytes, of the response content.
responsecontenttypeStringFalseNoThe type of content returned in the response, such as JSON or XML.
scriptdeploymenturlStringFalseNoThe URL for the script deployment associated with the request.
scriptidStringFalseNoThe unique identifier for the script being executed.
statuscodeIntegerFalseNoThe HTTP status code returned with the response.
timeDateFalseNoThe date and time when the request was processed.

Return to Top

overallQuantityPricingType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier or reference key associated with the record.

Return to Top

overheadType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoThe internal system-generated identifier for the record.

Return to Top

parametersAction 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]StringFalseNoUnique identifier for the record in the system, used to reference and distinguish individual entries.
accesslevelStringFalseNoDefines the level of access granted to the record, such as read, write, or admin access.
labelStringFalseNoThe display name or title given to the record, typically shown in the user interface.
ownerStringFalseNoThe individual or entity responsible for managing or controlling the record.
searchlevelStringFalseNoDetermines the visibility or accessibility of the record in search results, often used for filtering.
selectrecordtypeStringFalseNoSpecifies the type of list or record that the entry is associated with, such as a customer or transaction.
settingStringFalseNoRefers to configuration preferences or options that control system behavior or user settings.

Return to Top

parametersBundleInstallation 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]StringFalseNoA unique identifier assigned to each record in the system, used to distinguish one entry from another.
accesslevelStringFalseNoThe permission level that controls user access to the record, such as read-only or full access.
labelStringFalseNoThe descriptive name or title assigned to the record, which is typically displayed in the user interface.
ownerStringFalseNoThe person, department, or entity responsible for the management or control of the record.
searchlevelStringFalseNoThe ranking or visibility of the record in search results, often determining its availability for filtering or categorization.
selectrecordtypeStringFalseNoIndicates the type of record or list to which the current entry belongs, such as customer, transaction, or item.
settingStringFalseNoThe configuration options or preferences that define system behavior or user-specific settings.

Return to Top

parametersClient 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]StringFalseNoA unique identifier for the record within the system, used to reference and track individual entries.
accesslevelStringFalseNoDefines the level of access granted to the record, such as read-only, edit, or full administrative rights.
labelStringFalseNoThe name or title displayed for the record in user interfaces or reports.
ownerStringFalseNoThe user or entity that is assigned responsibility for the record, often related to data ownership or management.
searchlevelStringFalseNoIndicates how visible the record is in search results, affecting its discoverability or use in filtered queries.
selectrecordtypeStringFalseNoSpecifies the type of record or list associated with this entry, such as customer, transaction, or item.
settingStringFalseNoRepresents a system preference or configuration option that defines how the system behaves or how records are handled.

Return to Top

parametersMapReduce 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]StringFalseNoA unique identifier assigned to each record within the system, used to track and differentiate entries.
accesslevelStringFalseNoIndicates the level of access granted to the record, such as viewing, editing, or full administrative permissions.
labelStringFalseNoA descriptive name or title for the record, typically displayed in the user interface for identification.
ownerStringFalseNoThe individual or entity responsible for managing or overseeing the record within the system.
searchlevelStringFalseNoDetermines the visibility of the record in search results, influencing its accessibility for search filters.
selectrecordtypeStringFalseNoSpecifies the category or type of list or record to which the entry belongs, such as customer, transaction, or item.
settingStringFalseNoRepresents a configurable preference or option that influences system behavior or user settings.

Return to Top

parametersMassUpdate 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]StringFalseNoA unique identifier assigned to each record in the system, used to distinctly reference and locate individual entries.
accesslevelStringFalseNoDefines the level of access associated with the record, determining user permissions such as read-only, edit, or full administrative access.
labelStringFalseNoThe name or title assigned to the record, typically displayed in the user interface for easy identification by users.
ownerStringFalseNoThe user or organization responsible for the record, often reflecting the entity that manages or controls the data.
searchlevelStringFalseNoSpecifies the visibility of the record within search results, influencing its discoverability when filtering or querying records.
selectrecordtypeStringFalseNoIndicates the type or category of list or record associated with the entry, such as customer, transaction, or item.
settingStringFalseNoRepresents a system preference or configuration that adjusts the behavior of the system or modifies user-specific settings.

Return to Top

parametersPortlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]StringFalseNoA unique identifier assigned to each record in the system, used to reference individual entries and differentiate them from others.
accesslevelStringFalseNoSpecifies the level of access granted to the record, such as whether it can be viewed, edited, or administratively controlled.
labelStringFalseNoThe descriptive name or title assigned to the record, typically displayed in the system's user interface for easier identification.
ownerStringFalseNoThe individual or entity responsible for managing, maintaining, or controlling the record within the system.
searchlevelStringFalseNoIndicates how visible the record is in search results, affecting its accessibility or appearance when users query the system.
selectrecordtypeStringFalseNoDefines the type of record or list this entry belongs to, such as a customer, transaction, or other classification.
settingStringFalseNoRefers to configuration preferences or options that control the behavior of the system or adjust user-specific settings.

Return to Top

parametersRestlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]StringFalseNoA unique identifier for each record in the system, essential for referencing and managing individual entries.
accesslevelStringFalseNoThe level of access granted to a user or process for the record, determining permissions such as viewing, editing, or full administrative rights.
labelStringFalseNoA descriptive title or name given to the record, used for identification and display in the system's user interface.
ownerStringFalseNoThe user or organization responsible for managing the record, typically reflecting the entity that controls the data.
searchlevelStringFalseNoIndicates the visibility of the record in search results, helping to control which records are accessible or shown when querying the system.
selectrecordtypeStringFalseNoSpecifies the category or type of record that this entry represents, such as customer, transaction, or item.
settingStringFalseNoA system preference or configuration that influences how the system operates or how records are handled based on user-defined parameters.

Return to Top

parametersScheduled 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]StringFalseNoA unique identifier assigned to each record within the system, used for distinguishing and referencing individual entries.
accesslevelStringFalseNoThe level of access granted to users or roles for the record, indicating whether it can be viewed, edited, or fully controlled.
labelStringFalseNoThe name or title given to the record, typically displayed in user interfaces for easier identification and selection.
ownerStringFalseNoThe person, group, or entity responsible for managing or controlling the record, often tied to data governance or accountability.
searchlevelStringFalseNoDefines how visible or accessible the record is within search results, influencing its discoverability based on defined filters.
selectrecordtypeStringFalseNoIndicates the category or type of list or record associated with the entry, such as a customer, transaction, or item.
settingStringFalseNoRepresents a configurable preference or option that affects how the system behaves or customizes user settings.

Return to Top

parametersScript 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]StringFalseNoA unique identifier assigned to each record, allowing for distinct referencing and management of individual entries within the system.
accesslevelStringFalseNoSpecifies the level of access granted to the record (such as view, edit, or full administrative permissions), defining the scope of user interactions.
labelStringFalseNoThe name or title given to the record, often used in the system's user interface for easy identification and selection by users.
ownerStringFalseNoThe individual, department, or entity responsible for the record, typically reflecting who manages or has control over the data.
searchlevelStringFalseNoDetermines the visibility of the record in search results, affecting how easily it can be found or filtered during queries.
selectrecordtypeStringFalseNoIdentifies the type or category of the record (such as customer, transaction, or inventory item), to clarify its role in the system.
settingStringFalseNoRepresents configuration preferences or options that control system behavior, user interface customization, or other application-level settings.

Return to Top

parametersSuitelet 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]StringFalseNoA unique identifier for each record in the system, used to distinguish and track individual entries across processes and systems.
accesslevelStringFalseNoDefines the level of access associated with the record, determining the permissions granted to users or roles, such as view-only, edit, or full control.
labelStringFalseNoThe name or title given to the record, displayed in the user interface for easy identification by users and in reports or lists.
ownerStringFalseNoThe individual, department, or entity assigned responsibility for managing and maintaining the record within the system.
searchlevelStringFalseNoIndicates the visibility or accessibility of the record within search results, controlling its prominence or inclusion in filtered queries.
selectrecordtypeStringFalseNoSpecifies the category or type of record (such as customer, transaction, or item), helping define its role and usage in the system.
settingStringFalseNoRepresents configurable preferences or system settings that influence how records are managed, displayed, or interacted with in the application.

Return to Top

parametersUserEvent 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]StringFalseNoA unique identifier for the record in the system, used to reference and distinguish individual entries within databases and transactions.
accesslevelStringFalseNoSpecifies the access permissions for the record, determining whether users can view, edit, or manage it based on their role.
labelStringFalseNoThe name or title of the record, displayed in the user interface to help users easily identify the record among others.
ownerStringFalseNoThe individual or entity responsible for maintaining and managing the record, often associated with data governance and control.
searchlevelStringFalseNoIndicates the visibility and filtering priority of the record in search results, influencing its discoverability in system queries.
selectrecordtypeStringFalseNoIndicates the type of record or list this entry belongs to, such as customer, transaction, or inventory item.
settingStringFalseNoRepresents configuration options or user-specific preferences that control how records are handled, displayed, or processed within the system.

Return to Top

partner 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to each record in the system for tracking and reference.
altemailStringFalseNoAn alternative email address associated with the entity, used for secondary communications.
altnameStringFalseNoAn alternate name for the partner, often used for referencing the partner in different contexts or systems.
categoryStringFalseNoThe classification or group to which the partner belongs, used for organizational and reporting purposes.
classStringFalseNoThe classification or category used to group partners based on shared characteristics or attributes.
commentsStringFalseNoA field for additional notes or comments related to the partner, typically used for internal records.
companynameStringFalseNoThe name of the company associated with the partner, often used for formal references in business dealings.
contactStringFalseNoThe primary point of contact for the partner, typically the main representative or liaison.
contactlistStringFalseNoA list of contacts associated with the partner, including multiple people for communication purposes.
datecreatedDateFalseNoThe date the partner record was created in the system, used for tracking record history.
defaultbillingaddressStringFalseNoThe default billing address for the partner, used for invoicing and financial communications.
defaultshippingaddressStringFalseNoThe default shipping address for the partner, used for fulfillment and logistics.
departmentStringFalseNoThe department within the partner’s organization that the partner record is associated with.
duplicateBooleanFalseNoIndicates whether the partner record is a duplicate entry in the system, used to flag and prevent redundancy.
emailStringFalseNoThe primary email address for the partner, used for direct communication and notifications.
emailpreferenceStringFalseNoThe partner's preference for receiving email communications, such as marketing, updates, or transaction-related messages.
entityidStringFalseNoA unique identifier for the partner entity, used for referencing the partner in reports and transactions.
entitynumberIntegerFalseNoA sequential number assigned to the partner entity, typically used for organizational or reporting purposes.
entitytitleStringFalseNoA title or label associated with the partner, used for formal references such as 'Partner ID' or 'Customer ID.'
externalidStringFalseNoA unique identifier assigned to the partner by an external system, used for integration purposes.
firstnameStringFalseNoThe first name of the primary contact or individual associated with the partner record.
giveaccessBooleanFalseNoIndicates whether the partner has login access to the system, allowing them to access the portal or manage their own data.
globalsubscriptionstatusStringFalseNoThe status of the partner's global subscription, such as active, pending, or expired.
isinactiveBooleanFalseNoIndicates whether the partner is currently inactive, often used for filtering out non-active records in reports.
ispersonBooleanFalseNoSpecifies whether the partner is an individual person or an organization, affecting how the record is managed.
lastmodifieddateDateFalseNoThe date when the partner record was last modified, used for auditing and tracking changes.
lastnameStringFalseNoThe last name of the primary contact or individual associated with the partner record.
locationStringFalseNoThe geographical location of the partner, used for logistical and regional grouping purposes.
middlenameStringFalseNoThe middle name of the primary contact or individual associated with the partner record.
parentStringFalseNoIdentifies the parent partner or organization, used to indicate hierarchical relationships between entities.
partnercodeStringFalseNoA unique code assigned to the partner, typically used for internal tracking or identification in business processes.
phoneticnameStringFalseNoThe phonetic or pronunciation of the partner's name, often used in languages like Japanese (for example, Furigana).
printoncheckasStringFalseNoThe name or title to be printed on checks or financial documents, typically used for formal transactions.
salutationStringFalseNoThe salutation used for addressing the partner, such as Mr., Ms., or Dr.
subpartnerloginBooleanFalseNoIndicates whether the partner can provide login access to sub-partners, granting them access to associated records.
titleStringFalseNoThe job title or position held by the primary contact or individual associated with the partner record.

Return to Top

PartnerAddressbook 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoA unique internal identifier assigned to each record, used for tracking and distinguishing individual entries within the system.
addressbookaddressStringFalseNoThe address associated with the partner or entity, typically used for communication or shipping purposes.
defaultbillingBooleanFalseNoIndicates whether this address is the default billing address for the entity, used for invoicing and payment purposes.
defaultshippingBooleanFalseNoIndicates whether this address is the default shipping address for the entity, used for fulfillment and delivery.
entityStringFalseNoThe entity associated with the address (such as a customer, partner, or company), used to reference the organization or individual.

Return to Top

PartnerAddressbookEntityAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique key or identifier for the record, often used for internal tracking or system operations.
addr1StringFalseNoThe first line of the address, typically used for the street address or primary location details.
addr2StringFalseNoThe second line of the address, often used for additional location information, such as suite or apartment numbers.
addr3StringFalseNoThe third line of the address, used for further address details if needed, such as building or complex name.
addresseeStringFalseNoThe name of the person or organization to whom the address is directed, typically the recipient of the mail or shipment.
attentionStringFalseNoSpecifies the person or department that should receive the communication, used for directing the mail or shipment to the right party.
cityStringFalseNoThe city of the address, representing the local administrative area or municipality.
countryStringFalseNoThe country associated with the address, used for international shipping or communication purposes.
dropdownstateStringFalseNoA dropdown selection field for the state or province, allowing users to select from predefined regions.
overrideBooleanFalseNoIndicates whether the current address record overrides any default settings or address preferences in the system.
stateStringFalseNoThe state, province, or region of the address, used for further location specification within a country.

Return to Top

PartnerBulkMerge 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoThe entity associated with the record (such as a customer, partner, or account), often used for referencing the entity involved in a process.
mergedateDateFalseNoThe date and time when the merge operation was performed, used for tracking when records were combined or integrated.
mergetypeStringFalseNoThe type of merge action that occurred, indicating the method or reason for merging records (for example, manual, automated, or system-driven).
statusStringFalseNoThe current status of the record or process, used to track its progress or state (for example, pending, completed, failed).
subjectStringFalseNoThe subject or title associated with the record, often used for categorization or as a brief description of the record's focus.
templateStringFalseNoThe template associated with the record, indicating the predefined structure or format used for creating or processing the record.
usernameStringFalseNoThe username of the individual or system process that initiated or is associated with the record, typically used for tracking user actions.

Return to Top

PartnerCampaigns 

NameTypeReadOnlyReferencesFilterOnlyDescription
campaignStringFalseNoThe marketing or outreach campaign associated with the record, typically used to group related activities or communications.
campaigneventStringFalseNoThe specific event or action within the campaign, such as a webinar, email send, or promotional offer.
categoryStringFalseNoThe classification or type of campaign or activity, used for organizing records based on shared characteristics or goals.
contactStringFalseNoThe individual or entity contacted as part of the campaign, typically a customer, prospect, or lead.
datesentDateFalseNoThe date when the campaign communication or event was sent or executed, used for tracking the timing of outreach.
entityStringFalseNoThe entity associated with the campaign record (such as a customer, partner, or prospect), used for tracking engagement.
responseStringFalseNoDetails of the recipient's response to the campaign or event, such as interest, queries, or feedback.
responsedateDateFalseNoThe date when the response was received, used for tracking the timeliness and relevance of replies to campaigns.

Return to Top

partnercategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
externalidStringFalseNoA unique identifier for the record as assigned by an external system, used for integration or referencing the record across different platforms.
isinactiveBooleanFalseNoIndicates whether the record is currently inactive, often used to filter out or exclude records that are no longer in use.
nameStringFalseNoThe name associated with the record, typically used for identification in the system or when displaying it in reports or interfaces.
parentStringFalseNoThe parent record or entity to which this record belongs, often used to establish hierarchical relationships, such as in categories or organizational structures.

Return to Top

partnerCategoryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
categoryStringFalseNoThe classification or grouping of the record, used for organizing and categorizing data based on shared characteristics or attributes.

Return to Top

PartnerCompanyContact 

NameTypeReadOnlyReferencesFilterOnlyDescription
contactStringFalseNoThe individual or entity that is being contacted, typically a customer, partner, or lead, and used to track communication.

Return to Top

partnerContactRole 

NameTypeReadOnlyReferencesFilterOnlyDescription
contactStringFalseNoThe individual or entity associated with the record, used to track and manage communication or interaction.
emailStringFalseNoThe email address associated with the contact or entity, used for communication and notifications.
entityStringFalseNoThe entity related to the record (such as a customer, partner, or account), typically used for categorization and management.
giveaccessBooleanFalseNoIndicates whether access is granted to the record or system, determining whether the entity or contact can log in or interact with the platform.

Return to Top

PartnerSubscriptionMessageHistory 

NameTypeReadOnlyReferencesFilterOnlyDescription
emailStringFalseNoThe email address associated with the record, used for sending and receiving electronic communications.
memoStringFalseNoA brief note or message related to the record, often used for internal remarks or additional information.
recipientStringFalseNoThe individual or entity receiving the communication, typically the primary contact or intended party for the message.
senddateDateFalseNoThe date when the email or message was sent, used for tracking communication history and timing.
senderStringFalseNoThe individual or entity sending the communication, typically the user or system responsible for dispatching the message.

Return to Top

PartnerSubscriptions 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoThe entity associated with the record (such as a customer, partner, or account), used to track and categorize related data.
lastmodifieddateDateFalseNoThe date when the record was last updated or modified, used for auditing and tracking changes to the data.
subscriptionStringFalseNoThe campaign or program the entity is subscribed to, used for tracking participation or engagement in marketing or outreach efforts.

Return to Top

PartnerSubsidiaryRelationship 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to each record, used for referencing and managing data within the system.
entityStringFalseNoThe entity associated with the record (such as a customer, partner, or subsidiary), used for categorizing and organizing data.
externalidStringFalseNoA unique identifier for the record as assigned by an external system, used for integration and data syncing between platforms.
isprimarysubBooleanFalseNoIndicates whether the record represents the primary subsidiary, used to distinguish the main subsidiary from others in a multi-subsidiary structure.
nameStringFalseNoThe name associated with the record, typically used for identification or display in user interfaces, reports, and lists.

Return to Top

PartnerSystem 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoA unique identifier for the record, used to distinguish it from other entries and reference it across the system.

Return to Top

paycheck 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the transaction or record, used to categorize financial data (for example, accounts receivable, payable, or bank account).
addressStringFalseNoThe physical address associated with the record, often used for billing, shipping, or contact purposes.
balanceDecimalFalseNoThe current balance of the account or transaction, representing the amount due, owed, or remaining.
chkamountDecimalFalseNoThe amount of the check associated with the transaction, used in accounting to track payments made via check.
classStringFalseNoThe classification or grouping of the transaction, used to organize records by department, region, or other criteria.
clearedBooleanFalseNoIndicates whether the transaction has been cleared in the system, often referring to whether a payment has been processed or reconciled.
cleareddateDateFalseNoThe date when the transaction was cleared, indicating when it was fully processed or reconciled in the system.
createddateDatetimeFalseNoThe date and time when the record was created, typically used for tracking the creation timeline.
departmentStringFalseNoThe department or business unit associated with the transaction or record, used for organizational and financial reporting.
entityStringFalseNoThe entity associated with the record (such as a customer, supplier, or partner), used for categorization and tracking.
externalidStringFalseNoA unique identifier for the record as assigned by an external system, used for integration and synchronization purposes.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified, used for auditing and tracking changes.
memoStringFalseNoA brief note or description added to the record, often used for internal reference or clarifying details about the transaction.
periodendingDateFalseNoThe end date of the accounting period associated with the transaction or record, often used for financial reporting and closing periods.
postingperiodStringFalseNoThe accounting period in which the transaction is recorded, used for period-specific financial reporting.
startdateDateFalseNoThe start date of the accounting period, contract, or transaction, marking the beginning of the relevant period.
statusStringFalseNoThe current status of the record or transaction (such as 'open', 'closed', or 'pending'), indicating its progress or completion.
statusrefStringFalseNoA reference to the status code or status description, used for more detailed tracking of the record’s current state.
taxperiodStringFalseNoThe tax period associated with the transaction or record, typically used for tax reporting or compliance purposes.
trandateDateFalseNoThe date of the transaction, indicating when the transaction or event occurred.
tranidStringFalseNoA unique identifier for the transaction, used for tracking and referencing individual transactions.
useramountDecimalFalseNoThe amount entered or associated with the transaction by the user, often used for custom amounts or adjustments.
workplaceStringFalseNoThe workplace or location associated with the transaction or entity, used for organizational purposes or tracking regional data.

Return to Top

paycheckjournal 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the record, typically used to classify financial transactions such as accounts payable, accounts receivable, or bank accounts.
classStringFalseNoThe classification or grouping of the transaction or record, often used for organizational purposes like categorizing by department, project, or business unit.
createddateDatetimeFalseNoThe date and time when the record was created in the system, useful for tracking the origin of transactions or entries.
currencyStringFalseNoThe type of currency used in the transaction or record (such as USD, EUR, or GBP), indicating the financial denomination for the values.
customformStringFalseNoThe custom form associated with the record, allowing for personalized fields and layouts for specific transaction types or user requirements.
departmentStringFalseNoThe department within the organization associated with the transaction or record, used for internal reporting and financial categorization.
employeeStringFalseNoThe employee associated with the record, often used to track transactions or assignments made by specific staff members.
exchangerateDoubleFalseNoThe exchange rate applied to the transaction when dealing with foreign currencies, used to convert amounts between different currencies.
externalidStringFalseNoA unique identifier assigned to the record by an external system, used for synchronization and integration purposes across different platforms.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified, often used for auditing and tracking updates or changes made to the record.
locationStringFalseNoThe physical or virtual location associated with the record, often used to track transactions or entities by regional or geographical factors.
postingperiodStringFalseNoThe accounting period in which the record or transaction is posted, used for managing and reporting financial data in specific time frames.
subsidiaryStringFalseNoThe subsidiary or branch of the parent organization associated with the record, helping to manage multi-entity financials and reporting.
trandateDateFalseNoThe date on which the transaction occurred, used to track the timing and relevance of financial activities in relation to other events.

Return to Top

payItemType 

NameTypeReadOnlyReferencesFilterOnlyDescription
fullnameStringFalseNoThe complete name associated with the record, typically used for identification or display in user interfaces (for example, full name of a contact or employee).
keyIntegerFalseNoA unique internal identifier for the record, used for referencing and distinguishing individual entries within the system.

Return to Top

paymentcard 

NameTypeReadOnlyReferencesFilterOnlyDescription
cardbrandStringFalseNoThe brand of card (such as Visa, MasterCard, or American Express), used to identify the card type for processing.
cardnumberStringFalseNoThe card number associated with the payment instrument, used for processing transactions and identifying the card.
cardtypeStringFalseNoThe type of card (such as credit, debit, or prepaid), specifying the kind of financial product being used.
entityStringFalseNoThe entity associated with the card (such as the customer or account holder), used for identifying the party owning the card.
expirationdateStringFalseNoThe expiration date of the card, typically in MM/YY format, indicating when the card is no longer valid.
externalidStringFalseNoA unique identifier for the card or account as assigned by an external system, used for integration or referencing across platforms.
idIntegerFalseNoA unique internal identifier assigned to the card record, used for referencing and managing the record within the system.
instrumenttypeStringFalseNoThe type of payment instrument (such as physical card, virtual card, or digital wallet), used for processing payments.
isdefaultBooleanFalseNoIndicates whether the card is the default payment method for the entity, often used for recurring payments.
isinactiveBooleanFalseNoIndicates whether the card is inactive, often used to flag cards that are no longer in use or have been deactivated.
issuenumberStringFalseNoThe issue number associated with the card, typically used for certain card types to track specific issuances.
maskStringFalseNoA masked version of the card number, displaying only the last few digits for security purposes (for example, **** **** **** 1234).
memoStringFalseNoA brief note or memo attached to the card record, often used for internal tracking or providing additional details.
nameoncardStringFalseNoThe name of the cardholder as printed on the card, used for identification and verification during transactions.
paymentmethodStringFalseNoThe method used for payment (such as credit card, debit card, or bank transfer), used to specify the payment type.
preserveonfileBooleanFalseNoIndicates whether the card details are stored on file for future transactions or subscription billing.
stateStringFalseNoThe state or province associated with the billing address for the card, used for address verification and payment processing.
streetStringFalseNoThe street address associated with the billing address for the card, used for address verification and payment processing.
validfromdateStringFalseNoThe date when the card becomes valid, typically in MM/YY format, indicating the start of the card’s usage period.
zipcodeStringFalseNoThe postal code associated with the billing address for the card, used for address verification and payment processing.

Return to Top

paymentCardBin 

NameTypeReadOnlyReferencesFilterOnlyDescription
addressStringFalseNoThe address associated with the record, typically used for billing or shipping purposes, often including street, city, and postal code.
cardbrandStringFalseNoThe brand of the card (such as Visa, MasterCard, or American Express), used to identify the card type for transaction processing.
cardlevelStringFalseNoThe level or tier of the card (such as standard, premium, or gold), indicating the features or benefits associated with the card.
cardtypeStringFalseNoThe type of card (such as credit, debit, prepaid, or charge card), used to classify the financial product.
countryStringFalseNoThe country associated with the card or record, often used for verifying address details and for transaction localization.
infoStringFalseNoAdditional information related to the card or record, often used for internal notes or extra details not captured in other fields.
issuingbankStringFalseNoThe bank or financial institution that issued the card, responsible for managing the cardholder's account and processing transactions.
keyStringFalseNoA unique identifier associated with the record, used for referencing or linking data within the system or to external systems.
phoneStringFalseNoThe phone number associated with the cardholder or entity, used for contact purposes, customer service, or transaction verification.
purchasecardBooleanFalseNoIndicates whether the card is a purchase card, used for making business or organizational purchases.

Return to Top

paymentCardBrand 

NameTypeReadOnlyReferencesFilterOnlyDescription
codeStringFalseNoA unique code or identifier used to represent a specific record or category, often used for categorization or processing purposes.
keyIntegerFalseNoA unique internal identifier assigned to the record, used to distinguish it from other entries in the system.

Return to Top

paymentCardPaymentOperationMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
paymentinstrumentStringFalseNoThe type of payment method used for the transaction (such as credit card, debit card, or bank transfer), indicating the source of funds.

Return to Top

paymentcardtoken 

NameTypeReadOnlyReferencesFilterOnlyDescription
cardbrandStringFalseNoThe brand of the card (such as Visa, MasterCard, or American Express), used to identify the card type for payment processing.
cardexpirationdateStringFalseNoThe expiration date of the card, typically in MM/YY format, indicating when the card is no longer valid.
cardissueridnumberStringFalseNoThe identification number assigned by the card issuer, used for verifying the card’s origin or issuing financial institution.
cardlastfourdigitsStringFalseNoThe last four digits of the card number, often displayed for security purposes or to identify the card without revealing the full number.
cardnameoncardStringFalseNoThe name of the cardholder as printed on the card, used for identity verification during transactions.
cardtypeStringFalseNoThe type of card (such as credit, debit, or prepaid), specifying the kind of financial product being used.
entityStringFalseNoThe entity associated with the card (such as a customer or partner), used to reference the record or account holder.
externalidStringFalseNoA unique identifier assigned to the card or account by an external system, used for integration or synchronization purposes.
idIntegerFalseNoA unique internal identifier for the card record, used to reference and manage the record within the system.
instrumenttypeStringFalseNoThe type of payment instrument (such as a physical card, virtual card, or digital wallet), used for processing transactions.
isdefaultBooleanFalseNoIndicates whether the card is the default payment method for the entity, often used for automatic payments or recurring transactions.
isinactiveBooleanFalseNoIndicates whether the card is inactive, often used to flag cards that are no longer in use or have been deactivated.
maskStringFalseNoA masked version of the card number, displaying only the last few digits for security purposes (for example, **** **** **** 1234).
memoStringFalseNoA brief note or description attached to the card record, often used for internal tracking or clarifying details about the card.
paymentmethodStringFalseNoThe method used for making payments (such as credit card, debit card, or bank transfer), specifying the type of payment instrument.
preserveonfileBooleanFalseNoIndicates whether the card details are stored on file for future use, such as for recurring payments or subscriptions.
stateStringFalseNoThe state or region associated with the billing address for the card, used for address verification during payment processing.
tokenStringFalseNoA secure token used to represent the card or payment instrument in transactions, allowing for tokenized payments without exposing card details.
tokenexpirationdateStringFalseNoThe expiration date of the token, indicating when the tokenized representation of the card will no longer be valid.
tokenfamilyStringFalseNoThe family or category of tokens to which the current token belongs, used for organizing or managing tokenized payment instruments.
tokennamespaceStringFalseNoThe namespace or context in which the token is used, often referring to the system or platform that generated the token for processing payments.

Return to Top

paymentCardTokenPaymentOperationMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
paymentinstrumentStringFalseNoThe type of payment instrument used for processing transactions, such as a credit card, debit card, digital wallet, or bank transfer.

Return to Top

paymentevent 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to the transaction, used for tracking and referencing the record.
amountDecimalFalseNoThe monetary amount associated with the transaction, representing the value being processed or charged.
authcodeStringFalseNoThe authorization code provided by the payment gateway or processor, confirming that the transaction was authorized.
avsstreetmatchStringFalseNoIndicates whether the address verification system (AVS) successfully matched the street address provided by the cardholder.
avszipmatchStringFalseNoIndicates whether the AVS successfully matched the ZIP code provided by the cardholder during the transaction.
cancelableBooleanFalseNoIndicates whether the transaction can be canceled, allowing the merchant to void or reverse the transaction.
cardnameoncardStringFalseNoThe name of the cardholder as printed on the card, used for identity verification and authorization.
cardstreetStringFalseNoThe street address associated with the cardholder's billing address, used for AVS verification during the transaction.
cardtokensubcardStringFalseNoA sub-card associated with the main payment card, used in tokenized transactions for enhanced security.
cardzipcodeStringFalseNoThe zip code associated with the cardholder’s billing address, used for AVS verification to ensure the address matches.
cscmatchStringFalseNoIndicates whether the card security code (CSC) provided during the transaction matched the one on file with the card issuer.
docStringFalseNoThe transaction document or reference, used for linking or identifying the transaction in the system or report.
eventdateDateFalseNoThe date on which the payment event or transaction occurred, used for tracking and reporting.
externalidStringFalseNoA unique identifier for the transaction or payment as assigned by an external system, used for integration or synchronization.
handlingmodeStringFalseNoThe method used to process the transaction, such as manual, automated, or recurring handling.
isadjustedexpirationdateBooleanFalseNoIndicates whether the transaction was processed with an adjusted expiration date, often used in specific payment scenarios.
isodateStringFalseNoThe ISO formatted date associated with the transaction, providing a standardized timestamp.
isrecurringpaymentBooleanFalseNoIndicates whether the transaction is part of a recurring payment plan, such as a subscription or installment.
lasteventBooleanFalseNoIndicates whether the current event is the last action or status update in a series of transactions.
maskedcardStringFalseNoA masked version of the card number, showing only the last four digits for security purposes (for example, **** 1234).
merchantprintblockStringFalseNoThe block of text or data that is printed by the merchant, typically for receipt printing or transaction records.
mitpurposeStringFalseNoThe purpose of the transaction, often used in merchant identification transactions (MIT) to classify the nature of the payment.
paymentinitiatorStringFalseNoThe entity or individual initiating the payment, used for identifying the party responsible for starting the transaction.
paymentinstrumentmaskStringFalseNoThe masked version of the payment instrument (such as a card number), showing only partial digits for security and privacy.
paymentinstrumentstateStringFalseNoThe state or condition of the payment instrument, such as active, expired, or invalid.
paymentoperationStringFalseNoThe type of payment operation performed, such as authorization, capture, refund, or void.
paymentprocessingprofileStringFalseNoThe payment processing profile used to define the parameters for handling payments, such as the gateway or payment method.
paymentrequestidStringFalseNoA unique identifier for the payment request, used for tracking and referencing the specific request in the system.
paymentstatusStringFalseNoThe current status of the payment, such as pending, authorized, completed, or failed.
pnrefnumStringFalseNoThe payment reference number assigned to the transaction, used for tracking and referencing within the payment system.
redirecturlStringFalseNoThe URL to which the customer is redirected after completing or interacting with the payment process, such as for authentication or confirmation.
requestStringFalseNoThe raw request data sent to the payment processor, typically used for debugging or tracking the transaction request.
responseStringFalseNoThe raw response data received from the payment processor, often used for debugging or validating the outcome of the transaction.
shopperprintblockStringFalseNoThe block of text or data that is printed for the shopper, typically included in transaction receipts or printed confirmations.
signaturerequiredBooleanFalseNoIndicates whether a signature is required for the transaction, often used for high-value or sensitive payments.
statusreasonStringFalseNoThe reason for the current status of the transaction, providing context or explanation for actions like failure or delay.
statusreasondetailsStringFalseNoAdditional details explaining the reason for the current transaction status, often used for troubleshooting or customer support.
testmodeBooleanFalseNoIndicates whether the transaction is being processed in test mode, typically used for development or testing purposes without real funds being involved.

Return to Top

paymentHandlingMode 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier for the record, used to reference and distinguish it from other records within the system or external systems.

Return to Top

paymentInitiator 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier assigned to the record, used to reference and distinguish it within the database or system.

Return to Top

paymentInstrumentListPaymentOperationMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
paymentinstrumentStringFalseNoThe type of payment method used for the transaction, such as a credit card, debit card, or digital wallet.

Return to Top

paymentInstrumentPaymentOperationMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
paymentinstrumentStringFalseNoThe method or instrument used for payment in the transaction, such as a credit card, debit card, or bank transfer.

Return to Top

paymentInstrumentStateType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoA unique identifier assigned to the record, used for tracking, referencing, and distinguishing it from other entries in the system.

Return to Top

paymentInstrumentType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoA unique numeric identifier assigned to the record, used for referencing and managing the record within the system.

Return to Top

paymentitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the record, used for tracking and managing financial transactions or customer accounts.
availabletopartnersBooleanFalseNoIndicates whether the record is available for use by partners, often used to control access or visibility in partner relationships.
classStringFalseNoThe classification or grouping of the record, used to categorize the item or entity for organizational purposes, such as project or department.
createddateDatetimeFalseNoThe date and time when the record was created, used for tracking the origin and history of the record.
customformStringFalseNoThe custom form associated with the record, used to personalize the layout or fields for specific transactions or entities.
departmentStringFalseNoThe department within the organization associated with the record, used for tracking, reporting, and categorizing by business unit.
descriptionStringFalseNoA detailed description of the record, used to provide additional context or information about the entity or item.
displaynameStringFalseNoThe display name of the record, typically used in user interfaces to identify the record in lists, reports, or search results.
externalidStringFalseNoA unique identifier assigned to the record by an external system, used for synchronization and integration with other platforms.
includechildrenBooleanFalseNoIndicates whether related or child records should be included when processing or retrieving data for the parent record.
isinactiveBooleanFalseNoIndicates whether the record is inactive, often used to flag records that are no longer in use or should be excluded from certain processes.
issueproductStringFalseNoThe product or item issued by the record, often used to identify what is being provided or transacted in the context of the record.
itemidStringFalseNoThe unique identifier or code for the item, used for tracking and referencing the specific product or service.
itemtypeStringFalseNoThe type of item (such as product, service, or resource), used to classify the record based on the nature of the item.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified, used for tracking updates and changes to the record over time.
locationStringFalseNoThe physical or virtual location associated with the record, often used for logistics, inventory, or regional reporting.
paymentmethodStringFalseNoThe method of payment associated with the record (such as credit card, bank transfer, or PayPal), used for processing transactions.
subsidiaryStringFalseNoThe subsidiary or branch of the parent organization associated with the record, often used in multi-entity financial systems.
undepfundsStringFalseNoThe funds that are undeposited or pending deposit, typically used in accounting and finance for tracking transactions not yet processed.

Return to Top

paymentItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item, used to reference a product, service, or entity in the system.

Return to Top

paymentItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
displaynameStringFalseNoDisplay Name
itemStringFalseNoItem
languageStringFalseNoLanguage
nopricemessageStringFalseNoNo Price Message
outofstockmessageStringFalseNoOut Of Stock Message
pagetitleStringFalseNoPage Title
salesdescriptionStringFalseNoSales Description
storedescriptionStringFalseNoStore Description
featureddescriptionStringFalseNofeatureddescription
specialsdescriptionStringFalseNospecialsdescription
storedisplaynameStringFalseNostoredisplayname
storedetaileddescriptionStringFalseNostoredetaileddescription

Return to Top

paymentmethod 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to the record, used to reference and manage the record within the system.
accountStringFalseNoThe account associated with the record, typically used for tracking financial transactions or customer information.
externalidStringFalseNoA unique identifier for the record assigned by an external system, used for integration or synchronization between systems.
isinactiveBooleanFalseNoIndicates whether the record is inactive, often used to flag records that should no longer be used or processed.
merchantaccountsStringFalseNoThe associated payment processing profiles, typically used to track the merchant accounts tied to this record for payment processing.
nameStringFalseNoThe name associated with the record, used for identification or display purposes in user interfaces or reports.

Return to Top

paymentMethodVisual 

NameTypeReadOnlyReferencesFilterOnlyDescription
flagsStringFalseNoA set of flags or indicators associated with the record, used to represent specific statuses or conditions, often for filtering or processing.
paymentmethodStringFalseNoThe type of payment method used for the transaction or record (such as credit card, debit card, or bank transfer), specifying the source of funds.

Return to Top

paymentOperation 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier for the record, used to reference and distinguish it from other entries in the system or across external systems.

Return to Top

paymentResultPreview 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to the record, used to reference and manage the transaction or entry in the system.
cancelableBooleanFalseNoIndicates whether the transaction or record can be canceled, allowing for reversal or termination of the action.
datecreatedDateFalseNoThe date the record was created, used to track the creation time and for auditing or chronological purposes.
externalidStringFalseNoA unique identifier for the record assigned by an external system, used for integration or synchronization across systems.
isodateStringFalseNoThe date in ISO 8601 format (YYYY-MM-DD), providing a standardized representation of the date for international use.
issignaturerequiredBooleanFalseNoIndicates whether a signature is required to complete the transaction or validate the record, often for high-value or sensitive actions.
maskedcardStringFalseNoA partially hidden version of the card number, showing only the last four digits (for example, **** 1234) for security and privacy.
merchantprintblockStringFalseNoThe block of text or data that is printed by the merchant, typically used in receipts or transaction records for display or reference.
paymentrequestidStringFalseNoA unique identifier for the payment request, used for tracking the specific request made for processing payments.
paymentstatusStringFalseNoThe current status of the payment (such as pending, completed, failed, or authorized), indicating its progress.
paymentstatusreasonStringFalseNoThe reason associated with the payment status, providing context for why a payment has reached its current state (for example, declined, pending review).
shopperprintblockStringFalseNoThe block of text or data that is printed for the shopper, often included in transaction receipts or confirmations for customer reference.

Return to Top

paymentStatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier assigned to the record, used for referencing and distinguishing it within the system or external systems.

Return to Top

paymentStatusReason 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier for the record, used for referencing and distinguishing it within the system or across other integrated platforms.

Return to Top

payrollbatch 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the record, used for tracking financial transactions, payroll, or employee data.
balanceDecimalFalseNoThe current balance in the account, reflecting the total amount available or owed based on the account's activity.
countIntegerFalseNoThe number of items, records, or transactions associated with the account, typically used for summarizing or reporting.
externalidStringFalseNoA unique identifier for the record as assigned by an external system, used for integration or synchronization purposes.
messageStringFalseNoA text message associated with the record, often used to provide information, alerts, or instructions related to the record.
offcycleBooleanFalseNoIndicates whether the transaction is part of an off-cycle payroll or payment run, typically used for special or one-time payments.
payfrequencyStringFalseNoThe frequency with which payments are made, such as weekly, biweekly, monthly, or yearly.
payrolltypeStringFalseNoThe type of payroll (such as salaried, hourly, or contract), used to categorize payment structures.
periodendingDateFalseNoThe end date of the payroll or accounting period, used to mark the end of a specific reporting or payment cycle.
subsidiaryStringFalseNoThe subsidiary or branch of the parent company associated with the record, typically used in multi-entity financial systems.

Return to Top

payrollitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to the record, used to reference and manage the record within the system.
assetaccountStringFalseNoThe account associated with the asset, used for tracking and managing the value of owned resources or properties.
employeepaidBooleanFalseNoIndicates whether the employee has been paid, typically used to track payroll or compensation status.
expenseaccountStringFalseNoThe account associated with expenses, used for tracking and categorizing business expenditures or operational costs.
externalidStringFalseNoA unique identifier for the record as assigned by an external system, used for integration or synchronization purposes.
inactiveBooleanFalseNoIndicates whether the record is inactive, often used to flag records that are no longer in use or should be excluded from active processes.
itemtypeStringFalseNoThe type of item (such as product, service, or resource), used to classify the record based on its nature and function.
liabilityaccountStringFalseNoThe account associated with liabilities, used for tracking amounts owed by the company or organization.
nameStringFalseNoThe name associated with the item, typically used for identification in reports, transactions, and user interfaces.
subsidiaryStringFalseNoThe subsidiary or branch of the parent company associated with the record, useful for managing multi-entity financials and reporting.
vendorStringFalseNoThe vendor or agency associated with the record, often used to identify the supplier or service provider in the transaction.

Return to Top

payrollItemEmployeeTaxOptions 

NameTypeReadOnlyReferencesFilterOnlyDescription
additionalallowancesIntegerFalseNoThe additional amount for exemptions or allowances granted to the employee, typically used for tax or deduction adjustments.
addlallwncnameStringFalseNoThe name or description of the additional exemption or allowance applied to the employee's compensation.
employeeidStringFalseNoThe unique identifier or name of the employee, used to track and reference individual employees within the payroll system.
excreditsnameStringFalseNoThe name or description of the exemptions or allowances applied to the employee, typically related to tax credits or deductions.
exemptBooleanFalseNoIndicates whether the employee is exempt from certain taxes or deductions, affecting their payroll calculations.
exemptioncreditsIntegerFalseNoThe amount of exemption or allowance granted to the employee, typically affecting tax withholdings or deductions.
overrideamountDoubleFalseNoAn override amount applied to the employee’s pay, often used to adjust the payroll calculation manually for specific reasons.
payrollitemidStringFalseNoA unique identifier for the payroll item, used to reference and manage specific payroll components like earnings, deductions, or benefits.
secndallwncnameStringFalseNoThe name or description of the secondary exemption or allowance, often used for additional tax credits or deductions.
secondaryallowancesIntegerFalseNoThe amount for the secondary exemption or allowance granted to the employee, typically used for additional tax or deduction purposes.
statusStringFalseNoThe filing status of the employee for tax purposes (such as single, married, or head of household), affecting tax calculations.

Return to Top

pctcompleteprojectrevenuerule 

NameTypeReadOnlyReferencesFilterOnlyDescription
customformStringFalseNoThe custom form associated with the record, used to personalize the fields and layout for specific transactions or entities.
descriptionStringFalseNoA detailed description of the record, providing additional context or information about the entity or item.
externalidStringFalseNoA unique identifier assigned to the record by an external system, used for integration or synchronization between platforms.
isinactiveBooleanFalseNoIndicates whether the record is inactive, often used to flag records that are no longer in use or should be excluded from active processes.
nameStringFalseNoThe name associated with the record, typically used for identification or display purposes in user interfaces or reports.
projectStringFalseNoThe project associated with the record, used for categorization or tracking related to specific tasks, goals, or initiatives.
revenuereconciledBooleanFalseNoIndicates whether the revenue has been reconciled, used to track whether the financial amounts have been verified and balanced.
serviceitemStringFalseNoThe service item associated with the record, used for referencing a specific service provided or rendered within the system.

Return to Top

PdfTemplate 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to the record, used to reference and manage the entry within the system.
contentStringFalseNoThe main content associated with the record, typically used for storing text, data, or other relevant information related to the record.
descriptionStringFalseNoA detailed description of the record, providing additional context or information about the entity or item.
isinactiveBooleanFalseNoIndicates whether the record is inactive, often used to flag records that should be excluded from active processes or reports.
isprivateBooleanFalseNoIndicates whether the record is marked as private, controlling access or visibility to the data.
mediaitemStringFalseNoThe media item associated with the record (such as an image, video, or document), used to reference multimedia content.
nameStringFalseNoThe name associated with the record, typically used for identification or display purposes in user interfaces or reports.
recordtypeStringFalseNoThe type of record (such as an invoice, order, or customer), used to classify the record within the system.
subjectStringFalseNoThe subject or title of the record, typically used for categorization or summarizing the main focus or topic of the record.

Return to Top

periodendjournal 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with the record, used to track financial data within a specific accounting framework or ledger.
classStringFalseNoThe classification or category assigned to the record, typically used for organizational purposes like department, project, or financial grouping.
createddateDatetimeFalseNoThe date and time when the record was created, used for tracking the origin and history of the transaction.
credittotalDecimalFalseNoThe total credit amount associated with the transaction, representing the sum of credits applied or received.
currencyStringFalseNoThe currency used for the transaction (such as USD, EUR, or GBP), specifying the denomination for the amounts involved.
customformStringFalseNoThe custom form used for the transaction, allowing for personalized fields or layouts specific to the business process.
debittotalDecimalFalseNoThe total debit amount associated with the transaction, representing the sum of debits applied or owed.
departmentStringFalseNoThe department within the organization associated with the transaction, often used for financial reporting or cost allocation.
externalidStringFalseNoA unique identifier for the record assigned by an external system, used for integration or synchronization across platforms.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified, used for auditing and tracking changes to the record.
locationStringFalseNoThe physical or virtual location associated with the transaction, often used for logistics, reporting, or geographical categorization.
mainaccountStringFalseNoThe primary account associated with the transaction, used for referencing the main financial record or ledger.
memoStringFalseNoA brief note or description attached to the transaction, often used to provide additional context or information about the record.
postingperiodStringFalseNoThe accounting period during which the transaction is recorded, used for period-specific reporting and financial management.
sourcesubsidiaryStringFalseNoThe subsidiary from which the transaction originates, used for multi-entity financial tracking or reporting.
subsidiaryStringFalseNoThe subsidiary or branch of the parent organization associated with the transaction, used for managing transactions across multiple entities.
trandateDateFalseNoThe date the transaction occurred, used to record when the transaction took place for accounting and reporting purposes.
tranidStringFalseNoA unique identifier for the transaction, used for tracking and referencing specific transactions within the system.
transactionnumberStringFalseNoA number assigned to the transaction for identification and tracking purposes, often used for referencing and reporting.

Return to Top

permissionLevel 

NameTypeReadOnlyReferencesFilterOnlyDescription
defaultnameStringFalseNoThe default name associated with the record, often used for automatic labeling or identification when no specific name is provided.
keyIntegerFalseNoA unique numeric identifier assigned to the record, used to reference and distinguish it from other records within the system.

Return to Top

PermissionType 

NameTypeReadOnlyReferencesFilterOnlyDescription
adminonlyBooleanFalseNoIndicates whether the record is restricted to admin access only, controlling whether regular users can view or modify it.
everyoneBooleanFalseNoIndicates whether the record is accessible to all users, making it publicly available for viewing or editing based on user permissions.
featureStringFalseNoA description of the specific feature or functionality associated with the record, often used to categorize or enable particular capabilities.
nameStringFalseNoThe name associated with the record, typically used for identification, display, or organizational purposes in the system.

Return to Top

phonecall 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to the record, used to reference and manage the entry within the system.
accesslevelBooleanFalseNoIndicates whether the record is private, restricting access to specific users based on their permissions.
assignedStringFalseNoThe person or entity to whom the record is assigned, often used to track responsibility or ownership of tasks or projects.
bomStringFalseNoThe Bill of Materials (BOM) associated with the record, used to list the raw materials and components needed for manufacturing.
bomrevisionStringFalseNoThe revision or version number of the BOM, used to track changes and updates to the materials list.
companyStringFalseNoThe company associated with the record, typically used to track the organization or business unit related to the item or process.
completeddateDateFalseNoThe date on which the task, project, or record was completed, used for tracking progress and performance.
contactStringFalseNoThe contact person associated with the record, often used for customer or client interactions and communications.
createddateDateFalseNoThe date on which the record was created, used to track the origin and timeline of the entry.
externalidStringFalseNoA unique identifier for the record assigned by an external system, used for integration or synchronization between systems.
lastmodifieddateDateFalseNoThe date on which the record was last modified, used for tracking changes and ensuring data integrity.
messageStringFalseNoThe comments or notes associated with the record, often used for internal communication or additional context.
mfgroutingStringFalseNoThe manufacturing routing associated with the record, detailing the process steps or workflow required to produce the item.
ownerStringFalseNoThe person who created or owns the record, often used for tracking accountability and responsibility for managing the entry.
priorityStringFalseNoThe priority level of the task or record, indicating its importance or urgency in relation to other records or projects.
relateditemStringFalseNoThe item related to the record, often used for associating products, parts, or resources with the current entry.
reminderminutesStringFalseNoThe number of minutes before the event or task is due when a reminder should be set up to alert the responsible party.
remindertypeStringFalseNoThe type of reminder to be used (such as an email, popup, or notification), indicating how the reminder will be delivered.
startdateDateFalseNoThe start date of the task, project, or process, marking the beginning of the associated activity or event.
statusStringFalseNoThe current status of the record (such as 'open', 'in progress', 'completed', or 'closed'), used for tracking the progress of tasks or projects.
supportcaseStringFalseNoThe support case associated with the record, typically used for tracking customer service or technical support inquiries.
timedeventBooleanFalseNoIndicates whether the event is time-based (such as a scheduled task or automated process), that occurs at a specific time.
titleStringFalseNoThe title or name of the record, used for identification and display in user interfaces or reports.

Return to Top

PickActionInventoryDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to the record, used to track and reference the entry within the system.
binStringFalseNoThe bin number associated with the inventory, used to track the storage location of items within the warehouse or facility.
inventorynumberStringFalseNoThe unique number assigned to the inventory item, used for tracking and referencing specific products or goods.
pickactionStringFalseNoThe action associated with picking the inventory item (such as 'pick', 'ship', or 'hold'), typically used in warehouse management.
quantityDecimalFalseNoThe quantity of the inventory item, representing the amount available, ordered, or picked for a transaction.

Return to Top

pickstrategy 

NameTypeReadOnlyReferencesFilterOnlyDescription
customerStringFalseNoThe customer associated with the record, used to track transactions, orders, and account details.
descriptionStringFalseNoA detailed description of the item or record, providing additional context or information for better understanding.
descriptiontranslatedStringFalseNoThe translated version of the description, used for localization and adapting the content for different languages or regions.
externalidStringFalseNoA unique identifier for the record assigned by an external system, used for integration and synchronization between platforms.
inventorystatusStringFalseNoThe current status of the inventory item (such as available, out of stock, or on order), used to track stock levels.
invtclassificationStringFalseNoThe classification of the inventory item, used to categorize and group items for reporting and management purposes.
isinactiveBooleanFalseNoIndicates whether the record is inactive, typically used to flag items or accounts that are no longer in use.
itemStringFalseNoThe name or identifier of the item, used for tracking and managing products, goods, or services within the system.
itemprocessfamilyStringFalseNoThe family or group of similar items processed together, often used for categorization in processing or manufacturing workflows.
itemprocessgroupStringFalseNoThe group of items within the same processing or manufacturing category, used for grouping related items in production processes.
locationStringFalseNoThe physical or virtual location associated with the item, such as a warehouse, store, or distribution center.
nameStringFalseNoThe name associated with the record, typically used for identification and display in user interfaces or reports.
nametranslatedStringFalseNoThe translated version of the name, used for adapting the content to different languages or regions for localization.
ordertypeStringFalseNoThe type of order associated with the record (such as sales order, purchase order, or work order), used to classify and manage different types of transactions.
priorityDoubleFalseNoThe priority level associated with the record, often used to determine the urgency or importance of the transaction or task.
trantypeStringFalseNoThe type of transaction associated with the record (such as purchase, sale, or transfer), used to classify financial or operational activities.
unitsStringFalseNoThe unit of measure (UOM) associated with the item (such as pieces, kilograms, or liters), used to specify how the item is quantified.

Return to Top

picktask 

NameTypeReadOnlyReferencesFilterOnlyDescription
externalidStringFalseNoA unique identifier for the record assigned by an external system, used for integration or synchronization across platforms.
inventorynumberStringFalseNoThe unique number assigned to the inventory item, used to track and reference specific products or goods in the system.
itemStringFalseNoThe name or identifier of the item, used to track and manage products, goods, or services within the system.
locationStringFalseNoThe physical or virtual location where the item is stored or located, such as a warehouse, shelf, or section.
memoStringFalseNoA brief note or comment associated with the record, often used for internal communication or additional context.
nameIntegerFalseNoThe name or unique identifier associated with the item or record, often used for identification and display purposes in reports or systems.
pickerStringFalseNoThe individual or employee responsible for picking the item, often used in warehouse or inventory management systems.
recommendedbinStringFalseNoThe recommended bin or storage location for the item, used to optimize storage and retrieval during the picking process.
statusStringFalseNoThe current status of the item or transaction (such as available, out of stock, or in transit), indicating its operational state.
totalpickedquantityDoubleFalseNoThe total quantity of the item that has been picked, used to track progress in the order fulfillment process.
totalremainingquantityDoubleFalseNoThe total quantity of the item that remains to be picked or processed, used to track outstanding quantities.
unitsStringFalseNoThe unit of measure (UOM) for the item (such as pieces, kilograms, or liter), used to specify how the item is quantified.
waveStringFalseNoThe wave or batch associated with the order picking process, used to organize and prioritize multiple orders for fulfillment.

Return to Top

plannedorder 

NameTypeReadOnlyReferencesFilterOnlyDescription
customformStringFalseNoThe custom form associated with the record, used to personalize the fields and layout for specific transactions or entities.
enddateDateFalseNoThe end date of the record or transaction, typically used to mark the completion or expiration of an event, process, or schedule.
externalidStringFalseNoA unique identifier assigned to the record by an external system, used for integration or synchronization across systems.
firmedBooleanFalseNoIndicates whether the record has been confirmed or finalized, often used in order management or project tracking.
idIntegerFalseNoA unique internal identifier assigned to the record, used for tracking and managing the entry within the system.
itemStringFalseNoThe name or identifier of the item, used to track and manage products, goods, or services within the system.
itemlocationIntegerFalseNoThe location of the item, typically used in inventory or warehouse management to track where the item is stored.
itemtypeStringFalseNoThe type of item (such as raw material, finished product, or service), used to classify and manage the item within the system.
locationStringFalseNoThe physical or virtual location where the item is stored or where the transaction takes place, such as a warehouse, store, or shipping area.
memoStringFalseNoA brief note or comment associated with the record, often used for internal communication or providing additional context.
plannedorderstatusStringFalseNoThe status of the planned order, indicating its progress, such as planned, in progress, or completed.
quantityStringFalseNoThe quantity of the item involved in the transaction, typically used to track the amount purchased, sold, or produced.
releasedBooleanFalseNoIndicates whether the record or order has been released for further processing or action, such as shipping or production.
sourceitemlocationIntegerFalseNoThe location of the source item, typically used to track where the inventory or materials are coming from in a transfer or supply chain process.
sourcelocationStringFalseNoThe source location of the item, often used to track where goods or materials originate before being moved or sold.
startdateDateFalseNoThe start date of the record or transaction, used to mark the beginning of an event, process, or schedule.
supplyplandefinitionStringFalseNoThe definition or criteria used for the supply planning process, outlining the goals, parameters, and strategies for managing supply chain needs.
supplyplanningrunidIntegerFalseNoThe identifier for the specific run of the supply planning process, used to track and manage multiple planning cycles.
templatestoredBooleanFalseNoIndicates whether the record is stored as a template, allowing it to be reused for future transactions or processes.
transactioncreatedStringFalseNoThe date or identifier associated with the creation of the transaction, used to track when the transaction was initiated.
transactionlinecreatedStringFalseNoThe date or identifier associated with the creation of the transaction line, used to track when individual transaction components were generated.
transactiontypeStringFalseNoThe type of transaction (such as purchase, sale, transfer, or refund), used to classify and manage the nature of the record.

Return to Top

plannedRevenueType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier assigned to the record, used for referencing and distinguishing it from other records within the system.

Return to Top

plannedStandardCost 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to the record, used for tracking and referencing the entry within the system.
externalidStringFalseNoA unique identifier for the record assigned by an external system, used for integration or synchronization across platforms.
itemStringFalseNoThe name or identifier of the item, used to track and manage products, goods, or services within the system.
locationStringFalseNoThe physical or virtual location associated with the record, such as a warehouse, store, or facility.
memoStringFalseNoA brief note or comment associated with the record, often used for internal communication or providing additional context.
standardcostversionStringFalseNoThe version of the standard cost associated with the item, used to manage pricing or cost calculations in inventory or manufacturing.

Return to Top

plannedStandardCostComponents 

NameTypeReadOnlyReferencesFilterOnlyDescription
componentitemStringFalseNoThe component item associated with the record, typically representing a part or material used in the assembly or production process.
conversionrateDoubleFalseNoThe rate used to convert one unit of measure (UOM) to another, such as converting kilograms to pounds or liters to gallons.
costDecimalFalseNoThe cost associated with the item or component, representing the monetary value incurred for procurement or manufacturing.
costcategoryStringFalseNoThe category to which the cost belongs (such as labor, materials, or overhead), used for classifying and tracking expenses.
plannedstandardcostStringFalseNoThe planned or expected cost for the item or component, typically used in budgeting and cost management processes.

Return to Top

planningitemcategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
customformStringFalseNoThe custom form associated with the record, used to personalize the fields and layout for specific transactions or entities.
descriptionStringFalseNoA detailed description of the record, providing additional context or information about the entity or item.
externalidStringFalseNoA unique identifier for the record assigned by an external system, used for integration or synchronization across platforms.
idIntegerFalseNoA unique internal identifier assigned to the record, used to reference and manage the entry within the system.
nameStringFalseNoThe name associated with the record, typically used for identification and display purposes in user interfaces or reports.
templatestoredBooleanFalseNoIndicates whether the record is stored as a template, allowing it to be reused for future transactions or processes.

Return to Top

planningitemgroup 

NameTypeReadOnlyReferencesFilterOnlyDescription
customformStringFalseNoThe custom form associated with the record, used to personalize the fields and layout for specific transactions or entities.
descriptionStringFalseNoA detailed description of the record, used to provide additional context or information regarding the item or entity.
externalidStringFalseNoA unique identifier assigned to the record by an external system, used for integration or synchronization across different platforms.
idIntegerFalseNoA unique internal identifier assigned to the record, used to reference and manage the entry within the system.
nameStringFalseNoThe name associated with the record, typically used for identification and display purposes within the user interface or reports.
templatestoredBooleanFalseNoIndicates whether the record is stored as a template, allowing it to be reused for similar future transactions or processes.

Return to Top

planningrulegroup 

NameTypeReadOnlyReferencesFilterOnlyDescription
customformStringFalseNoThe custom form associated with the record, which is used to define the structure and layout of fields for specific transactions or entities.
descriptionStringFalseNoA detailed description of the record, often used to provide context or additional information about the item or entity.
externalidStringFalseNoA unique identifier assigned to the record by an external system, facilitating integration and data synchronization between systems.
idIntegerFalseNoA unique internal identifier assigned to the record, allowing it to be referenced and managed within the system.
nameStringFalseNoThe name associated with the record, typically used for identification or display purposes in user interfaces or reports.
templatestoredBooleanFalseNoIndicates whether the record is stored as a template, making it available for reuse in similar future transactions or processes.

Return to Top

planningview 

NameTypeReadOnlyReferencesFilterOnlyDescription
actionStringFalseNoThe action associated with the record, typically used to specify the operation or change being made, such as create, update, or delete.
demandStringFalseNoThe demand for the item or resource, often used to track the required quantity or need within a planning or forecasting system.
exceptionStringFalseNoAny exception or irregularity related to the record, used to highlight issues or conditions that deviate from the expected flow or process.
externalidStringFalseNoA unique identifier assigned to the record by an external system, facilitating integration and synchronization across different platforms.
idIntegerFalseNoA unique internal identifier for the record, used to track and reference the entry within the system.
itemStringFalseNoThe name or identifier of the item, used for tracking and managing products, goods, or services within the system.
nameStringFalseNoThe name associated with the record, used for identification and display in user interfaces or reports.
planningitemcategoryStringFalseNoThe category or classification assigned to the item for planning purposes, often used to group items based on similar characteristics.
relativeenddaysIntegerFalseNoThe number of days relative to the start date, used to calculate or specify the end date or deadline within the planning process.
savedsearchStringFalseNoA pre-defined search or query used to retrieve specific records or data, often saved for repeated use and easy access.
supplyStringFalseNoThe supply of the item or resource, typically used to track available quantities or inventory within a system.
supplyreplenishmenttypeStringFalseNoThe type of replenishment strategy used for the supply (such as minimum stock, reorder point, or demand-based), to manage inventory levels.

Return to Top

platformExtensionPluginLibrariesAdvancedRevRec 

NameTypeReadOnlyReferencesFilterOnlyDescription
scriptfileStringFalseNoThe library script file associated with the record, typically used to store reusable code or functions that can be referenced and executed within the system.

Return to Top

portlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
defaultfunctionStringFalseNoThe default function associated with the record, often used to define the standard behavior or action when the script or process is triggered.
descriptionStringFalseNoA detailed description of the record, providing additional context or information about the entity or process.
externalidStringFalseNoA unique identifier for the record assigned by an external system, used for integration or synchronization across different platforms.
isinactiveBooleanFalseNoIndicates whether the record is inactive, often used to flag records that are no longer in use or should be excluded from active processes.
nameStringFalseNoThe name associated with the record, typically used for identification and display purposes in user interfaces or reports.
notifyadminsBooleanFalseNoIndicates whether administrators should be notified about changes or events related to the record, used to ensure awareness or action.
notifyemailsStringFalseNoThe email addresses to be notified about changes or events related to the record, typically used for alerting specific users or groups.
notifygroupStringFalseNoThe group of users who should be notified about changes or events related to the record, often used for team-based notifications.
notifyownerBooleanFalseNoIndicates whether the record's owner should be notified about changes or events, ensuring the responsible party is informed.
notifyuserBooleanFalseNoIndicates whether the user associated with the record should be notified about changes or events, often for user-specific actions.
ownerStringFalseNoThe individual or entity responsible for the record, often used for tracking accountability and ownership within the system.
portlettypeStringFalseNoThe type of portlet associated with the record, typically used for defining the layout or widget in a dashboard or interface.
scriptfileStringFalseNoThe file containing the script associated with the record, typically used to store reusable code or functions for processing.
scriptidStringFalseNoThe unique identifier for the script, used to reference and manage scripts within the system.
scripttypeStringFalseNoThe type of script (such as client-side or server-side), used to define the execution context or role of the script in the system.

Return to Top

predictedRiskTrainEvalHistory 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]IntegerFalseNoA unique internal identifier assigned to the record, used for tracking and referencing the entry within the system.
accuracyDecimalFalseNoThe accuracy of the prediction or model, typically represented as a percentage, indicating how well the model's outputs match the expected results.
bretrainedBooleanFalseNoIndicates whether the prediction model has been trained, used to track if the model is ready for making predictions.
defaultnameStringFalseNoThe default name associated with the prediction type, used to identify and categorize the specific prediction model or method being applied.
evaldateDateFalseNoThe date when the evaluation of the model or prediction was performed, used for tracking and reporting model performance over time.
maeDecimalFalseNoThe Mean Absolute Error (MAE), a metric that measures the average magnitude of errors in a set of predictions, used to assess model performance.
r2DecimalFalseNoThe R-Squared (R²) value, a statistical measure of how well the regression model fits the data, representing the proportion of variance explained by the model.
rmseDecimalFalseNoThe Root Mean Square Error (RMSE), a measure of the differences between predicted and observed values, used to evaluate the accuracy of the model.

Return to Top

presentationItemType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier assigned to the record, used to reference and distinguish it from other entries within the system.

Return to Top

PreviousTransactionLineLink 

NameTypeReadOnlyReferencesFilterOnlyDescription
foreignamountDecimalFalseNoThe amount in the transaction's foreign currency, representing the monetary value exchanged or recorded in a different currency than the base currency.
linktypeStringFalseNoThe type of link between transactions, used to specify the relationship or connection between related records or entries.
nextdocStringFalseNoThe identifier for the next related transaction, typically used to track the progression or sequence of transactions in a series.
nextlineStringFalseNoThe identifier for the next related transaction line, used to track individual line items within the next transaction in the sequence.
nexttypeStringFalseNoThe type of the next related transaction, used to specify the nature or classification of the next transaction in the sequence (for example, payment, refund).
previousdocStringFalseNoThe identifier for the previous related transaction, often used to track historical relationships or references to prior transactions.
previouslineStringFalseNoThe identifier for the previous related transaction line, used to track line items from earlier transactions in the sequence.

Return to Top

PreviousTransactionLink 

NameTypeReadOnlyReferencesFilterOnlyDescription
linktypeStringFalseNoThe type of relationship or connection between transactions, used to define how records are linked, such as a payment, refund, or transfer.
nextdocStringFalseNoThe identifier for the next related transaction, typically used to track the sequential flow or connection between related transactions.

Return to Top

pricebook 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencyStringFalseNoThe type of currency used for the transaction or record (such as USD, EUR, or GBP), specifying the denomination for monetary values.
externalidStringFalseNoA unique identifier assigned to the record by an external system, used for integration and synchronization across platforms.
idIntegerFalseNoA unique internal identifier assigned to the record, used to reference and manage the entry within the system.
internalidIntegerFalseNoA system-generated identifier that uniquely distinguishes the record within the internal system, often used for database operations.
nameStringFalseNoThe name associated with the record, typically used for identification and display in user interfaces or reports.
subscriptionplanStringFalseNoThe name or identifier of the subscription plan associated with the record, often used to track subscription services or billing cycles.

Return to Top

pricelevel 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to the record, used to track and reference the entry within the system.
discountpctDoubleFalseNoThe percentage of markup or discount applied to the item or price, used for pricing adjustments based on promotions or pricing strategies.
externalidStringFalseNoA unique identifier for the record assigned by an external system, used for integration and synchronization across platforms.
isinactiveBooleanFalseNoIndicates whether the record is inactive, often used to flag records that are no longer in use or should be excluded from active processes.
isonlineBooleanFalseNoIndicates whether the price level is applicable to online transactions, used to differentiate between online and offline pricing strategies.

Return to Top

PriceModelType 

NameTypeReadOnlyReferencesFilterOnlyDescription
isinactiveBooleanFalseNoIndicates whether the record is inactive, typically used to flag records that are no longer in use or should be excluded from active processes.
keyIntegerFalseNoA unique internal identifier assigned to the record, used to reference and distinguish it from other entries within the system.

Return to Top

priceplan 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencyStringFalseNoThe type of currency used for the transaction or record (such as USD, EUR, or GBP), specifying the denomination for monetary values.
externalidStringFalseNoA unique identifier assigned to the record by an external system, used for integration and synchronization across platforms.
idIntegerFalseNoA unique internal identifier assigned to the record, used to track and reference the entry within the system.
internalidIntegerFalseNoA system-generated identifier that uniquely distinguishes the record within the internal system, often used for database operations.
priceplantypeStringFalseNoThe type of pricing plan associated with the record, used to define how prices are calculated and applied, such as standard, tiered, or custom pricing.

Return to Top

priceUsingType 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoA unique internal identifier assigned to the record, used to track and reference the entry within the system.

Return to Top

pricing 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoA unique internal identifier assigned to the record, used to track and reference the entry within the system.
currencyStringFalseNoThe type of currency used for the transaction or record (such as USD, EUR, or GBP), specifying the denomination for monetary values.
itemStringFalseNoThe name or identifier of the item, used to track and manage products, goods, or services within the system.
pricelevelStringFalseNoThe price level associated with the item or transaction, used to define the pricing structure, such as retail, wholesale, or discount pricing.
quantityStringFalseNoThe quantity of the item involved in the transaction, often used to track how many units are being bought, sold, or processed.
saleunitStringFalseNoThe unit of measure (UOM) for the item in the sale (such as pieces, kilograms, or liters), specifying how the quantity is measured.

Return to Top

pricinggroup 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to the record, used for tracking and referencing the entry within the system.
externalidStringFalseNoA unique identifier assigned to the record by an external system, used for integration or synchronization across platforms.
isinactiveBooleanFalseNoIndicates whether the record is inactive, typically used to flag records that are no longer in use or should be excluded from active processes.

Return to Top

ProjectBudgetAmount 

NameTypeReadOnlyReferencesFilterOnlyDescription
adateDateFalseNoThe date associated with the record or transaction, typically used to track when the event or data entry occurred.
eacDecimalFalseNoThe Estimated At Completion (EAC) value, representing the projected total cost or value of a project or process at completion.
keyIntegerFalseNoA unique internal identifier assigned to the record, used for tracking and referencing the entry within the system.
typeStringFalseNoThe type of amount or value, used to specify the nature of the data, such as cost, revenue, or expense.

Return to Top

projectexpensetype 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the record, used to track financial transactions or customer accounts.
descriptionStringFalseNoA detailed description of the record, providing additional context or information about the entity or item.
externalidStringFalseNoA unique identifier assigned to the record by an external system, used for integration or synchronization across different platforms.
isinactiveBooleanFalseNoIndicates whether the record is inactive, often used to flag records that are no longer in use or should be excluded from active processes.
nameStringFalseNoThe name associated with the record, typically used for identification or display purposes in user interfaces or reports.

Return to Top

projecticchargerequest 

NameTypeReadOnlyReferencesFilterOnlyDescription
amountStringFalseNoThe amount associated with the record, typically used to represent a financial value, such as a charge or payment.
chargetriggerStringFalseNoThe condition or event that triggers the charge, used to define when a charge should be applied in a transaction or process.
currencyStringFalseNoThe type of currency used for the transaction or record (such as USD, EUR, or GBP), specifying the denomination for monetary values.
externalidStringFalseNoA unique identifier for the record assigned by an external system, used for integration or synchronization across platforms.
idIntegerFalseNoA unique internal identifier assigned to the record, used to track and reference the entry within the system.
projectStringFalseNoThe project associated with the record, often used for tracking tasks, milestones, or financials within a specific project or initiative.
projecttaskStringFalseNoThe task within the project associated with the record, used to track specific activities or deliverables in the project timeline.
tosubsidiaryStringFalseNoThe subsidiary or business unit that the record is related to, used for multi-entity financial tracking or reporting.
triggerdateDateFalseNoThe date when the trigger condition for the charge or event is met, used to mark the timing of a charge or event in the system.

Return to Top

ProjectSubsidiaryRelationship 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to the record, used to track and reference the entry within the system.
entityStringFalseNoThe entity associated with the record (such as a customer, partner, or account), used to reference the organization or individual involved.
externalidStringFalseNoA unique identifier for the record assigned by an external system, used for integration or synchronization across platforms.
isprimarysubBooleanFalseNoIndicates whether the record represents the primary subsidiary, used to distinguish the main subsidiary from others in a multi-subsidiary structure.
nameStringFalseNoThe name associated with the record, typically used for identification or display purposes in user interfaces or reports.

Return to Top

projecttask 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to the record, used for tracking and referencing the entry within the system.
actualworkDoubleFalseNoThe actual amount of work completed on the task or project, typically measured in hours or units of work.
constrainttypeStringFalseNoThe type of constraint applied to the task or project, such as 'must start on', 'finish no later than', or other scheduling constraints.
contactStringFalseNoThe contact person associated with the task or project, typically the person responsible for communication or project oversight.
enddateDateFalseNoThe date when the task or project is scheduled to be completed, marking the end of the planned duration.
enddatebaselineDateFalseNoThe original or baseline end date for the task or project, used for comparison with the actual end date to track progress.
estimatedworkDoubleFalseNoThe estimated amount of work required to complete the task or project, often used in planning and scheduling.
estimatedworkbaselineDoubleFalseNoThe original or baseline estimated work for the task or project, used as a reference for comparing against actual performance.
eventidIntegerFalseNoA unique identifier for the project task or event, used to track and reference the specific task within the project.
externalidStringFalseNoA unique identifier for the record assigned by an external system, used for integration or synchronization across platforms.
finishbydateDateFalseNoThe date by which the task or project must be finished, used to track deadlines and manage project timelines.
ismilestoneBooleanFalseNoIndicates whether the task is a milestone, used to mark significant events or achievements within the project.
issummarytaskBooleanFalseNoIndicates whether the task is a summary task, used to represent a group of related tasks or a higher-level view of the project.
messageStringFalseNoComments or notes associated with the task or project, often used for additional context or communication among team members.
nonbillabletaskBooleanFalseNoIndicates whether the task is non-billable, often used to track internal tasks or those that are not part of client billing.
ownerStringFalseNoThe person or entity responsible for the task or project, often the creator or the individual assigned to oversee the work.
parentStringFalseNoThe parent task associated with the record, used to define hierarchical relationships between tasks or subtasks.
percenttimecompleteDoubleFalseNoThe percentage of the task or project that has been completed, used for progress tracking and reporting.
priorityStringFalseNoThe priority level of the task or project, indicating its importance relative to other tasks or projects.
projectStringFalseNoThe project associated with the task, used to track the job or initiative under which the task is being completed.
remainingworkDoubleFalseNoThe amount of work remaining to complete the task or project, often calculated as the difference between total work and completed work.
startdatebaselineDateFalseNoThe original or baseline start date for the task or project, used for tracking deviations from the planned schedule.
startdatetimeDateFalseNoThe start date and time for the task or project, marking the beginning of the work or project phase.
statusStringFalseNoThe current status of the task or project, such as 'not started', 'in progress', 'completed', or 'delayed'.
titleStringFalseNoThe name or title of the task or project, typically used for identification or display purposes in user interfaces or reports.

Return to Top

projectTaskAssignee 

NameTypeReadOnlyReferencesFilterOnlyDescription
costDecimalFalseNoThe total cost associated with the task, project, or item, representing the financial expense incurred for the work or goods provided.
estimatedworkDoubleFalseNoThe estimated amount of work required to complete the task or project, often measured in hours or units and used for planning and scheduling.
priceDecimalFalseNoThe total price associated with the task, project, or item, typically representing the amount to be charged to the customer or client.
projecttaskStringFalseNoThe specific task associated with the project, used to track individual activities or milestones within the larger project.
resourceStringFalseNoThe resource assigned to the task or project (such as a person, machine, or material), used to execute the work.
resourcegroupStringFalseNoA group of resources associated with the task or project, typically used for managing and allocating resources efficiently across multiple tasks or projects.
serviceitemStringFalseNoThe specific service item associated with the task, project, or transaction, used to represent the service being provided to the customer.
unitcostDecimalFalseNoThe cost per unit of the item or service, used to calculate the total cost based on the quantity or amount involved in the transaction.
unitpriceDecimalFalseNoThe price per unit of the item or service, used to calculate the total price based on the quantity or amount sold or provided.

Return to Top

projectTaskConstraintType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier assigned to the record, used to reference and distinguish it from other entries within the system or across external systems.

Return to Top

projectTaskPredecessor 

NameTypeReadOnlyReferencesFilterOnlyDescription
lagdaysDoubleFalseNoThe lag time between tasks, typically used to define the delay or waiting period between the completion of one task and the start of the next.
predecessorStringFalseNoThe task that must be completed before the current task can begin, used to define task dependencies in project management.
successorStringFalseNoThe task that follows the current task, often used to define the next dependent task in a sequence or workflow.

Return to Top

projecttemplate 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to the record, used to track and reference the entry within the system.
allowallresourcesfortasksBooleanFalseNoIndicates whether all available resources should be displayed for project task assignment, allowing for a wider selection of resources.
allowexpensesBooleanFalseNoIndicates whether expenses are allowed for the project or task, enabling the recording and tracking of costs incurred.
allowtimeBooleanFalseNoIndicates whether time entry is allowed for the project or task, allowing users to log the time spent on work.
billingscheduleStringFalseNoThe schedule for billing the project or task, specifying the timing or frequency of billing, such as monthly or upon completion.
entityidStringFalseNoThe name or unique identifier of the entity associated with the record, typically used for tracking clients, vendors, or other key entities.
estimatedcostDecimalFalseNoThe estimated cost for completing the project or task, used for budgeting and financial planning.
estimatedgrossprofitDecimalFalseNoThe estimated gross profit for the project or task, calculated as the difference between estimated revenue and estimated cost.
estimatedgrossprofitpercentDoubleFalseNoThe estimated gross profit percentage, calculated as the ratio of estimated gross profit to estimated revenue, expressed as a percentage.
estimatedlaborcostDecimalFalseNoThe estimated labor cost for the project or task, representing the costs associated with the labor required to complete the work.
estimatedlaborrevenueDecimalFalseNoThe estimated labor revenue for the project or task, representing the expected revenue from labor charges.
estimatedrevenueDecimalFalseNoThe total estimated revenue for the project or task, used for financial forecasting and budgeting.
estimatedtimeoverrideDoubleFalseNoThe estimated work, often used to override default time estimations for a project or task.
externalidStringFalseNoA unique identifier assigned to the record by an external system, used for integration and synchronization across platforms.
forecastchargerunondemandBooleanFalseNoIndicates whether forecast charges can be run on demand, allowing for dynamic forecasting and charge calculations.
includecrmtasksintotalsBooleanFalseNoIndicates whether CRM-related tasks should be included in the overall job totals, ensuring that these tasks are considered in financial and resource planning.
isexempttimeBooleanFalseNoIndicates whether time is classified as exempt, typically used to track hours that are not subject to overtime pay or other labor regulations.
isinactiveBooleanFalseNoIndicates whether the record is inactive, flagging it as no longer in use or relevant in the system.
isproductivetimeBooleanFalseNoIndicates whether the time logged is classified as productive, typically used to track billable or value-added work.
isutilizedtimeBooleanFalseNoIndicates whether the time logged is classified as utilized, used for tracking time spent on actual productive work within the project.
jobbillingtypeStringFalseNoThe type of billing associated with the project, such as fixed-price, time-and-materials, or milestone-based billing.
jobitemStringFalseNoThe item associated with billing for the project, typically used to track the specific service or product being billed to the client.
jobpriceDecimalFalseNoThe price associated with the project, typically representing the total cost or value assigned to the project or service.
limittimetoassigneesBooleanFalseNoIndicates whether time and expenses should be limited to the resources assigned to the project, restricting logging to only those with assigned roles.
materializetimeBooleanFalseNoIndicates whether planned time entries should be created, used for tracking and managing time allocations for project tasks.
projectmanagerStringFalseNoThe individual responsible for managing the project, often used to track accountability and leadership for project completion.
startdateDateFalseNoThe start date for the project or task, marking the beginning of the work or project phase.

Return to Top

projectTemplateJobResource 

NameTypeReadOnlyReferencesFilterOnlyDescription
jobresourceStringFalseNoThe name of the resource associated with the project, typically used to track personnel, equipment, or materials assigned to project tasks.
projecttemplateStringFalseNoThe project template associated with the record, used to define the standard structure, tasks, and workflows that should be followed for similar projects.

Return to Top

ProjectTemplateSubsidiaryRelationship 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to the record, used for tracking and referencing the entry within the system.
entityStringFalseNoThe entity associated with the record (such as a customer, partner, or account), used to reference the organization or individual involved.
externalidStringFalseNoA unique identifier for the record assigned by an external system, used for integration or synchronization across platforms.
isprimarysubBooleanFalseNoIndicates whether the record represents the primary subsidiary, used to distinguish the main subsidiary from others in a multi-subsidiary structure.
nameStringFalseNoThe name associated with the record, typically used for identification or display purposes in user interfaces or reports.

Return to Top

ProjectTimeApprovalType 

NameTypeReadOnlyReferencesFilterOnlyDescription
idIntegerFalseNoA unique internal identifier assigned to the record, used to track and reference the entry within the system.

Return to Top

promocodediscounttype 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier assigned to the record, used to reference and distinguish it from other entries within the system or across external systems.

Return to Top

promotioncode 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to the record, used to track and reference the entry within the system.
applydiscounttoStringFalseNoIndicates whether the promotion can be applied to each customer, allowing for targeted or generalized discounts based on customer eligibility.
codepatternStringFalseNoThe pattern or format of the discount code, used to define the structure of the code that customers can enter to apply the promotion.
descriptionStringFalseNoA detailed description of the promotion, used to provide additional context or information about the promotion’s terms and conditions.
discountStringFalseNoThe discount value or percentage associated with the promotion, indicating the amount the customer will save on their purchase.
discounttypeStringFalseNoThe type of discount being applied, such as a percentage discount, fixed amount discount, or other discount models.
displaylinediscountsBooleanFalseNoIndicates whether discounts are displayed at the individual line item level on invoices or receipts, allowing for transparency in pricing.
enddateDateFalseNoThe date when the promotion ends, marking the cutoff point for when the promotion is no longer valid.
externalidStringFalseNoA unique identifier assigned to the record by an external system, used for integration and synchronization across platforms.
freeshipmethodStringFalseNoThe shipping method associated with the promotion that offers free shipping, allowing customers to use specific shipping options without charge.
isinactiveBooleanFalseNoIndicates whether the promotion is inactive, often used to flag promotions that are no longer available or have expired.
ispublicBooleanFalseNoIndicates whether the promotion is available to all customers, making it publicly accessible for any eligible customer to use.
locationStringFalseNoThe physical or virtual location where the promotion applies, often used to target specific geographic areas or store locations.
nameStringFalseNoThe name of the promotion, typically used for identification and display in user interfaces or reports.
promotiontypeStringFalseNoThe type of promotion (such as a seasonal sale, clearance event, or loyalty discount), used to categorize the nature of the promotion.
rateStringFalseNoThe rate or amount associated with the discount or promotion, typically used to specify the value or percentage of the discount being applied.
startdateDateFalseNoThe date when the promotion starts, marking the beginning of when the promotion is active and can be applied to customer orders.
usetypeStringFalseNoThe type of coupon code used (such as a one-time use, multiple-use, or unique user code), to define the rules around how the code can be applied.

Return to Top

promotionCodeCampaigns 

NameTypeReadOnlyReferencesFilterOnlyDescription
campaigneventnameStringFalseNoThe name of the campaign event, typically used to identify and categorize the event within a marketing or promotional campaign.
categoryStringFalseNoThe category associated with the campaign or promotion, used to group and classify events, products, or services based on similar characteristics or goals.
datesentDateFalseNoThe date when the campaign event or promotion was sent or executed, used for tracking the timing of marketing efforts or promotions.
promotioncodeStringFalseNoThe unique code associated with the promotion, used by customers to redeem the offer, often entered at checkout or registration.
statusStringFalseNoThe current status of the promotion or campaign event (such as 'active', 'expired', 'completed', or 'pending'), used to track the progress of the promotional effort.

Return to Top

promotionCodeCouponInstances 

NameTypeReadOnlyReferencesFilterOnlyDescription
codeStringFalseNoThe unique coupon code associated with the promotion, used by customers to redeem discounts or special offers during checkout.
datesentDateFalseNoThe date when the coupon or promotion was sent to the recipient, used for tracking the timing of distribution and effectiveness.
promotioncodeStringFalseNoThe identifier for the promotion, used to link the coupon code to a specific promotional event or discount offer.
recipientStringFalseNoThe individual or entity who receives the coupon or promotion, often used for targeted marketing or customer-specific offers.
usecountIntegerFalseNoThe number of times the coupon or promotion has been used, used for tracking redemption rates and managing promotion limits.

Return to Top

promotionCodeCurrency 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencyStringFalseNoThe type of currency used for the promotion (such as USD, EUR, or GBP), specifying the denomination for monetary values associated with the offer.
promotioncodeStringFalseNoThe unique identifier for the promotion, used to link the coupon or offer to a specific promotion or discount event.

Return to Top

promotionCodeItems 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item, used to track and manage products, goods, or services within the system.

Return to Top

promotioncodelocationmap 

NameTypeReadOnlyReferencesFilterOnlyDescription
locationStringFalseNoThe physical or virtual location associated with the record, used to specify where an item, event, or transaction is taking place.

Return to Top

promotionCodePartnerMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
partnerStringFalseNoThe partner associated with the record, typically used to track business relationships, collaborations, or affiliations with external entities.

Return to Top

promotionCodeWebsiteMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
promotioncodeStringFalseNoThe unique code used to redeem a promotion or discount, typically entered by the customer during checkout or registration.

Return to Top

prospect 

NameTypeReadOnlyReferencesFilterOnlyDescription
accessroleStringFalseNoThe role or level of access assigned to the user, defining what permissions or privileges they have within the system.
accountnumberStringFalseNoThe number associated with the account, typically used to track and reference customer or company accounts.
altemailStringFalseNoAn alternative email address associated with the record, often used for backup or secondary communication.
altphoneStringFalseNoAn alternative phone number associated with the record, used for backup or secondary contact.
assignedwebsiteStringFalseNoThe website assigned to the entity or record, often used to link the record to a specific online presence.
autonameBooleanFalseNoIndicates whether the name for the record is generated automatically, often used for record naming conventions.
balanceDecimalFalseNoThe balance associated with the account or record, representing the current amount due or available.
billpayBooleanFalseNoIndicates whether bill payment functionality is enabled for the record, typically used for managing financial transactions.
buyingreasonStringFalseNoThe reason for the purchase or transaction, often used for categorizing or understanding customer buying behavior.
buyingtimeframeStringFalseNoThe timeframe within which the customer intends to make the purchase, such as immediate, within 30 days, or long-term.
campaigncategoryStringFalseNoThe category associated with the campaign, used to group and classify campaigns based on similar goals or themes.
categoryStringFalseNoThe category associated with the record, used for organizing and classifying items, customers, or services.
clickstreamStringFalseNoThe stream of user interactions with a website, typically used for tracking user behavior and analyzing web traffic.
commentsStringFalseNoAdditional comments or notes associated with the record, often used for internal communication or documentation.
companynameStringFalseNoThe name of the company associated with the record, typically used for business-to-business interactions.
consolbalanceDecimalFalseNoThe consolidated balance for the account, often used for reporting and tracking balances across multiple entities or accounts.
consoldaysoverdueIntegerFalseNoThe number of days that the consolidated balance is overdue, typically used for managing collections or aging reports.
consoldepositbalanceDecimalFalseNoThe consolidated deposit balance, used to track total deposit amounts across various accounts or entities.
consoloverduebalanceDecimalFalseNoThe consolidated overdue balance, representing the total overdue amounts across multiple accounts or entities.
consolunbilledordersDecimalFalseNoThe total unbilled orders across the account, used to track orders that have not yet been invoiced.
contactStringFalseNoThe contact associated with the record, typically used for customer or partner relationship management.
creditholdoverrideStringFalseNoAn override for the credit hold status, used to manually control whether an account is allowed to proceed with transactions despite credit issues.
creditlimitStringFalseNoThe credit limit assigned to the account, used to determine the maximum amount of credit the account holder can access.
currencyStringFalseNoThe type of currency used for the record or transaction (such as USD, EUR, or GBP), specifying the denomination for monetary values.
currencyprecisionStringFalseNoThe precision of currency calculations, often used to define the number of decimal places for currency values.
customformStringFalseNoThe custom form associated with the record, used to personalize the fields and layout for specific transactions or entities.
datecreatedDatetimeFalseNoThe date and time when the record was created, used to track the origin and history of the entry.
daysoverdueIntegerFalseNoThe number of days the account or record is overdue, typically used for tracking payment delays or overdue tasks.
defaultaddressStringFalseNoThe default address associated with the record, used for billing, shipping, or contact purposes.
defaultbankaccountStringFalseNoThe default bank account associated with the record, typically used for processing transactions or payments.
depositbalanceDecimalFalseNoThe current balance of the deposit associated with the record, used to track funds held for future use or transactions.
draccountStringFalseNoThe debit account associated with the record, typically used for accounting and transaction management.
emailStringFalseNoThe email address associated with the record, used for communication and notifications.
emailpreferenceStringFalseNoThe email preference for receiving communications, used to specify which types of emails the recipient is willing to receive.
emailtransactionsBooleanFalseNoIndicates whether email notifications are enabled for transaction-related activities, such as order updates or invoices.
entityidStringFalseNoThe identifier for the entity associated with the record, used for tracking customer, partner, or account details.
entitystatusStringFalseNoThe status of the entity (such as active, inactive, or pending), used to track the current state of the record.
estimatedbudgetDecimalFalseNoThe estimated budget for the project or task, used for financial forecasting and planning.
externalidStringFalseNoA unique identifier for the record assigned by an external system, used for integration or synchronization across platforms.
faxStringFalseNoThe fax number associated with the record, used for communication via fax.
faxtransactionsBooleanFalseNoIndicates whether fax notifications are enabled for transaction-related activities, such as order confirmations or invoices.
firstnameStringFalseNoThe first name of the contact or entity associated with the record, used for personalized communication.
firstvisitDatetimeFalseNoThe date and time of the first visit or interaction associated with the record, often used for tracking customer engagement.
fxaccountStringFalseNoThe foreign exchange account associated with the record, used to manage currency exchange transactions.
giveaccessBooleanFalseNoIndicates whether access to the record or system is granted, typically used to manage user permissions and roles.
globalsubscriptionstatusStringFalseNoThe global subscription status of the record, indicating whether the subscription is active, expired, or pending.
homephoneStringFalseNoThe home phone number associated with the record, used for contact purposes.
imageStringFalseNoThe image associated with the record, typically used for profiles, product listings, or visual identification.
isbudgetapprovedBooleanFalseNoIndicates whether the budget for the project or task has been approved, typically used in financial management and project planning.
isinactiveBooleanFalseNoIndicates whether the record is inactive, often used to flag records that are no longer in use or relevant.
isjobStringFalseNoIndicates whether the record is related to a job or project, often used in resource and task management.
ispersonStringFalseNoIndicates whether the record represents a person, used to differentiate individuals from other types of entities.
keywordsStringFalseNoThe keywords associated with the record, used for search and classification purposes.
languageStringFalseNoThe language associated with the record, used for localization and region-specific settings.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified, used for auditing and tracking changes to the entry.
lastnameStringFalseNoThe last name of the contact or entity associated with the record, used for personalized communication.
lastpagevisitedStringFalseNoThe last page or section visited in the system or website, often used for tracking user behavior.
lastvisitDatetimeFalseNoThe date and time of the last visit or interaction associated with the record, used for tracking customer engagement.
leadsourceStringFalseNoThe source of the lead (such as direct, referral, or marketing campaign), used for sales tracking and analysis.
middlenameStringFalseNoThe middle name of the contact or entity associated with the record, used for personalized communication.
mobilephoneStringFalseNoThe mobile phone number associated with the record, used for contact and communication.
monthlyclosingStringFalseNoThe monthly closing process or deadline associated with the record, used in financial reporting and accounting.
negativenumberformatStringFalseNoThe format used for displaying negative numbers, often used in financial or accounting reports.
numberformatStringFalseNoThe format used for displaying numbers, such as currency, percentage, or plain number.
openingbalanceDecimalFalseNoThe opening balance for the record, used to track the starting value of an account or project.
openingbalanceaccountStringFalseNoThe account associated with the opening balance, typically used for financial or accounting purposes.
openingbalancedateDateFalseNoThe date associated with the opening balance, marking the start of the financial period or project.
otherrelationshipsStringFalseNoOther relationships associated with the record, used to track connections or affiliations with other entities.
overduebalanceDecimalFalseNoThe amount of the balance that is overdue, used to track outstanding payments or tasks.
parentStringFalseNoThe parent entity associated with the record, used for hierarchical relationships between entities or accounts.
partnerStringFalseNoThe partner associated with the record, typically used for business relationships or collaborations.
phoneStringFalseNoThe phone number associated with the record, used for contact and communication.
phoneticnameStringFalseNoThe phonetic version of the name, often used for pronunciation or speech recognition.
prefccprocessorStringFalseNoThe preferred credit card processor associated with the record, used for payment processing.
pricelevelStringFalseNoThe pricing level associated with the record, used to define the pricing structure, such as retail or wholesale pricing.
printoncheckasStringFalseNoThe name to print on checks, used for business or vendor-related transactions.
printtransactionsBooleanFalseNoIndicates whether transaction details should be printed, often used for receipts or invoices.
probabilityStringFalseNoThe probability of closing a sale or opportunity, often used in sales forecasting and pipeline management.
receivablesaccountStringFalseNoThe account associated with receivables, used for tracking money owed to the organization.
referrerStringFalseNoThe referrer associated with the record, often used to track how the lead or customer found the business.
resalenumberStringFalseNoThe resale number associated with the record, used for tracking sales transactions or tax exemptions.
salesreadinessStringFalseNoThe readiness level of the sales opportunity, used to assess how prepared the deal is for closing.
salesrepIntegerFalseNoThe sales representative associated with the record, typically used to track individual performance or responsibility.
salutationStringFalseNoThe salutation used for the contact (such as Mr., Ms., Dr.), or other formal address titles.
sendemailBooleanFalseNoIndicates whether email notifications are enabled for the record, used for communication or alerts.
sourcewebsiteStringFalseNoThe website associated with the source of the lead or record, used for tracking the origin of traffic or inquiries.
stageStringFalseNoThe stage of the record (such as lead, prospect, or customer), used to track the progress in a sales or business process.
startdateDateFalseNoThe date when the record, project, or transaction begins, used to track start times for business activities.
strengthStringFalseNoThe strength of the lead or opportunity, often used in sales to measure the likelihood of conversion.
subsidiaryStringFalseNoThe subsidiary or business unit associated with the record, used in multi-entity organizations for financial and operational tracking.
syncpartnerteamsBooleanFalseNoIndicates whether the record should be synchronized with partner teams, ensuring shared access to relevant data.
syncsalesteamsBooleanFalseNoIndicates whether the record should be synchronized with sales teams, allowing for shared access to sales-related data.
taxableBooleanFalseNoIndicates whether the entity or transaction is subject to tax, used for determining tax liability.
taxfractionunitStringFalseNoThe fractional unit used for tax calculations, defining precision in rounding or tax breakdowns.
taxitemStringFalseNoThe specific tax item associated with the record, used to determine the applicable tax rate or type.
taxroundingStringFalseNoThe method used for rounding tax calculations (such as up, down, or nearest), to ensure compliance with tax regulations.
termsStringFalseNoThe payment terms associated with the transaction, such as Net 30, due on receipt, or installment plans.
territoryStringFalseNoThe sales or business territory associated with the record, used for regional tracking and reporting.
titleStringFalseNoThe title or designation of the individual (such as CEO, Manager, or Director), used for identification and classification.
unbilledordersDecimalFalseNoThe total value of orders that have not yet been billed, used to track pending invoices.
unsubscribeStringFalseNoIndicates whether the record has opted out of email or marketing communications, used for compliance with subscription preferences.
urlStringFalseNoThe website URL associated with the record, often used to track company websites, lead sources, or external references.
vatregnumberStringFalseNoThe VAT registration number associated with the entity, used for tax and compliance purposes.
visitsIntegerFalseNoThe number of visits or interactions recorded for the entity, often used in web analytics or customer engagement tracking.
webleadStringFalseNoIndicates whether the lead originated from a web source, used to track online lead generation efforts.

Return to Top

publishedSavedSearch 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier assigned to the record, used to track and reference the entry within the system.
currentaudienceStringFalseNoThe target audience for the record or content, used to specify the group of users or customers intended to view or engage with the content.
disallowdrilldownBooleanFalseNoIndicates whether drill-down functionality is disallowed, preventing users from exploring more detailed information or layers of data.
excludefromsitemapBooleanFalseNoIndicates whether the record should be excluded from the sitemap, used to control which pages or records are indexed by search engines.
fullnameStringFalseNoThe full name associated with the record, typically used for individuals or entities in user interfaces and reports.
isinactiveBooleanFalseNoIndicates whether the record is inactive, flagging it as no longer relevant or in use within the system.
isonlineBooleanFalseNoIndicates whether the record or content should be displayed on the website, allowing it to be publicly accessible or hidden.
itemlistlayoutStringFalseNoThe layout used for displaying the list of items, often used in catalogs, product listings, or inventory displays on websites.
metataghtmlStringFalseNoThe HTML code used for meta tags, often for search engine optimization (SEO) purposes, to define metadata such as title, description, and keywords for search engines.
nameStringFalseNoThe title or name associated with the record, typically used for identification or display purposes within user interfaces.
pagetitleStringFalseNoThe title of the webpage associated with the record, used for SEO, browser tab identification, and page headers.
parent_categoryStringFalseNoThe parent category under which the record or item falls, used for organizing content or products within a hierarchical structure.
searchStringFalseNoThe search query or search term associated with the record, often used for search engine optimization or internal search functionality.
searchkeywordsStringFalseNoKeywords associated with the record to help improve its discoverability via search engines or internal search tools.
sectiondescriptionStringFalseNoA brief description of the section or record, typically used for summary or introductory purposes.
sectiondetaileddescriptionStringFalseNoA more detailed description of the section or record, providing in-depth information about the content or item.
sitemappriorityStringFalseNoThe priority of the record in the sitemap, used to indicate its importance relative to other pages or records for search engine crawlers.
storedisplayimageStringFalseNoThe image associated with the record, typically used as a visual representation on the website or in listings.
storedisplaythumbnailStringFalseNoThe thumbnail image associated with the record, often used for smaller displays or previews in listings, galleries, or search results.
urlcomponentStringFalseNoThe URL component or slug associated with the record, used for building and defining the webpage’s URL structure.

Return to Top

publishedSavedSearchPresItemPresCategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
basepriceDecimalFalseNoThe base price of the item or service, typically representing the standard cost or starting price before any discounts or adjustments.
categoryStringFalseNoThe category to which the item belongs, used for organizing and classifying items or services based on similar characteristics or purposes.
descriptionStringFalseNoA detailed description of the item or service, providing information such as features, specifications, or other relevant details.
filecabinetStringFalseNoThe file cabinet or storage location associated with the item, used to track where the item's related documents or files are stored.
infoitemStringFalseNoAn informational item associated with the record, typically used to provide additional context or support material related to the item.
itemStringFalseNoThe name or identifier of the item, used to track and manage products, goods, or services within the system.
nameStringFalseNoThe name of the item or service, typically used for identification and display purposes in user interfaces or reports.
onlinepriceDecimalFalseNoThe price of the item or service when sold online, which can differ from the base price due to online discounts, promotions, or specific pricing strategies.

Return to Top

publishedSavedSearchSiteCategoryTagSubstitution 

NameTypeReadOnlyReferencesFilterOnlyDescription
sectionStringFalseNoThe section associated with the record, typically used to categorize or organize content or data within a larger structure or layout.
valueStringFalseNoThe substitution value associated with the record, used for replacing or inserting specific data in templates, reports, or calculations.

Return to Top

publishedSavedSearchSiteCategoryTranslationPublishedSavedSearch 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoA brief description of the record, typically used to provide a short summary or overview of the item or content.
languageStringFalseNoThe language associated with the record, used to specify the language in which the content is written or displayed.
pagetitleStringFalseNoThe title of the webpage associated with the record, often used for search engine optimization (SEO), browser tabs, and page headers.
salesdescriptionStringFalseNoA detailed description of the item or service, typically used for marketing or sales purposes, outlining features and benefits.
sectionStringFalseNoThe section to which the record belongs, used for organizing content or items within a specific category or page layout.

Return to Top

purchasecontract 

NameTypeReadOnlyReferencesFilterOnlyDescription
billedamountDecimalFalseNoThe total amount that has been billed for the record, typically used in invoicing or financial reporting.
billinginstructionsStringFalseNoThe instructions related to billing, often used to define special billing requirements or conditions for the record.
carrierStringFalseNoThe carrier associated with the order or shipment, used to track the delivery service or logistics provider handling the items.
classStringFalseNoThe classification or category assigned to the record, often used to group records by type or business function for reporting and management.
createddateDatetimeFalseNoThe date and time when the record was created, used to track the origin and timeline of the entry.
createdfromStringFalseNoThe origin of the record, typically used to link the record to another source or transaction from which it was created.
currencyStringFalseNoThe currency used for the transaction or record (such as USD, EUR, or GBP), indicating the monetary unit.
currencynameStringFalseNoThe name of the currency associated with the record, such as 'United States Dollar' or 'Euro'.
currencysymbolStringFalseNoThe symbol associated with the currency, such as '$' for USD or '€' for EUR.
customformStringFalseNoThe custom form associated with the record, often used to define the layout and structure of fields for specific transactions or entities.
departmentStringFalseNoThe department within the organization associated with the record, often used for tracking or allocating costs or tasks.
effectivitybasedonStringFalseNoThe basis for determining the effectiveness of the record, such as a specific date, event, or other criteria.
employeeStringFalseNoThe employee associated with the record, typically used to track assignments, tasks, or responsibilities.
enddateDateFalseNoThe end date for the record, often used to mark the conclusion of a contract, project, or service period.
entityStringFalseNoThe entity associated with the record (such as a customer, supplier, or partner), used to track relationships.
entitynexusStringFalseNoThe nexus or connection between the entity and the transaction, often used to track the relationship for tax or reporting purposes.
exchangerateDecimalFalseNoThe exchange rate used for currency conversion, representing the value of one currency in terms of another.
externalidStringFalseNoA unique identifier for the record assigned by an external system, used for integration or synchronization across platforms.
incotermStringFalseNoThe Incoterm associated with the transaction, used to define the terms of shipment and responsibility for shipping costs.
isbasecurrencyBooleanFalseNoIndicates whether the currency used for the record is the base currency for the organization, used for financial reporting.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified, used for tracking changes or updates to the record.
locationStringFalseNoThe location associated with the record, typically used to track where the transaction, item, or service is taking place.
maximumamountStringFalseNoThe maximum amount associated with the record, often used to define limits or thresholds for financial transactions.
memoStringFalseNoA memo or note associated with the record, often used for providing additional context or information about the transaction.
minimumamountStringFalseNoThe minimum amount associated with the record, often used to define the lower limit for a transaction or order.
nexusStringFalseNoThe nexus or legal entity associated with the record, used to track tax jurisdictions or business relationships.
oldrevenuecommitmentStringFalseNoA prior or legacy revenue commitment associated with the record, often used for tracking historical sales or agreements.
orderstatusStringFalseNoThe current status of the order (such as 'pending', 'shipped', 'delivered', or 'canceled'), used to track order progress.
otherrefnumStringFalseNoAn additional reference number associated with the record, often used for cross-referencing with other systems or records.
packinglistinstructionsStringFalseNoThe instructions related to the packing list for the order, typically used for packaging or shipment preparation.
productlabelinginstructionsStringFalseNoThe instructions for labeling the product, used for defining how products should be marked or identified for shipping or inventory.
purchasedamountDecimalFalseNoThe total amount purchased for the record, typically used in purchasing or procurement transactions.
purchaseorderinstructionsStringFalseNoInstructions related to the purchase order, used to define special conditions or terms for the purchase.
receivedamountDecimalFalseNoThe amount that has been received for the record, typically used in receiving or inventory transactions to track items received.
sourceStringFalseNoThe source of the record, often used to track where the record originated, such as a lead source or sales channel.
startdateDateFalseNoThe start date for the record, often used to mark the beginning of a contract, project, or service period.
statusStringFalseNoThe current status of the record (such as 'active', 'completed', 'pending', or 'closed'), used for tracking its state in the workflow.
statusRefStringFalseNoA reference to the status associated with the record, typically used for external systems or integration purposes.
subsidiaryStringFalseNoThe subsidiary or division of the organization associated with the record, used for multi-entity financial tracking or reporting.
termsStringFalseNoThe terms associated with the record, such as payment terms, shipping terms, or contractual terms.
trandateDateFalseNoThe transaction date associated with the record, used to track when the transaction or event occurred.
tranidStringFalseNoA unique identifier for the transaction, used to track and reference the specific transaction record.
updatecurrencyStringFalseNoIndicates the currency used for updates to the record, used when adjusting or converting currency values in transactions.
updateitemvendorBooleanFalseNoIndicates whether the item vendor should be updated, often used in inventory or purchase order management.

Return to Top

purchaseorder 

NameTypeReadOnlyReferencesFilterOnlyDescription
approvalstatusStringFalseNoThe approval status of the record, used to track whether the record has been approved or is pending approval.
availablevendorcreditDecimalFalseNoThe available credit from the vendor, used to track how much credit is available for future transactions with the vendor.
balanceDecimalFalseNoThe current balance of the account or record, representing the amount owed or available.
billaddressStringFalseNoThe billing address associated with the record, used for invoicing and financial transactions.
billingaddressStringFalseNoThe address where the bill for the record is sent, typically used for customer billing and invoicing.
billisresidentialStringFalseNoIndicates whether the billing address is residential, used for distinguishing between business and personal addresses.
classStringFalseNoThe classification or category assigned to the record, used for organizing and grouping related records for reporting or management.
createddateDatetimeFalseNoThe date and time when the record was created, used for tracking the origin and timeline of the entry.
createdfromStringFalseNoThe source or origin from which the record was created, often used to link the record to another source or transaction.
currencyStringFalseNoThe type of currency used for the transaction or record (such as USD, EUR, or GBP), indicating the monetary unit.
currencynameStringFalseNoThe name of the currency associated with the record, such as 'United States Dollar' or 'Euro'.
currencysymbolStringFalseNoThe symbol associated with the currency, such as '$' for USD or '€' for EUR.
customformStringFalseNoThe custom form associated with the record, used to define the layout and structure of fields for specific transactions or entities.
departmentStringFalseNoThe department associated with the record, typically used for tracking costs, tasks, or resources within an organization.
duedateDateFalseNoThe due date for the record or transaction, marking when payment, completion, or other obligations are expected.
emailStringFalseNoThe email address associated with the record, used for communication and notifications.
employeeStringFalseNoThe employee associated with the record, used for tracking employee-related information or responsibilities.
entityStringFalseNoThe entity associated with the record (such as a customer, partner, or vendor), used to track relationships.
entitynexusStringFalseNoThe nexus or connection between the entity and the transaction, used for tracking tax or jurisdictional relationships.
entitytaxregnumStringFalseNoThe tax registration number associated with the entity, used for tax and compliance purposes.
exchangerateDecimalFalseNoThe exchange rate used for currency conversion, representing the value of one currency in terms of another.
externalidStringFalseNoA unique identifier for the record assigned by an external system, used for integration or synchronization across platforms.
fobStringFalseNoThe Free On Board (FOB) terms associated with the record, used to define shipping responsibilities and cost allocation.
incotermStringFalseNoThe Incoterm associated with the transaction, defining the shipping and delivery terms between the buyer and seller.
intercostatusStringFalseNoThe status of the intercompany transaction, used for managing intercompany sales, purchases, or transfers.
intercotransactionStringFalseNoThe intercompany transaction identifier, used to link related transactions between different company entities.
isbasecurrencyBooleanFalseNoIndicates whether the currency used for the record is the base currency for the organization, used for financial reporting.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified, used for tracking changes or updates to the record.
linkedtrackingnumbersStringFalseNoThe tracking numbers associated with the record, used for tracking the shipment or delivery status.
locationStringFalseNoThe location associated with the record, typically used to track the origin or destination of goods, services, or transactions.
memoStringFalseNoA memo or note associated with the record, used to provide additional context or information about the transaction.
messageStringFalseNoThe message associated with the record, often used for communication or notifications.
nextapproverStringFalseNoThe individual or role responsible for the next approval step in the approval workflow for the record.
nexusStringFalseNoThe nexus or jurisdiction associated with the record, used for tracking tax obligations and regulatory compliance.
orderstatusStringFalseNoThe current status of the order (such as 'pending', 'shipped', 'completed', or 'canceled'), used to track order progress.
otherrefnumStringFalseNoAn additional reference number associated with the record, often used for cross-referencing with other systems or records.
purchasecontractStringFalseNoThe purchase contract associated with the record, used for tracking the terms and conditions of the purchase agreement.
returntrackingnumbersStringFalseNoThe tracking numbers for returned goods, used to track the status of returns or exchanges.
shipaddressStringFalseNoThe address where the goods or services are shipped, used for logistics and shipping purposes.
shipdateDateFalseNoThe date when the goods or services are shipped, marking the start of the delivery process.
shipisresidentialStringFalseNoIndicates whether the shipping address is residential, used to distinguish between business and personal delivery addresses.
shipmethodStringFalseNoThe method of shipping used for the transaction, such as ground, air, or express delivery.
shipoverrideStringFalseNoIndicates whether shipping terms or methods have been manually overridden for the record.
shippingaddressStringFalseNoThe address where the items will be shipped, used to ensure accurate delivery of goods.
shiptoStringFalseNoThe recipient or destination associated with the shipment, typically used for directing where the items are sent.
sourceStringFalseNoThe source from which the record originated, often used for tracking leads or the origin of transactions.
statusStringFalseNoThe current status of the record (such as 'active', 'pending', 'completed', or 'canceled'), used for tracking its state.
statusrefStringFalseNoA reference to the status associated with the record, used to link to external systems or other reference points.
subsidiaryStringFalseNoThe subsidiary or division of the organization associated with the record, used for multi-entity financial tracking or reporting.
subsidiarytaxregnumStringFalseNoThe tax registration number associated with the subsidiary, used for tracking tax obligations specific to the subsidiary.
supervisorapprovalBooleanFalseNoIndicates whether supervisor approval is required for the record, often used in approval workflows for transactions.
taxdetailsoverrideBooleanFalseNoIndicates whether tax details have been manually overridden, often used to adjust tax calculations or exceptions.
taxpointdateDateFalseNoThe date when the tax point is determined, often used to track when tax liability is triggered for the record.
taxpointdateoverrideBooleanFalseNoIndicates whether the tax point date has been overridden, used for customizing tax calculation rules.
taxregoverrideBooleanFalseNoIndicates whether the tax registration number or related tax rules have been overridden for the record.
termsStringFalseNoThe payment terms associated with the transaction, such as 'Net 30', 'Due on receipt', or other standard payment conditions.
tobeemailedBooleanFalseNoIndicates whether the record or transaction is to be emailed to the recipient, used for notifications or invoicing.
tobefaxedBooleanFalseNoIndicates whether the record or transaction is to be faxed to the recipient, often used for formal documentation or notifications.
tobeprintedBooleanFalseNoIndicates whether the record or transaction is to be printed, used for generating hard copy documentation or invoices.
totalDecimalFalseNoThe total amount associated with the record, typically representing the sum of charges, fees, or costs for the transaction.
trackingnumbersStringFalseNoThe tracking numbers associated with the shipment or delivery, used for tracking the status of goods or services in transit.
trandateDateFalseNoThe transaction date associated with the record, used for tracking when the transaction occurred or was recorded.
tranidStringFalseNoA unique identifier for the transaction, used for tracking and referencing specific transaction records.
unbilledordersDecimalFalseNoThe total value of orders that have not yet been billed, used for tracking pending invoices and financial forecasting.

Return to Top

purchaseOrderBillingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique internal identifier for the record, used to reference and distinguish it from other entries within the system.
addr1StringFalseNoThe primary address line, typically used for the main part of the street address or location.
addr2StringFalseNoThe secondary address line, often used for additional address details, such as an apartment number or suite.
addr3StringFalseNoAn optional third address line, used for any extra information related to the address, such as building name or floor number.
addresseeStringFalseNoThe person or entity to whom the address is directed, often used to identify the recipient of mail or packages.
attentionStringFalseNoThe name or department to which correspondence should be directed, used to ensure it reaches the correct person or team.
cityStringFalseNoThe city associated with the address, used to specify the urban area or locality where the address is located.
countryStringFalseNoThe country associated with the address, used to specify the nation in which the address is located.
dropdownstateStringFalseNoA dropdown list of states or provinces, used for selecting the appropriate state or region for the address.
overrideBooleanFalseNoIndicates whether the default settings or values should be overridden, often used to apply custom settings to the record.
stateStringFalseNoThe state or province associated with the address, used to specify the regional division of the country for the address.

Return to Top

purchaseOrderExpenseMachine 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe account associated with the record, used to track financial transactions or customer accounts.
categoryStringFalseNoThe category associated with the record, used to classify or group items or transactions based on shared characteristics.
classStringFalseNoThe class assigned to the record, typically used to categorize or group records for reporting or management purposes.
customerStringFalseNoThe customer associated with the record, used to track transactions, orders, and account details related to the customer.
departmentStringFalseNoThe department associated with the record, used to track and allocate costs or responsibilities within the organization.
expenseitemIntegerFalseNoThe expense item associated with the record, used to track specific items or services for financial management and reporting.
grossamtDecimalFalseNoThe gross amount associated with the record, representing the total amount before any discounts, taxes, or adjustments.
isbillableBooleanFalseNoIndicates whether the record is billable, used to determine if charges associated with the record should be invoiced to the customer.
isclosedBooleanFalseNoIndicates whether the record is closed, often used to mark completed transactions or tasks that no longer require further action.
lineIntegerFalseNoThe line number associated with the record, used for tracking individual items or components within a larger transaction or document.
locationStringFalseNoThe location associated with the record, used to track where the transaction, item, or service is taking place or delivered.
memoStringFalseNoA memo or note associated with the record, often used to provide additional context or information about the transaction or item.
purchaseorderStringFalseNoThe purchase order associated with the record, used for tracking the order number and related purchase details.

Return to Top

purchaseOrderShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique internal identifier for the record, used to reference and distinguish it from other entries within the system.
addr1StringFalseNoThe primary address line, typically used for the street address or location information.
addr2StringFalseNoThe secondary address line, often used for additional address details such as apartment number or suite.
addr3StringFalseNoAn optional third address line, used for extra details like building name or floor number.
addresseeStringFalseNoThe person or entity to whom the address is directed, used to ensure the correspondence reaches the correct recipient.
attentionStringFalseNoThe specific individual or department to whom the address is directed, ensuring it reaches the intended person or team.
cityStringFalseNoThe city associated with the address, representing the urban area or locality.
countryStringFalseNoThe country where the address is located, used to specify the nation for international or national shipping and communication.
dropdownstateStringFalseNoA dropdown list field used to select the state or province associated with the address.
overrideBooleanFalseNoIndicates whether default values should be overridden, typically used to apply custom settings to the record.
stateStringFalseNoThe state or province associated with the address, typically used for regional classification within a country.

Return to Top

purchaseOrderTrackingNumberMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
trackingnumberStringFalseNoThe unique tracking number associated with the shipment, used to track the status and location of the delivery.

Return to Top

purchaserequisition 

NameTypeReadOnlyReferencesFilterOnlyDescription
approvalstatusStringFalseNoThe approval status of the record, indicating whether it has been approved, pending, or requires review.
classStringFalseNoThe class assigned to the record, used for categorizing or grouping similar records for reporting or analysis.
createddateDatetimeFalseNoThe date and time when the record was created, used to track the origin and creation timeline.
createdfromStringFalseNoThe source or origin from which the record was created, often used to link the record to a parent record or system.
currencyStringFalseNoThe type of currency used for the transaction or record (such as USD, EUR, or GBP), specifying the denomination for monetary values.
currencynameStringFalseNoThe name of the currency associated with the record, such as 'United States Dollar' or 'Euro'.
currencysymbolStringFalseNoThe symbol representing the currency, such as '$' for USD or '€' for EUR.
customformStringFalseNoThe custom form used for the record, allowing personalized layouts and fields specific to the transaction or entity.
departmentStringFalseNoThe department associated with the record, used for internal tracking and resource allocation.
duedateDateFalseNoThe date by which the record or transaction is due, marking the deadline for payments, deliveries, or other obligations.
entityStringFalseNoThe entity associated with the record (such as a customer, partner, or vendor), used to track relationships.
entity_nexus_countryStringFalseNoThe country of nexus for the entity, used to define the tax jurisdiction or region in which the entity operates.
entitynexusStringFalseNoThe nexus or jurisdiction that the entity operates in, often used for tax and regulatory purposes.
estimatedtotalDecimalFalseNoThe estimated total amount for the record, typically used for forecasting or budget tracking.
exchangerateDecimalFalseNoThe exchange rate applied to the record, used for converting between currencies.
externalidStringFalseNoA unique identifier assigned to the record by an external system, used for integration or synchronization.
fobStringFalseNoThe Free On Board (FOB) terms associated with the transaction, specifying shipping responsibilities and delivery terms.
isbasecurrencyBooleanFalseNoIndicates whether the currency used is the base currency of the organization, often used for accounting purposes.
lastmodifieddateDatetimeFalseNoThe date and time when the record was last modified, used for tracking changes or updates to the record.
linkedtrackingnumbersStringFalseNoThe tracking numbers associated with linked shipments, used to track multiple shipments in relation to the record.
locationStringFalseNoThe location associated with the record, typically used to track where goods are stored, delivered, or services provided.
memoStringFalseNoA memo or note associated with the record, often used for providing additional context or comments.
messageStringFalseNoA message associated with the record, used for communication or notifications related to the transaction or record.
messageselStringFalseNoThe selected message or template associated with the record, often used for communication or system-generated messages.
nextapproverStringFalseNoThe individual or role responsible for the next approval step in the approval workflow for the record.
nexusStringFalseNoThe nexus or tax jurisdiction associated with the record, used for determining tax obligations and regulatory compliance.
nexus_countryStringFalseNoThe country associated with the nexus, used to track tax or business jurisdiction for the record.
oldrevenuecommitmentStringFalseNoA prior revenue commitment associated with the record, used for tracking previous agreements or sales forecasts.
returntrackingnumbersStringFalseNoThe tracking numbers for returned shipments, used to track the status of returned goods or materials.
shipdateDateFalseNoThe date when the items are shipped, marking the start of the delivery process.
sourceStringFalseNoThe source from which the record originated, often used to track the origin of leads, sales, or transactions.
statusStringFalseNoThe current status of the record (such as 'pending', 'shipped', 'completed', or 'closed'), used for tracking progress.
statusRefStringFalseNoA reference to the status of the record, often used to link to another system or status for integration.
subsidiaryStringFalseNoThe subsidiary or division of the organization associated with the record, used in multi-entity tracking and reporting.
termsStringFalseNoThe payment terms associated with the transaction, such as 'Net 30', 'Due on receipt', or 'Installments'.
totalDecimalFalseNoThe total value associated with the record, often representing the sum of charges, costs, or amounts due.
trackingnumbersStringFalseNoThe tracking numbers associated with the shipment or delivery, used for tracking the status of goods or services in transit.
trandateDateFalseNoThe date when the transaction took place or was recorded, used to track the timing of financial or operational activities.
tranidStringFalseNoA unique identifier for the transaction, used for referencing and tracking the specific transaction record.
updatecurrencyStringFalseNoIndicates the currency used for updates to the record, especially when adjusting currency values in transactions.

Return to Top

purchaseRequisitionTrackingNumberMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
trackingnumberStringFalseNoThe unique tracking number associated with the shipment, used to monitor and track the delivery status of goods or services.

Return to Top

quantityPricingSchedule 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal identifier (Id) for the quantity pricing schedule. This unique Id is automatically assigned by NetSuite and is used to reference the schedule in scripts, reports, and integrations.
basediscountDoubleFalseNoThe base percentage discount applied to pricing tiers. This discount serves as a foundational reduction before any additional quantity-based adjustments are applied.
isinactiveBooleanFalseNoIndicates whether the quantity pricing schedule is inactive. When set to 'true,' the schedule is no longer available for use in pricing calculations.
nameStringFalseNoThe name assigned to the quantity pricing schedule. This name is used for reference within NetSuite when selecting or managing pricing schedules.
overallquantitypricingtypeStringFalseNoDefines how quantity-based discounts are calculated for this schedule. Possible values determine whether discounts are applied cumulatively or based on individual pricing tiers.
unitStringFalseNoThe unit of measure associated with this quantity pricing schedule. This determines how quantity breaks are measured, such as by individual items, cases, or another unit type.
unitstypeStringFalseNoThe classification of units applicable to this pricing schedule. This ensures that the correct units are used for quantity-based discount calculations.
usemarginalratesBooleanFalseNoSpecifies whether marginal rates are used when applying discounts. If enabled, discount rates are applied incrementally across pricing tiers instead of using a flat rate.

Return to Top

quantityPricingScheduleLevelEdit 

NameTypeReadOnlyReferencesFilterOnlyDescription
leveldiscountDoubleFalseNoRepresents the discount percentage applied at this specific pricing level within the quantity pricing schedule. This value determines how much of a reduction is given based on the quantity purchased.
quantitypricingscheduleStringFalseNoIndicates the associated quantity pricing schedule that defines the price break structure for different quantity ranges. This value helps in mapping pricing rules for bulk purchases.

Return to Top

quantityPricingScheduleLevelSpreadsheet 

NameTypeReadOnlyReferencesFilterOnlyDescription
leveldiscountDoubleFalseNoThe discount applied at this pricing level, represented as a decimal. A value of 0.10 indicates a 10% discount.
levelpricediscountDoubleFalseNoThe default percentage discount applied at this pricing level. This serves as a baseline discount unless overridden by specific conditions.
quantitypricingscheduleStringFalseNoThe identifier (Id) for the quantity pricing schedule, which determines price adjustments based on volume or quantity tiers.

Return to Top

Quota 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoA unique identifier (Id) assigned to each record in the quota table. Used for referencing and linking records across the system.
aclassStringFalseNoThe classification category associated with this quota record. Helps in segmenting financial and operational data for reporting and analysis.
asaBooleanFalseNoIndicates whether the quota is designated for alternative sales tracking. Used to differentiate between standard and alternate sales figures.
date [KEY]DateFalseNoThe date associated with the quota entry. Represents the effective date of the assigned sales target.
departmentStringFalseNoThe department linked to the quota. Helps in tracking and managing quotas across different business units.
entityStringFalseNoThe sales representative assigned to this quota. This value corresponds to an employee record in NetSuite.
idIntegerFalseNoA secondary internal Id, potentially used for duplicate or alternative referencing of records.
ismanagerBooleanFalseNoIndicates whether this quota applies at a managerial level. Used to track team-wide sales targets.
itemStringFalseNoThe specific product or service associated with this quota. Helps in tracking sales goals at the item level.
locationStringFalseNoThe geographical or business location assigned to this quota. Essential for regional sales tracking and performance evaluation.
mamountDecimalFalseNoThe monthly sales target amount associated with this quota. Provides a breakdown of sales goals over shorter periods.
mamountquarterlyDecimalFalseNoThe quarterly sales target amount. Used for performance assessment over a three-month period.
savedsearchStringFalseNoThe Id of a saved search used to generate or validate this quota entry. Facilitates dynamic reporting and goal tracking.
subsidiaryStringFalseNoThe subsidiary company that this quota applies to. Helps in managing multi-entity financial operations.
targetonStringFalseNoSpecifies the metric or parameter that the quota is based on, such as revenue, profit, or units sold.
totalDecimalFalseNoThe total sales target amount associated with this quota, aggregating all relevant factors. Used for performance evaluation and goal tracking.

Return to Top

reallocateitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
externalidStringFalseNoA unique identifier (Id) assigned to each record, often used for integration purposes or referencing records across different systems.
itemStringFalseNoThe specific inventory item being reallocated, identified by its unique item name or number.
locationStringFalseNoThe physical or logical location from which the item is being reallocated, such as a warehouse or store.
quantitycommittedDoubleFalseNoThe total number of units that have been committed for existing sales orders or other reservations but have not yet been shipped.
quantityonhandDoubleFalseNoThe current total number of units available in inventory at the specified location, accounting for all stock that has not been allocated to orders.
quantitypickedDoubleFalseNoThe total number of units that have been selected and removed from inventory for fulfillment but have not yet been shipped.
quantityrequiredDoubleFalseNoThe total number of units needed to fulfill demand, such as open orders or manufacturing requirements.
unitsStringFalseNoThe unit of measurement associated with the item, such as pieces, boxes, or kilograms, ensuring consistency in inventory tracking.

Return to Top

receiveinboundshipment 

NameTypeReadOnlyReferencesFilterOnlyDescription
inboundshipmentnumberStringFalseNoThe unique identifier (Id) assigned to an inbound shipment. This number is used to track and reference the shipment throughout the receiving process.
incotermStringFalseNoThe International Commercial Terms (Incoterms) associated with the shipment, defining the responsibilities of the buyer and seller regarding shipping, insurance, and duties.
postingperiodStringFalseNoThe financial reporting period in which the inbound shipment is recorded, ensuring accurate accounting and reconciliation of transactions.
receivinglocationStringFalseNoThe specific location or warehouse where the inbound shipment is received and processed for inventory management.
trandateDateFalseNoThe transaction date when the inbound shipment is recorded in the system, reflecting when the goods were received.
vendorStringFalseNoThe supplier or vendor from whom the inbound shipment originates, used for tracking purchase orders and supplier relationships.

Return to Top

RecentRecord 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoA unique identifier (Id) assigned to each record in NetSuite. This Id is automatically generated and used as the primary key for referencing records within the system.
isreportBooleanFalseNoIndicates whether the record is associated with a report. A value of 'true' means the record is part of a reporting structure, while 'false' signifies that it is a standard data entry.

Return to Top

redeemedAtTransaction 

NameTypeReadOnlyReferencesFilterOnlyDescription
snumberStringFalseNoThe unique identifier (Id) assigned to the gift certificate, used for tracking and validation purposes within the NetSuite system.

Return to Top

reforecastMethod 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier (Id) for each record in the reforecast method table. This key is used to reference and differentiate specific entries within the dataset, ensuring data integrity and enabling efficient lookups.

Return to Top

reportingSection 

NameTypeReadOnlyReferencesFilterOnlyDescription
nameStringFalseNoThe name or label of the reporting section, typically used to categorize or identify specific parts of a report in NetSuite. This value helps users distinguish different sections when generating or viewing reports.

Return to Top

requestForQuoteItemItemPricing 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoUnique identifier (Id) assigned internally to each record for tracking and reference purposes. This value is system-generated and cannot be modified.
calculatequantitydiscountsStringFalseNoIndicates whether quantity discounts should be applied when calculating item pricing. If enabled, discounts are determined based on the quantity tiers set in the system.
externalidStringFalseNoUnique Id assigned externally for integration with third-party systems. This Id allows for seamless synchronization between NetSuite and external applications.
inputusingStringFalseNoSpecifies the method used to input data for the item pricing request. This field determines how pricing information is processed and validated.
lineidIntegerFalseNoRepresents the unique Id for each line item in the request. Each line corresponds to a specific item pricing entry within the transaction.
transactionidIntegerFalseNoStores the internal Id for the associated transaction. This Id links the item pricing request to the corresponding purchase or sales transaction.
vendorIntegerFalseNoIdentifies the vendor associated with the pricing request. This value references the vendor's internal Id within NetSuite, ensuring accurate supplier tracking.

Return to Top

requestForQuoteItemItemPricingDiscount 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique identifier (Id) for the discount record associated with an item pricing entry in a request for quote.
fromquantityDoubleFalseNoMinimum quantity of items that must be ordered for this pricing discount to apply.
itempricingIntegerFalseNoReference to the associated item pricing entry within the request for quote.
itempricingrecordStringFalseNoIdentifier or record key for the item pricing entry, linking it to the NetSuite database.
memoStringFalseNoOptional note or description related to this specific discount entry for internal reference.
percentDoubleFalseNoDiscount percentage applied when the specified quantity threshold is met.
quantityorderedDoubleFalseNoThe number of items ordered, used to determine eligibility for the discount.

Return to Top

resourceallocation 

NameTypeReadOnlyReferencesFilterOnlyDescription
allocationamountStringFalseNoThe total monetary value allocated to a specific resource for a project or task.
allocationresourceStringFalseNoThe name or unique identifier (Id) of the resource, such as an employee or contractor, assigned to the allocation.
allocationtypeStringFalseNoThe type of allocation, specifying whether it is a hard allocation (guaranteed) or a soft allocation (tentative).
allocationunitStringFalseNoThe unit of measurement used for the allocation, such as hours, days, or percentage of total project time.
customformStringFalseNoThe Id of the custom form used for recording this allocation, allowing for customized data entry and display.
enddateDateFalseNoThe date when the allocation for the specified resource is scheduled to end.
externalidStringFalseNoA unique Id assigned externally to this allocation, typically used for data integration or reference from external systems.
notesStringFalseNoAdditional details or comments related to this resource allocation, often used for internal documentation or communication.
numberhoursStringFalseNoThe total number of hours allocated to the resource for the specified project or task.
percentoftimeStringFalseNoThe percentage of the resource's total available time that is allocated to the specified project or task.
projectStringFalseNoThe name or unique Id of the project to which the resource is allocated.
requestorStringFalseNoThe person or entity who requested the allocation of this resource, often a project manager or department head.
startdateDateFalseNoThe date when the resource allocation begins, marking the start of the assigned work period.

Return to Top

resourceAllocationType 

NameTypeReadOnlyReferencesFilterOnlyDescription
idIntegerFalseNoA unique identifier (Id) for the resource allocation type. This value is assigned by the system and used to reference the specific allocation type in NetSuite. It is essential for maintaining referential integrity across related records and transactions.

Return to Top

resourceGroup 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique internal identifier (Id) automatically assigned to each resource group. This ID is used for referencing records within the NetSuite system.
descriptionStringFalseNoA descriptive label for the resource group, typically providing a meaningful name that distinguishes it from others.
externalidStringFalseNoAn optional user-defined Id that can be used to reference the resource group externally, often for integrations or data synchronization with external systems.
isinactiveBooleanFalseNoIndicates whether the resource group is currently active within the system. A value of 'true' means the resource group is inactive and unavailable for use.

Return to Top

resourceGroupMembers 

NameTypeReadOnlyReferencesFilterOnlyDescription
groupStringFalseNoRepresents the identifier (Id) of the resource group to which a member belongs. This value is essential for defining associations between different entities in the system and ensuring correct role-based access or categorization.

Return to Top

restlet 

NameTypeReadOnlyReferencesFilterOnlyDescription
deletefunctionStringFalseNoIndicates the function executed when a RESTlet handles a DELETE request. Typically, this function is responsible for deleting a record or resource.
descriptionStringFalseNoA brief but informative description of the RESTlet, detailing its purpose and functionality within NetSuite.
externalidStringFalseNoA unique identifier (Id) that can be used for external integrations to reference the RESTlet or its associated records.
getfunctionStringFalseNoSpecifies the function executed when the RESTlet handles a GET request. This function is typically used to retrieve data from NetSuite.
isinactiveBooleanFalseNoIndicates whether the RESTlet is currently inactive. If set to 'true,' the RESTlet is disabled and cannot be executed.
nameStringFalseNoThe assigned name of the RESTlet, used for identification and reference within NetSuite.
notifyadminsBooleanFalseNoDetermines if NetSuite administrators should receive notifications regarding RESTlet execution or errors.
notifyemailsStringFalseNoA comma-separated list of email addresses that will receive notifications related to this RESTlet’s execution or failures. Each email address is separated by a comma and a space.
notifygroupStringFalseNoSpecifies a NetSuite group that will receive notifications regarding the execution or errors of this RESTlet.
notifyownerBooleanFalseNoIndicates whether the owner of the RESTlet should receive notifications about execution status or errors.
notifyuserBooleanFalseNoDetermines if the user executing the RESTlet should receive notifications regarding its execution or potential issues.
ownerStringFalseNoThe NetSuite user or role designated as the owner of this RESTlet. This user typically has control over its configuration and execution.
postfunctionStringFalseNoDefines the function executed when the RESTlet handles a POST request. This function is commonly used for creating records or processing submitted data.
putfunctionStringFalseNoSpecifies the function executed when the RESTlet handles a PUT request, which is typically used for updating existing records in NetSuite.
scriptfileStringFalseNoThe script file associated with the RESTlet, containing the SuiteScript code that defines its behavior and functions.
scriptidStringFalseNoA unique Id assigned to the RESTlet script within NetSuite, used for internal reference.
scripttypeStringFalseNoDefines the type of script associated with the RESTlet, typically indicating it as a SuiteScript RESTlet.

Return to Top

returnauthorization 

NameTypeReadOnlyReferencesFilterOnlyDescription
altsalestotalDecimalFalseNoRepresents the alternative sales total, which includes any adjustments, discounts, or promotions applied to the sales amount. This value is calculated separately from the standard sales total.
billaddressStringFalseNoThe complete billing address associated with the return authorization, including street address, city, state, postal code, and country.
billaddresslistStringFalseNoA reference to the list of available billing addresses for the customer, allowing selection of a predefined address stored in the system.
billingaddressStringFalseNoThe formatted billing address associated with the transaction, used for invoicing and payment processing purposes.
billisresidentialStringFalseNoIndicates whether the billing address is a residential address as opposed to a commercial address. This can affect shipping and tax calculations.
classStringFalseNoThe classification category assigned to this return authorization, which can be used for financial reporting and segmentation.
couponcodeStringFalseNoThe promotional or discount code applied to this return authorization, affecting the total amount and applicable discounts.
createddateDatetimeFalseNoThe date and time when this return authorization was initially created in the system.
createdfromStringFalseNoA reference to the original sales transaction from which this return authorization was generated, typically linking to an invoice or sales order.
currencyStringFalseNoThe currency in which this transaction is recorded, determined based on the company or customer currency settings.
currencynameStringFalseNoThe full name of the currency used in this transaction, such as 'US Dollar' or 'Euro'.
currencysymbolStringFalseNoThe currency symbol representing the transaction currency, such as '$' for USD or '€' for EUR.
customformStringFalseNoThe custom form template used for this return authorization, determining the layout and fields available on the user interface.
deferredrevenueDecimalFalseNoThe portion of revenue that has been invoiced but not yet recognized, typically used in revenue recognition processes.
departmentStringFalseNoThe department associated with this return authorization, used for financial tracking and reporting.
discountitemStringFalseNoThe discount item applied to the transaction, which affects the total amount by reducing the sales value.
discountrateStringFalseNoThe rate or percentage of discount applied to the transaction, affecting the total sales amount.
discounttotalDecimalFalseNoThe total discount amount applied to this return authorization, reducing the overall transaction value.
draccountStringFalseNoThe debit account used for accounting transactions related to this return authorization.
emailStringFalseNoThe email address associated with the customer or entity for communication and notifications.
entityStringFalseNoThe customer or business entity related to this return authorization, typically representing the buyer.
entitynexusStringFalseNoThe tax jurisdiction or nexus associated with the entity, determining applicable tax rates and compliance requirements.
entitytaxregnumStringFalseNoThe tax registration number associated with the entity, used for tax reporting and compliance.
estgrossprofitDecimalFalseNoThe estimated gross profit for this return authorization, calculated as the difference between revenue and cost.
estgrossprofitpercentStringFalseNoThe estimated gross profit percentage for the transaction, calculated as the estimated gross profit divided by total revenue.
exchangerateDecimalFalseNoThe exchange rate applied to the transaction if the currency differs from the company’s base currency.
excludecommissionBooleanFalseNoIndicates whether this transaction should be excluded from commission calculations for sales representatives.
externalidStringFalseNoA unique identifier (Id) assigned externally to this transaction, often used for integrations and third-party system references.
fxaccountStringFalseNoThe foreign exchange account used for handling currency conversions and transactions in different currencies.
inputpnrefnumStringFalseNoThe reference number provided by the payment processor for a payment or authorization related to this return.
intercostatusStringFalseNoThe status of the intercompany transaction associated with this return authorization, used for internal accounting.
intercotransactionStringFalseNoA reference to the related intercompany transaction, linking financial records across subsidiaries or entities.
isbasecurrencyBooleanFalseNoIndicates whether the transaction is recorded in the company's base currency. If 'true,' amounts are shown in the base currency; otherwise, they are in the transaction currency.
istaxableBooleanFalseNoSpecifies whether the return authorization is subject to sales tax. If 'true,' the transaction is taxable based on applicable tax rules.
lastmodifieddateDatetimeFalseNoThe timestamp of the most recent modification to the return authorization record, reflecting changes made by users or system processes.
leadsourceStringFalseNoThe originating source of the return authorization, identifying the campaign, advertisement, or other marketing effort that led to the transaction.
locationStringFalseNoThe physical or virtual location associated with this return authorization, typically representing a warehouse, store, or distribution center.
memoStringFalseNoA free-text field for internal notes or comments regarding the return authorization, useful for tracking additional details or special instructions.
messageStringFalseNoA customer-facing message included on the return authorization, often providing return instructions or other relevant details.
messageselStringFalseNoA predefined message template selected for this return authorization, allowing standardized communication with customers.
muccpromocodeinstanceStringFalseNoA unique Id for a multi-use coupon code instance applied to this return authorization, used for tracking promotional discounts.
nexusStringFalseNoThe tax jurisdiction applicable to this return authorization, determining how sales tax is calculated based on the business's registered tax locations.
orderstatusStringFalseNoThe current status of the return authorization in the order workflow, such as pending approval, approved, or closed.
otherrefnumStringFalseNoAn optional reference number provided by the customer or external system to track the return authorization against external records.
partnerStringFalseNoThe business partner or affiliate associated with this return authorization, typically used in partner sales or referral transactions.
promocodeStringFalseNoThe promotional code applied to this return authorization, representing a discount or special offer that modifies the return transaction.
promocodepluginimplStringFalseNoThe implementation reference for a custom promo code plugin that modifies pricing, discounts, or promotions for this return authorization.
recognizedrevenueDecimalFalseNoThe amount of revenue that has been recognized from this return authorization based on the organization's revenue recognition rules.
returntrackingnumbersStringFalseNoA list of tracking numbers associated with the return shipment, enabling tracking of returned goods through shipping carriers.
revcommitstatusStringFalseNoThe revenue commitment status for this return authorization, indicating whether revenue has been committed or deferred based on accounting rules.
revenuestatusStringFalseNoThe overall revenue recognition status of this return authorization, such as recognized, deferred, or in progress, based on financial reporting policies.
revreconrevcommitmentBooleanFalseNoIndicates whether revenue reconciliation is required for committed revenue in this transaction.
saleseffectivedateDateFalseNoThe date when the sales transaction associated with this return authorization became effective.
salesgroupStringFalseNoThe designated sales group responsible for overseeing this return authorization, typically assigned based on sales territories or business rules.
salesrepStringFalseNoThe sales representative handling this return authorization, responsible for customer communication and transaction management.
shipaddressStringFalseNoThe full shipping address associated with this return authorization, including street address, city, state, postal code, and country.
shipaddresslistStringFalseNoA reference to the available predefined shipping addresses stored in the system, allowing selection from saved customer addresses.
shipisresidentialStringFalseNoIndicates whether the shipping address is classified as a residential location, which can impact shipping rates and carrier selection.
shipoverrideStringFalseNoSpecifies whether standard shipping methods or preferences have been manually adjusted for this return authorization.
shippingaddressStringFalseNoThe fully formatted shipping address used for logistics, fulfillment, and invoice documentation.
sourceStringFalseNoThe originating system or process that created this return authorization, which can be an external integration, web order, or internal entry.
statusStringFalseNoThe current processing status of this return authorization, indicating whether it is pending, approved, rejected, or completed.
statusrefStringFalseNoAn internal reference code representing the status of this return authorization, used for system tracking and reporting.
subsidiaryStringFalseNoThe specific business entity or subsidiary associated with this return authorization, helping in financial reporting and operational segmentation.
subsidiarytaxregnumStringFalseNoThe tax registration number assigned to the subsidiary, required for tax compliance and jurisdictional reporting.
subtotalDecimalFalseNoThe calculated total value of the items in this return authorization before applying taxes, shipping charges, or discounts.
syncpartnerteamsBooleanFalseNoIndicates whether partner team data should be synchronized across related transactions for consistency and collaboration.
syncsalesteamsBooleanFalseNoIndicates whether the assigned sales teams should be updated and synchronized across related records for accurate reporting.
taxdetailsoverrideBooleanFalseNoSpecifies whether tax details, such as rates and calculations, have been manually adjusted instead of system-determined values.
taxitemStringFalseNoThe specific tax item applied to this transaction, determining applicable tax rates based on jurisdiction and tax rules.
taxpointdateDateFalseNoThe official tax recognition date for this return authorization, which dictates when the tax liability is recorded.
taxpointdateoverrideBooleanFalseNoIndicates whether the standard tax point date has been manually modified to align with specific business or regulatory requirements.
taxrateDoubleFalseNoThe percentage rate of tax applied to this return authorization, used to compute the total tax amount.
taxregoverrideBooleanFalseNoIndicates whether the tax registration details have been manually modified instead of using system-generated values.
taxtotalDecimalFalseNoThe total calculated tax amount applied to this return authorization, based on tax rates and jurisdictional rules.
tobeemailedBooleanFalseNoIndicates whether this return authorization should be automatically sent to the customer via email upon processing.
tobefaxedBooleanFalseNoIndicates whether this return authorization should be transmitted to the customer via fax upon processing.
tobeprintedBooleanFalseNoIndicates whether this return authorization should be printed for physical documentation or record-keeping.
totalDecimalFalseNoThe final amount for this return authorization, including item values, taxes, shipping fees, and any applicable discounts.
totalcostestimateDecimalFalseNoThe estimated total cost associated with this return authorization, often used for financial forecasting and profitability analysis.
trandateDateFalseNoThe official date when this return authorization was recorded in the system, often used for reporting and auditing.
tranidStringFalseNoThe unique transaction Id assigned to this return authorization, ensuring traceability and reference in financial records.
tranisvsoebundleBooleanFalseNoIndicates whether this return authorization is linked to a Vendor-Specific Objective Evidence (VSOE) bundle for revenue recognition compliance.
vsoeautocalcBooleanFalseNoIndicates whether the system automatically applies VSOE calculations to determine the revenue recognition treatment for this return authorization.

Return to Top

returnAuthorizationBillingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique identifier (Id) for the billing address record, used internally for reference and linking to other tables.
addr1StringFalseNoThe primary street address or building number for the billing location. This is the first line of the address.
addr2StringFalseNoThe secondary street address or suite/apartment number for the billing location. This field is optional and used for additional address details.
addr3StringFalseNoAn additional address field for extended location details, often used for international addresses or complex locations.
addresseeStringFalseNoThe full name or company name associated with the billing address. This is the recipient of any billing-related correspondence.
attentionStringFalseNoA specific person or department within the addressee organization to whom billing correspondence should be directed.
cityStringFalseNoThe city where the billing address is located. This field is used for location identification and mailing purposes.
countryStringFalseNoThe country where the billing address is located. This value should be in a standardized format, such as an ISO country code.
dropdownstateStringFalseNoThe state or province of the billing address, typically selected from a predefined dropdown list to ensure accuracy and consistency.
overrideBooleanFalseNoIndicates whether the standard address validation or default address settings have been manually overridden. A value of 'true' means the address has been modified.
stateStringFalseNoThe state or province of the billing address, manually entered if not using a dropdown selection, used for regional identification and tax calculations.

Return to Top

returnAuthorizationPartner 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage of contribution attributed to the partner in relation to the return authorization. This value helps determine the level of involvement or revenue share for the specified partner.
isprimaryBooleanFalseNoIndicates whether this partner is the primary contributor to the return authorization. A value of 'true' means this is the main partner, while 'false' signifies an additional partner.
partnerStringFalseNoThe unique identifier (Id) or name of the partner associated with the return authorization. This field links the return to a specific partner entity within NetSuite.
partnerroleStringFalseNoThe designated role of the partner in the return authorization process, such as distributor, reseller, or consultant. This helps in defining the responsibilities of the partner in relation to the return.

Return to Top

returnAuthorizationSalesTeam 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage of the total sales revenue that is attributed to this sales team member's contribution for the return authorization.
employeeStringFalseNoThe name or identifier (Id) of the employee associated with this sales team entry for the return authorization.
isprimaryBooleanFalseNoIndicates whether this sales team member is the primary representative for the return authorization. A value of 'true' means this is the main assigned sales representative.
salesroleStringFalseNoThe specific role assigned to the sales team member within the return authorization process, such as 'Manager' or 'Representative'.

Return to Top

returnAuthorizationShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoUnique identifier (Id) for the shipping address record, used internally by NetSuite.
addr1StringFalseNoThe primary street address or first line of the shipping address. Typically includes street number and name.
addr2StringFalseNoAn optional second line for the shipping address, often used for apartment, suite, or unit numbers.
addr3StringFalseNoAn additional line for extended address details, such as floor or building information.
addresseeStringFalseNoThe name of the recipient or business associated with this shipping address, used for delivery purposes.
attentionStringFalseNoThe specific person or department that should receive the shipment at the given address. Helps direct packages correctly.
cityStringFalseNoThe city where the shipment is to be delivered. Part of the standard mailing address.
countryStringFalseNoThe country where the shipping address is located. Typically represented by its full name.
dropdownstateStringFalseNoThe state or province in a format selectable from a predefined list. Ensures consistency in address entry.
overrideBooleanFalseNoIndicates whether the default shipping address has been manually overridden. A value of 'true' means the override is active.
stateStringFalseNoThe state or province of the shipping address, entered as free text. May differ from dropdown-selected state.

Return to Top

returnAuthorizationTranPromotion 

NameTypeReadOnlyReferencesFilterOnlyDescription
couponcodeStringFalseNoThe unique identifier (Id) for the coupon applied to the transaction. This code is typically provided to customers as part of a promotion and is used to apply discounts or special offers.
promocodeStringFalseNoThe specific promotion code associated with the transaction. This code is used to track promotional campaigns and apply relevant discounts or benefits to eligible orders.
promotiontypeStringFalseNoIndicates the type of promotion applied, such as percentage discount, fixed amount discount, free shipping, or buy-one-get-one offers. This helps in categorizing and analyzing promotional effectiveness.

Return to Top

RevenueArrangement 

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerFalseNoA unique identifier (Id) for the revenue arrangement. This serves as the primary key for distinguishing records.
accountingbookStringFalseNoThe accounting book associated with this revenue arrangement, defining the financial reporting rules applied.
classStringFalseNoThe classification category used for financial segmentation, such as cost center or business unit.
compliantBooleanFalseNoIndicates whether the revenue arrangement complies with relevant financial regulations and policies.
contrevhandlingtriggeredBooleanFalseNoSpecifies if contingent revenue handling has been triggered, affecting revenue recognition based on specific conditions.
departmentStringFalseNoThe department responsible for the revenue arrangement, typically used for cost allocation and financial tracking.
locationStringFalseNoThe physical or operational location associated with the revenue arrangement, useful for regional reporting and compliance.
memoStringFalseNoA free-text field allowing additional notes or explanations related to the revenue arrangement.
subsidiaryStringFalseNoThe subsidiary entity within the organization that the revenue arrangement is linked to, aiding in consolidated financial reporting.
totalallocationamountDecimalFalseNoThe total amount allocated across revenue elements, ensuring correct revenue distribution in compliance with accounting standards.
totalrevenueamountDecimalFalseNoThe total recognized revenue for the arrangement, used for financial statements and performance tracking.
totalsellingamountDecimalFalseNoThe total sales amount before any revenue allocation or recognition adjustments, representing the initial transaction value.
trandateDateFalseNoThe transaction date associated with the revenue arrangement, determining the period in which revenue is recognized.
tranisvsoebundleBooleanFalseNoIndicates if the transaction is part of a Vendor-Specific Objective Evidence (VSOE) bundle, affecting revenue recognition rules.
transactionnumberStringFalseNoA unique Id for the transaction linked to this revenue arrangement, used for tracking and reconciliation purposes.

Return to Top

revenuecommitment 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with this revenue commitment, which determines the set of financial reporting rules applied.
billaddressStringFalseNoThe full billing address used for invoicing the customer, including street, city, state, and postal code.
billaddresslistStringFalseNoA reference to the predefined list of billing addresses available for the customer making this transaction.
billingaddressStringFalseNoThe structured billing address for the transaction, stored separately from the shipping address.
billisresidentialStringFalseNoIndicates whether the billing address is classified as a residential location, which can impact taxation and shipping fees.
classStringFalseNoA classification or categorization of the revenue commitment, often used for reporting or segmentation.
couponcodeStringFalseNoThe promotional or discount code applied to the transaction, reducing the total payable amount based on predefined rules.
createddateDatetimeFalseNoThe exact date and time when this revenue commitment record was created in the system.
createdfromStringFalseNoA reference to the original transaction or document from which this revenue commitment was generated.
currencyStringFalseNoThe currency in which the transaction is denominated, affecting exchange rate calculations and reporting.
currencynameStringFalseNoThe full name of the currency used in the transaction, such as 'US Dollar' or 'Euro'.
currencysymbolStringFalseNoThe symbol representing the currency of the transaction, such as '$' for USD or '€' for Euro.
customformStringFalseNoThe specific custom form layout assigned to this revenue commitment for data entry and display purposes.
deferredrevenueDecimalFalseNoThe amount of revenue that has been deferred and recognized over time, typically related to subscription or service-based income.
departmentStringFalseNoThe department within the organization associated with this revenue commitment, used for financial reporting and tracking.
discountamountDecimalFalseNoThe total monetary value of discounts applied to the transaction, reducing the overall revenue commitment amount.
discountdateDateFalseNoThe date by which the discount must be applied in order to be valid. Often linked to early payment discounts.
discountitemStringFalseNoThe specific item or service associated with the applied discount, used for tracking and reporting purposes.
discountrateStringFalseNoThe percentage or fixed amount by which the total transaction value is reduced as part of a discount.
discounttotalDecimalFalseNoThe cumulative value of all discounts applied to this transaction, impacting the final payable amount.
enddateDateFalseNoThe end date associated with the revenue commitment, often representing the conclusion of a contract or service period.
entityStringFalseNoThe customer, vendor, or other business entity linked to this revenue commitment.
entitynexusStringFalseNoThe tax nexus or jurisdiction associated with the entity, which determines applicable tax regulations.
exchangerateDecimalFalseNoThe exchange rate used to convert the transaction currency into the base currency for accounting and reporting.
externalidStringFalseNoA unique identifier (Id) for this revenue commitment used in external systems for integration or reference purposes.
fobStringFalseNoThe Free On Board (FOB) terms of the transaction, which specify when ownership and responsibility of goods transfer.
isbasecurrencyBooleanFalseNoIndicates whether the transaction is recorded in the company's base currency 'true' or a foreign currency 'false'.
jobStringFalseNoThe project or job linked to this revenue commitment, allowing revenue tracking for specific work or contracts.
lastmodifieddateDatetimeFalseNoThe date and time when this revenue commitment record was last updated, used for audit tracking and version control.
linkedtrackingnumbersStringFalseNoTracking numbers associated with the revenue commitment, linking shipments or returns for reference.
locationStringFalseNoThe physical or virtual location where the transaction is recorded or processed. Can be a warehouse, store, or region.
memoStringFalseNoA text field allowing users to enter additional information or notes related to the revenue commitment for internal reference.
muccpromocodeinstanceStringFalseNothe unique Id for a promotion code instance, linking the revenue commitment to a specific applied discount or offer.
nexusStringFalseNoThe tax jurisdiction associated with this transaction, determining applicable tax rates based on company and customer location.
opportunityStringFalseNoReference to a sales opportunity tied to this revenue commitment, indicating a prior lead or potential sale that materialized.
otherrefnumStringFalseNoAn alternate reference number provided by the user or external system for tracking purposes, such as an order number.
partnerStringFalseNoThe business partner, reseller, or affiliate associated with this revenue commitment, playing a role in the transaction.
postingperiodStringFalseNoThe financial period in which this revenue commitment is recorded, used for accounting and reporting purposes.
promocodeStringFalseNoThe promotional code applied to the transaction, potentially affecting pricing, discounts, or special offers.
promocodepluginimplStringFalseNoThe system implementation or logic governing the behavior of promotional codes applied to this revenue commitment.
recognizedrevenueDecimalFalseNoThe portion of revenue from this transaction that has been recognized in the accounting period per revenue recognition rules.
returntrackingnumbersStringFalseNoTracking numbers associated with returned items linked to this revenue commitment, used for logistics and auditing.
revenuestatusStringFalseNoThe current status of the revenue commitment, such as pending, recognized, or deferred, indicating its financial state.
salesgroupStringFalseNoThe sales team or department responsible for this transaction, used for performance tracking and commission calculations.
salesrepStringFalseNoThe specific sales representative credited with this transaction, affecting sales reporting and potential commissions.
shipaddressStringFalseNoThe shipping address provided for this transaction, indicating where goods or services should be delivered.
shipaddresslistStringFalseNoA list of available shipping addresses linked to the customer or transaction, providing selectable shipping options.
shipisresidentialStringFalseNoIndicates whether the shipping address is a residential location, which can impact shipping costs and carrier selection.
shipoverrideStringFalseNoSpecifies whether the default shipping method or address has been manually overridden for this transaction.
shippingaddressStringFalseNoThe final confirmed shipping address for the transaction, used for logistics and delivery tracking.
sourceStringFalseNoThe origin or channel of this transaction, such as web store, direct sales, or marketplace, for tracking and reporting.
startdateDateFalseNoThe date when the revenue commitment becomes effective, often relevant for revenue recognition and contract terms.
subsidiaryStringFalseNoThe specific business entity or subsidiary under which this transaction is recorded, important for multi-entity companies.
subtotalDecimalFalseNoThe total amount for this transaction before taxes, shipping, and additional fees are applied.
syncpartnerteamsBooleanFalseNoIndicates whether the partner teams involved in this transaction should be synchronized across related records and systems.
syncsalesteamsBooleanFalseNoIndicates whether the sales teams related to this transaction should be synchronized across various records and reports.
totalDecimalFalseNoThe final total amount for the transaction, including taxes, shipping, and any applicable discounts.
trackingnumbersStringFalseNoTracking numbers assigned to the shipment for monitoring delivery status and ensuring fulfillment accuracy.
trandateDateFalseNoThe official transaction date recorded in the system, used for accounting, reporting, and reconciliation.
tranidStringFalseNoA unique Id for the revenue commitment transaction, essential for record-keeping and cross-referencing.
tranisvsoebundleBooleanFalseNoIndicates whether this transaction is part of a Vendor-Specific Objective Evidence (VSOE) bundle, impacting revenue recognition.
vsoeautocalcBooleanFalseNoSpecifies whether the system automatically calculates VSOE allocation for revenue recognition compliance.

Return to Top

revenueCommitmentBillingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoThe Unique identifier (Id) for the billing address record in the revenue commitment, used for internal reference and system operations.
addr1StringFalseNoPrimary street address or location details for the billing address associated with the revenue commitment.
addr2StringFalseNoAdditional address details, such as apartment, suite, or unit number, to further specify the billing location.
addr3StringFalseNoFurther address information, often used for extended location details in international addresses or multi-line formats.
addresseeStringFalseNoFull name or entity associated with this billing address, typically representing the recipient of invoices or official communications.
attentionStringFalseNoSpecific individual or department within the organization that should receive invoices or correspondence related to the revenue commitment.
cityStringFalseNoCity or locality of the billing address, used for invoice processing and tax calculation.
countryStringFalseNoCountry associated with the billing address, often influencing currency, tax regulations, and shipping policies.
dropdownstateStringFalseNoState or region selection for the billing address, often used in dropdown menus for user-friendly data entry.
overrideBooleanFalseNoIndicates whether the billing address details have been manually overridden, bypassing default or system-generated values.
stateStringFalseNoState or province of the billing address, relevant for regional tax calculations, compliance, and location-specific policies.

Return to Top

revenueCommitmentPartner 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage of the total revenue commitment attributed to this partner. This value represents the partner's share in the revenue commitment process.
isprimaryBooleanFalseNoIndicates whether this partner is the primary partner for the revenue commitment. A value of 'true' means this partner holds the main responsibility, while 'false' signifies a secondary role.
partnerStringFalseNoThe identifier (Id) or name of the partner associated with this revenue commitment. This could be an internal reference or an external entity name.
partnerroleStringFalseNoThe specific role that the partner plays in the revenue commitment process, such as distributor, reseller, or consultant. This helps classify the nature of the partner's involvement.

Return to Top

revenuecommitmentreversal 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe accounting book associated with this revenue commitment reversal, specifying the set of financial reporting rules applied.
billaddressStringFalseNoThe full billing address where invoices and financial documents are sent for this transaction.
billaddresslistStringFalseNoA reference to a predefined list of billing addresses linked to the customer for selection.
billingaddressStringFalseNoThe formatted billing address used for financial records and invoice generation.
billisresidentialStringFalseNoIndicates whether the billing address is classified as a residential location for tax and shipping purposes.
classStringFalseNoA classification or category assigned to this transaction, often used for financial segmentation and reporting.
couponcodeStringFalseNoThe promotional or discount code applied to this transaction, if applicable.
createddateDatetimeFalseNoThe timestamp when this revenue commitment reversal record was initially created in the system.
createdfromStringFalseNoA reference to the original transaction from which this revenue commitment reversal was derived.
currencyStringFalseNoThe three-letter ISO currency code representing the currency in which this transaction is recorded.
currencynameStringFalseNoThe full name of the currency associated with this transaction, such as US Dollar or Euro.
currencysymbolStringFalseNoThe currency symbol used to denote the monetary values in this transaction, such as $, €, or £.
customformStringFalseNoThe custom form template used to generate this transaction, specifying layout and field configurations.
deferredrevenueDecimalFalseNoThe amount of revenue that has been deferred and is yet to be recognized as income based on revenue recognition rules.
departmentStringFalseNoThe department associated with this transaction, typically used for financial tracking and organizational reporting.
discountamountDecimalFalseNoThe total discount amount applied to this transaction, reducing the overall cost.
discountdateDateFalseNoThe date by which a discount must be applied or is valid, often linked to early payment terms.
discountitemStringFalseNoThe specific discount item or category associated with the applied discount on this transaction.
discountrateStringFalseNoThe rate of discount applied, usually represented as a percentage or a fixed value.
discounttotalDecimalFalseNoThe total amount of all discounts applied to this transaction, aggregated for reporting.
entityStringFalseNoThe customer, vendor, or other entity associated with this revenue commitment reversal.
entitynexusStringFalseNoThe tax nexus associated with the entity, used for determining applicable sales tax jurisdictions.
exchangerateDecimalFalseNoThe exchange rate applied if this transaction involves currency conversion from one currency to another.
externalidStringFalseNoA unique external identifier (Id) assigned to this transaction, often used for integration with external systems.
fobStringFalseNoThe Free on Board (FOB) designation specifying when the ownership of goods is transferred during shipping.
isbasecurrencyBooleanFalseNoIndicates whether the currency of this transaction matches the base currency of the accounting system.
lastmodifieddateDatetimeFalseNoThe timestamp of the most recent modification made to this transaction record.
linkedtrackingnumbersStringFalseNoA list of tracking numbers associated with shipments linked to this transaction, separated by commas with spaces.
locationStringFalseNoThe physical or operational location associated with this transaction, often used for inventory or financial reporting.
memoStringFalseNoA free-text field where users can enter additional notes or details related to the transaction. Commonly used for internal reference or documentation.
muccpromocodeinstanceStringFalseNoThe unique Id for the specific instance of a multi-use coupon code applied to the transaction. Helps track promotions used.
nexusStringFalseNoRepresents the tax jurisdiction that applies to this transaction based on company operations and customer location. Used for tax calculation.
otherrefnumStringFalseNoAn optional reference number, often used for tracking external document numbers such as purchase orders or third-party invoices.
partnerStringFalseNoThe associated partner entity, typically representing a business partner or affiliate that contributed to the transaction.
postingperiodStringFalseNoIndicates the financial period in which this transaction is recorded. Helps determine when revenue and expenses are recognized in accounting.
promocodeStringFalseNoA discount or promotional code applied to the transaction, affecting the final amount due by reducing the total based on predefined rules.
promocodepluginimplStringFalseNoReferences the plugin implementation tied to the applied promo code, controlling custom discount logic and behavior within the system.
recognizedrevenueDecimalFalseNoThe portion of revenue from this transaction that has been formally recognized in financial reports based on revenue recognition rules.
returntrackingnumbersStringFalseNoTracking numbers associated with returned goods for logistics and reconciliation, used to monitor shipment status and processing.
revenuestatusStringFalseNoIndicates the revenue recognition stage of this transaction, such as 'Deferred,' 'Recognized,' or 'In Progress,' based on accounting rules.
salesgroupStringFalseNoThe sales team or division responsible for handling this transaction. Helps allocate commissions and track sales performance.
salesrepStringFalseNoThe individual sales representative associated with this transaction, used for performance tracking and commission calculations.
shipaddressStringFalseNoThe detailed shipping address provided for this transaction, including street, city, state, and postal code.
shipaddresslistStringFalseNoA list of predefined shipping addresses available for selection in the transaction, typically linked to the customer record.
shipisresidentialStringFalseNoA flag indicating whether the shipping address is a residential location, which can impact shipping rates and delivery options.
shipoverrideStringFalseNoIndicates whether manual adjustments have been made to the shipping details, overriding default settings or system-calculated values.
shippingaddressStringFalseNoThe final confirmed destination address where goods will be delivered. This field consolidates relevant shipping information.
sourceStringFalseNoThe origin or channel through which this transaction was created, such as 'Online Store,' 'Sales Order,' or 'Manual Entry.'
subsidiaryStringFalseNoThe specific subsidiary within a multi-entity organization that owns this transaction, important for financial reporting and consolidation.
subtotalDecimalFalseNoThe total amount for items in this transaction before taxes, discounts, and shipping fees are applied.
syncpartnerteamsBooleanFalseNoA flag indicating whether partner teams should be synchronized across linked records in the system for consistency.
syncsalesteamsBooleanFalseNoA flag indicating whether the sales team assignment should be synchronized across related transactions for reporting accuracy.
totalDecimalFalseNoThe final transaction amount after applying all taxes, discounts, and fees. This is the amount payable by the customer.
trackingnumbersStringFalseNoThe shipment tracking numbers associated with this transaction, used to monitor delivery status and estimated arrival dates.
trandateDateFalseNoThe official date of the transaction, which determines when it is recorded in financials and impacts revenue recognition timing.
tranidStringFalseNoA system-generated unique Id for this transaction, used for reference and lookup in reports and audits.
tranisvsoebundleBooleanFalseNoIndicates whether the transaction involves a VSOE (Vendor-Specific Objective Evidence) bundle, affecting revenue allocation rules.
vsoeautocalcBooleanFalseNoA flag that determines if the system should automatically calculate VSOE allocation for revenue recognition compliance.

Return to Top

revenueCommitmentReversalBillingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique internal identifier (Id) for the billing address record, primarily used for referencing this entry within the system.
addr1StringFalseNoThe first line of the billing address, typically used for street address details such as house number and street name.
addr2StringFalseNoThe second line of the billing address, often used for apartment numbers, suite numbers, or other secondary address information.
addr3StringFalseNoAn optional third line of the billing address for additional location details that do not fit in the first two lines.
addresseeStringFalseNoThe name of the individual or business entity associated with the billing address, used for invoicing and correspondence.
attentionStringFalseNoA specific contact person or department at the billing address, ensuring that important documents reach the correct recipient.
cityStringFalseNoThe city in which the billing address is located, used for geographical classification and shipping purposes.
countryStringFalseNoThe country associated with the billing address, used for international shipping, taxation, and regional compliance.
dropdownstateStringFalseNoA selectable state or province value from a predefined list, ensuring consistency in regional data entry.
overrideBooleanFalseNoA flag indicating whether the default billing address has been manually overridden, allowing for custom address specifications.
stateStringFalseNoThe state or province portion of the billing address, used for regional tax calculations and shipping logistics.

Return to Top

revenueCommitmentReversalPartner 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage of total revenue attributed to this partner for a given revenue commitment reversal. This value helps in tracking and analyzing the financial impact of partnerships.
isprimaryBooleanFalseNoIndicates whether this partner is the primary partner for the revenue commitment reversal. A primary partner typically plays a leading role in the transaction and can have higher priority in revenue allocation.
partnerStringFalseNoThe unique identifier (Id) or name of the partner associated with this revenue commitment reversal. This field is essential for linking the transaction to a specific partner record within the system.
partnerroleStringFalseNoDefines the role of the partner in relation to the revenue commitment reversal. This can include roles such as reseller, distributor, or consultant, depending on the nature of the partnership agreement.

Return to Top

revenueCommitmentReversalSalesTeam 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage of the total revenue commitment reversal attributed to this sales team member. This value helps in determining the impact of individual team members on the overall revenue adjustment.
employeeStringFalseNoThe unique identifier (Id) or name of the employee assigned to the sales team. This field links to the employee record and provides information about who is responsible for the sale.
isprimaryBooleanFalseNoIndicates whether this sales team member is the primary representative for the revenue commitment reversal. A value of 'true' means they have the primary responsibility.
salesroleStringFalseNoThe role of the sales team member in the transaction, such as Account Executive or Sales Manager. This helps in tracking the contribution of different roles in the revenue commitment reversal process.

Return to Top

revenueCommitmentReversalShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique identifier (Id) for the shipping address record, primarily used internally for database operations.
addr1StringFalseNoThe first line of the shipping address, typically containing the street address or P.O. Box number.
addr2StringFalseNoThe second line of the shipping address, often used for apartment numbers, suite numbers, or other secondary address details.
addr3StringFalseNoThe third line of the shipping address, used for additional location details when necessary.
addresseeStringFalseNoThe full name of the recipient or the business entity receiving the shipment, ensuring accurate delivery to the intended party.
attentionStringFalseNoThe designated individual or department within the recipient's organization that should receive the shipment, aiding in proper internal distribution.
cityStringFalseNoThe specific municipality or locality where the shipment is being delivered, used for routing and delivery accuracy.
countryStringFalseNoThe country where the shipment is being sent, typically represented by its full name or standardized country code.
dropdownstateStringFalseNoA state or province selection field, typically linked to a dropdown menu for standardized input.
overrideBooleanFalseNoA flag indicating whether the default shipping address should be overridden by a manually specified address.
stateStringFalseNoThe state or province associated with the shipping address, ensuring accurate geographic location details.

Return to Top

revenueCommitmentReversalTrackingNumberMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
trackingnumberStringFalseNoA unique tracking number associated with the specific Revenue Commitment Reversal transaction in NetSuite, serving as a reference identifier (Id) used to monitor, trace, and manage the reversal process. This tracking number helps users quickly locate, review, and audit reversal entries within financial reports, transaction histories, and related accounting records.

Return to Top

revenueCommitmentSalesTeam 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoPercentage contribution of the sales team member towards the total revenue commitment, represented as a decimal value. For example, a value of 25.0 indicates that the team member contributes 25 percent to the overall commitment.
employeeStringFalseNoThe full name or identifier (Id) of the employee who is part of the sales team responsible for the revenue commitment. Typically, this is a reference to an existing employee record within NetSuite.
isprimaryBooleanFalseNoA boolean flag indicating whether the employee is designated as the primary representative or lead for the sales transaction or revenue commitment. A value of 'true' indicates that the employee is primary, otherwise, it is 'false.'
salesroleStringFalseNoThe specific role or position held by the employee in relation to the sales process or revenue commitment, such as Account Executive, Sales Manager, or Sales Engineer. This role helps categorize the employee's responsibilities and contributions within the team.

Return to Top

revenueCommitmentShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoThe unique identifier (Id) referencing the revenue commitment shipping address record in the NetSuite database.
addr1StringFalseNoPrimary street address line for the shipping destination, typically including street number, street name, or PO Box information.
addr2StringFalseNoSecondary street address line, used to include additional location details such as suite, unit, or building numbers.
addr3StringFalseNoTertiary street address line, optionally providing further details or clarifications of the shipping address, if applicable.
addresseeStringFalseNoFull name of the individual, department, or entity designated as the recipient of the shipment.
attentionStringFalseNoSpecific individual or department to whom the shipment should be directed, often used to ensure accurate delivery within large organizations.
cityStringFalseNoThe city component of the shipping address associated with the revenue commitment record in NetSuite, impacting tax calculations, shipping logistics, and reporting accuracy.
countryStringFalseNoCountry name associated with the shipping address, used to specify the international destination for the shipment.
dropdownstateStringFalseNoState or province selection from a predefined dropdown list corresponding to the shipping address, ensures accuracy and consistency in the address.
overrideBooleanFalseNoBoolean flag indicating whether the default address information should be manually overridden by the current address details provided. A value of 'true' specifies an explicit override.
stateStringFalseNoName or abbreviation of the state or province associated with the shipping address, typically used when manual input or customization of state information is necessary.

Return to Top

revenueCommitmentTrackingNumberMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
trackingnumberStringFalseNoThe unique shipment tracking number associated with the revenue commitment record in NetSuite, used to monitor and trace the shipment or delivery status of goods linked to specific revenue commitments.

Return to Top

revenueContractSalesTeam 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage contribution of the employee towards the revenue contract, indicating the portion of credit attributed to this individual within the sales team. Values are represented as decimal numbers, where 0.25 corresponds to a 25% contribution.
employeeStringFalseNoThe unique identifier (Id) or full name of the employee involved in the revenue contract. This field helps clearly identify the specific team member assigned to the contract.
isprimaryBooleanFalseNoA boolean indicator specifying whether the employee is the primary individual responsible for the revenue contract. A value of 'true' signifies that the employee holds primary accountability, whereas 'false' indicates a secondary or supporting role.
salesroleStringFalseNoDefines the specific role or position held by the employee within the sales team for the revenue contract. Typical values include roles such as Account Manager, Sales Executive, Sales Representative, and Sales Director, reflecting the employee’s functional responsibilities.

Return to Top

RevenueElement 

NameTypeReadOnlyReferencesFilterOnlyDescription
SourceRecordTypeBooleanFalseNoIndicates whether the revenue element originates from a source record, specifying 'true' or 'false.'
ItemisautoexpandStringFalseNoIdentifies whether the associated item automatically expands into multiple revenue elements during revenue arrangement creation.
AccountingBookIntegerFalseNoRepresents the unique internal identifier (Id) for the accounting book used to track revenue recognition, referencing NetSuite accounting book records.
AllocatedcontractcostamountFloatFalseNoShows the total amount of contract cost allocated to this specific revenue element for accounting and reporting purposes.
AllocationTypeStringFalseNoDefines the method used to allocate revenue or costs, such as 'Fixed Amount', 'Percentage', or 'Relative Fair Value'.
AlternateQuantityFloatFalseNoSpecifies an alternate quantity measurement applicable to the item, typically used for items with dual measurement units.
AlternateUnitsIntegerFalseNoContains the internal Id for alternate units of measure linked to the item, as defined in the Units of Measure table.
AlternateUnitsTypeIntegerFalseNoReferences the internal Id of the units type associated with the alternate measurement for the item.
AmortizationEndDateDateFalseNoSpecifies the end date of the amortization period, marking when revenue recognition or cost amortization concludes.
AmortizationScheduleIntegerFalseNoRefers to the internal Id of the amortization schedule that dictates timing and amounts for revenue or cost recognition.
AmortizationStartDateDateFalseNoSpecifies the start date for the amortization period, indicating when revenue recognition or cost amortization begins.
AmortizationTemplateIntegerFalseNoIdentifies the internal Id of the amortization template applied to standardize revenue or expense recognition processes.
FairValueFloatFalseNoCaptures the fair market value assigned to the item or service within the revenue element, critical for revenue allocation purposes.
CalculatedAmountFloatFalseNoReflects the system-calculated revenue amount based on the allocation rules and fair value considerations.
CarveinratioPercentFalseNoDisplays the percentage ratio applied to incorporate additional revenues or costs from other elements into this element.
CarveoutratioPercentFalseNoShows the percentage ratio applied to exclude or transfer certain revenues or costs away from this specific revenue element.
ClassIntegerFalseNoStores the internal Id of the class dimension, categorizing the revenue element for financial reporting and analysis.
ContractcostallocationpctPercentFalseNoIndicates the percentage of total contract cost allocated specifically to this revenue element for expense recognition purposes.
ContractExpenseAcctIntegerFalseNoHolds the internal Id of the general ledger expense account to which contract-related expenses are posted.
ContractExpenseOffsetAcctIntegerFalseNoContains the internal Id of the offset account in the general ledger used when posting contract expense adjustments.
CostAmortizationAmountFloatFalseNoRepresents the total amount of cost amortization recognized for this revenue element over its specified amortization period.
CreateRevenuePlansOnIntegerFalseNoDetermines the trigger event or condition (for example, invoice, fulfillment, payment) that initiates the creation of revenue plans.
CurrencyIntegerFalseNoIndicates the internal Id of the currency associated with financial transactions involving this revenue element.
EntityIntegerFalseNoIdentifies the internal Id of the entity (customer or project) associated with the revenue element transaction.
DeferralAccountIntegerFalseNoStores the internal Id of the general ledger account used to defer revenue recognition until earned.
DeferContractExpenseAcctIntegerFalseNoSpecifies the internal Id of the account used to defer recognition of contract-related expenses until applicable.
JournalEntryIntegerFalseNoContains the internal Id linking the revenue element to the associated journal entry for financial reporting purposes.
DeliveredBooleanFalseNoIndicates whether the item or service associated with the revenue element has been delivered or performed, either 'true' or 'false.'
DepartmentIntegerFalseNoReferences the internal Id of the department dimension, categorizing the revenue element for organizational financial analysis.
DiscountedSalesAmountFloatFalseNoReflects the sales amount of the revenue element after applying discounts, relevant for revenue allocation calculations.
EffectiveEndDateDateFalseNoSpecifies the effective end date of the revenue element, defining the period after which revenue recognition ceases.
EffectiveStartDateDateFalseNoSpecifies the effective start date for the revenue element, marking the beginning of the active recognition period.
ContingentRevenueHandlingBooleanFalseNoIdentifies if the revenue element includes contingent revenue, which requires special handling or delayed recognition until certain conditions are met, either 'true' or 'false.'
RevRecEndDateDateFalseNoDefines the end date for revenue recognition specifically for this revenue element, marking completion of recognition activities.
ExchangeRateFloatFalseNoThe foreign currency exchange rate applied to convert transactions into the base currency at the time of revenue recognition.
TreatmentOverrideBooleanFalseNoIndicates whether the default revenue recognition treatment for this element has been manually overridden by the user.
ExpensemigrateadjaccountIntegerFalseNoThe Id of the general ledger account used to record expense adjustments during the migration of revenue elements.
ExternalIdStringFalseNoA unique external Id provided by an external system to link or synchronize revenue elements between systems.
FairValueOverrideBooleanFalseNoSpecifies whether the fair value automatically calculated by the system has been manually overridden for this revenue element.
ForecastenddateDateFalseNoThe anticipated end date of the forecast period for revenue recognition associated with this revenue element.
ForecastStartDateDateFalseNoThe anticipated start date of the forecast period for revenue recognition associated with this revenue element.
RevreclassfxaccountIntegerFalseNoAccount number used specifically for recording foreign exchange adjustments related to revenue reclassification transactions.
FullnameStringFalseNoThe complete name of the revenue element, providing a human-readable Id for reporting and analysis purposes.
Id [KEY]IntegerFalseNoA unique internal Id used by NetSuite to distinctly reference this revenue element.
IsBOMItemTypeBooleanFalseNoA boolean flag indicating whether this revenue element corresponds to a Bill of Materials (BOM) item type.
IsVsoePriceBooleanFalseNoIndicates whether the revenue element pricing adheres to Vendor-Specific Objective Evidence (VSOE) pricing guidelines.
ItemIntegerFalseNoInternal Id linking to the specific inventory or non-inventory item associated with this revenue element.
ItemlaborcostamountFloatFalseNoThe total labor cost amount associated directly with the item, used in revenue and cost analysis.
ItemresalecostamountFloatFalseNoThe total resale cost amount linked to the item, reflecting purchase or production costs.
LabordeferredexpenseacctIntegerFalseNoThe Id for the deferred expense account to record labor-related expenses awaiting future recognition.
LaborexpenseacctIntegerFalseNoThe Id for the account to record immediate labor expenses related to the revenue element.
LastMergedFromArrangementIntegerFalseNoReference to the last revenue arrangement Id from which this revenue element was merged.
LastModifiedDateDatetimeFalseNoThe most recent date and time when modifications were made to the revenue element record.
ReturnOfElementIntegerFalseNoThe Id referencing a previously returned or reversed revenue element, if applicable.
LocationIntegerFalseNoInternal Id specifying the business location or warehouse associated with the revenue element.
RecordNumberStringFalseNoA unique string Id serving as an external reference number for this revenue element record.
OriginalchangeorderdiscamountFloatFalseNoThe original discount amount specified in a change order affecting this revenue element.
OriginalchangeorderquantityFloatFalseNoThe original quantity specified by a change order that applies directly to this revenue element.
CarveOverrideBooleanFalseNoIndicates whether an override has been applied to standard revenue carve-in or carve-out rules for this element.
ParentBOMElementIntegerFalseNoThe Id linking this revenue element to its parent BOM element, if it is a child component.
PermitDiscountBooleanFalseNoSpecifies whether the system allows discounting to be applied to this revenue element.
PostingDiscountAppliedBooleanFalseNoIndicates whether posting-time discounts have already been applied to this revenue element.
QuantityFloatFalseNoThe number of units associated with this revenue element, relevant for calculating total revenue amounts.
RecognitionAccountIntegerFalseNoInternal Id for the account designated for revenue recognition postings for this element.
RecognitionTreatmentIntegerFalseNoThe Id specifying the accounting treatment or methodology applied to revenue recognition for this element.
ReferenceIdStringFalseNoExternal reference Id linking this revenue element to external systems or documents for tracking and audit purposes.
RequiresrevenueplanupdateBooleanFalseNoBoolean flag indicating whether an update to the associated revenue plan is required due to recent changes.
ResidualdiscsalesamountCurrencyFalseNoRemaining sales amount after applying any residual discounts to this revenue element.
RevenueAllocationGroupIntegerFalseNoThe Id of the revenue allocation group used for proportionally allocating revenue amounts to various elements.
RevenueAllocationRatioPercentFalseNoPercentage value representing the ratio used to allocate total revenue to this specific element within the allocation group.
AllocationAmountFloatFalseNoThe exact monetary amount allocated to this revenue element as part of revenue recognition processes.
RevenueArrangementIntegerFalseNoThe Id referencing the revenue arrangement record associated with this particular revenue element.
RevenuemigrateadjaccountIntegerFalseNoInternal Id for the account used to record migration adjustments related to revenue recognition transitions.
RevenueplanstatusStringFalseNoCurrent status of the associated revenue plan, such as Pending, Completed, or In Progress.
RevenueRecognitionRuleIntegerFalseNoThe Id linking to the specific revenue recognition rule governing the timing and conditions of recognizing revenue.
RevRecForecastRuleIntegerFalseNoThe Id for the forecast rule applied to revenue recognition for predictive revenue reporting.
SalesAmountFloatFalseNoTotal sales amount attributed to this revenue element prior to discounts and adjustments.
SourceStringFalseNoInformation indicating the originating source or document from which this revenue element was generated.
ElementDateDateFalseNoThe effective date associated with the creation or activation of this revenue element.
RevRecStartDateDateFalseNoDate marking the beginning of the revenue recognition period for this revenue element.
SubscriptionLineStringFalseNoReference to the subscription line item that generated this revenue element, relevant in recurring revenue scenarios.
SubsidiaryIntegerFalseNoInternal Id for the subsidiary entity within the organization responsible for managing this revenue element.
CarveinamountFloatFalseNoThe monetary amount carved into this revenue element, representing additional allocations from other elements.
CarveoutamountFloatFalseNoThe monetary amount carved out from this revenue element, representing reductions due to allocations to other elements.
TermInDaysIntegerFalseNoTotal duration of the revenue recognition term expressed in days.
TermInMonthsIntegerFalseNoTotal duration of the revenue recognition term expressed in months.
NewStandardMigrateDateDateFalseNoThe date on which this revenue element was migrated or transitioned to a new accounting standard for revenue recognition.
UnbilledReceivableGroupStringFalseNoGroup Id for unbilled receivables linked to this revenue element, useful in reporting unbilled revenue statuses.
UnitsStringFalseNoMeasurement units applicable to the quantity for this revenue element, such as hours, items, licenses, or subscriptions.

Return to Top

revenueElementSourceType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier (Id) representing the specific revenue element source type within NetSuite. This value is used to distinctly reference or query the associated revenue element source type, facilitating accurate data retrieval and manipulation in revenue management processes.

Return to Top

RevenuePlan 

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]IntegerFalseNoThe unique identifier (Id) for the revenue plan record.
amountDecimalFalseNoThe monetary amount allocated to the revenue plan, representing the total revenue expected to be recognized.
amountsourceStringFalseNoSpecifies the source from which the revenue amount was derived, such as contract value, invoice total, or custom calculation.
catchupperiodStringFalseNoIndicates the specific accounting period used for catch-up revenue recognition adjustments, if applicable.
commentsStringFalseNoAdditional remarks or explanatory notes associated with the revenue plan entry.
createdfromStringFalseNoIdentifies the originating transaction or record that initiated the creation of this revenue plan.
enddatechangeimpactStringFalseNoDescribes how changes made to the end date of the revenue recognition schedule impact the overall revenue calculation and recognition timing.
exchangerateDecimalFalseNoExchange rate applied to convert amounts from the transaction currency to the revenue plan currency.
holdrevenuerecognitionBooleanFalseNoIndicates whether revenue recognition is currently on hold for this plan, temporarily pausing all associated recognition activities.
initialamountDecimalFalseNoThe initial amount set at the inception of the revenue plan, used as a reference for future adjustments and recognition.
itemStringFalseNoReferences the specific item, product, or service related to the revenue being recognized under this revenue plan.
parentlinecurrencyStringFalseNoSpecifies the original currency used on the parent transaction line from which this revenue plan derives.
periodoffsetStringFalseNoDetermines the number of periods offset from the original recognition schedule, if any adjustments are required.
recognitionmethodStringFalseNoDefines the method or approach used for revenue recognition, such as straight-line, milestone-based, or event-driven.
recognitionperiodIntegerFalseNoThe total number of accounting periods across which the revenue is scheduled to be recognized.
recordnumberStringFalseNoThe assigned number or Id for tracking and referencing the revenue plan internally.
remainingdeferredbalanceDecimalFalseNoThe amount of revenue that remains deferred and not yet recognized as of the current period.
revenueplancurrencyStringFalseNoSpecifies the currency in which this revenue plan is denominated and reported.
revenueplantypeStringFalseNoClassifies the revenue plan into types based on their nature, such as forecast, actual, or budgeted plans.
revenuerecognitionruleStringFalseNoReferences the specific accounting rule or policy governing how revenue is recognized for this plan.
revrecenddateDateFalseNoThe planned or actual date on which revenue recognition for this revenue plan ends.
revrecenddatesourceStringFalseNoIndicates the source or basis from which the revenue recognition end date was derived, such as contract terms or user-defined criteria.
revrecstartdateDateFalseNoThe planned or actual date on which revenue recognition for this revenue plan begins.
revrecstartdatesourceStringFalseNoIndicates the source or criteria used to determine the revenue recognition start date, including contract commencement or invoice date.
startoffsetStringFalseNoRepresents the number of periods offset from the original start date of the recognition schedule due to adjustments or changes.
statusStringFalseNoThe current status of the revenue plan, such as active, completed, pending approval, or cancelled.
terminmonthsIntegerFalseNoSpecifies the total duration of the revenue recognition term, measured in months.
totalrecognizedDecimalFalseNoThe cumulative amount of revenue already recognized to date under this specific revenue plan.

Return to Top

revenuePlanSource 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoA unique identifier (Id) representing the specific revenue plan source record in NetSuite. This key is automatically generated by the system and is used to uniquely reference and retrieve the corresponding record from the database.

Return to Top

revenuePlanStatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier (Id) representing the specific status key associated with a revenue plan in NetSuite, used to reference or retrieve the corresponding revenue recognition status within the system.

Return to Top

revenuePlanType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier (Id) representing a specific Revenue Plan Type record within NetSuite, used to retrieve or reference individual records in API requests or database operations.

Return to Top

revRecAmountSourceType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier (Id) representing the specific revenue recognition amount source type within NetSuite, used to reference or retrieve detailed information about the source type.

Return to Top

revRecChangeImpactType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier (Id) for the revenue recognition change impact type within NetSuite, used to reference specific records in queries and updates. This Id typically corresponds to an internal system key generated by NetSuite to distinctly track revenue recognition adjustments.

Return to Top

revRecDateSourceType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier (Id) representing the specific source type used to determine the revenue recognition date within NetSuite. This key identifies the particular rule or configuration applied when calculating the date revenue should be recognized in financial reporting.

Return to Top

revRecEventPRevRule 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyDecimalFalseNoA unique numeric identifier (Id) serving as the primary key for referencing a specific revenue recognition event within the Revenue Recognition Event Percent Complete Rule in NetSuite.

Return to Top

revRecEventTranLine 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier (Id) used to reference a specific transaction line related to a revenue recognition event within NetSuite. This key is typically generated by the system or provided by the user to uniquely distinguish each entry, facilitating accurate tracking, updating, and retrieval of transaction line data for processing revenue recognition events.

Return to Top

revRecRecurrenceType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier (Id) for the revenue recognition recurrence type record within NetSuite. This key is used to reference or retrieve specific recurrence type configurations, ensuring precise identification during integration or data management tasks.

Return to Top

revrecschedule 

NameTypeReadOnlyReferencesFilterOnlyDescription
amortizationperiodIntegerFalseNoThe total duration, specified in periods, over which the revenue recognition amount is evenly amortized.
amortizationtypeStringFalseNoSpecifies the method used for amortizing revenue recognition, such as straight-line or variable schedules, determining how revenue is recognized over time.
externalidStringFalseNoA unique external identifier (Id) for referencing this revenue recognition schedule from external systems or integrations.
initialamountStringFalseNoThe initial monetary amount that is set for revenue recognition at the start of the schedule, represented as a string-formatted numeric value.
isinactiveBooleanFalseNoIndicates whether the revenue recognition schedule is inactive. When set to 'true,' the schedule will no longer be used for new revenue recognition transactions.
ispublicBooleanFalseNoDetermines the visibility of the revenue recognition schedule, where 'true' indicates the schedule is publicly accessible within the organization.
jobStringFalseNoIdentifies the specific job or project associated with this revenue recognition schedule, linking revenue recognition to job-related accounting activities.
nameStringFalseNoThe descriptive name of the revenue recognition schedule, providing an easily recognizable reference within the NetSuite environment.
periodoffsetIntegerFalseNoThe number of accounting periods by which the start of revenue recognition is offset from the original date of transaction or service delivery.
recogintervalsrcStringFalseNoDefines the source interval for revenue recognition, specifying the frequency (daily, weekly, monthly, quarterly, yearly) at which revenue is recognized.
recurrencetypeStringFalseNoSpecifies the recurrence pattern for recognizing revenue, such as one-time, recurring, or event-based, guiding how frequently revenue recognition entries occur.
revrecoffsetIntegerFalseNoThe offset, measured in periods, from the transaction date after which revenue recognition begins, effectively delaying recognition according to this specified interval.
totalamountDecimalFalseNoThe total revenue amount that will ultimately be recognized over the entire duration of the schedule, specified as a decimal number.

Return to Top

revrectemplate 

NameTypeReadOnlyReferencesFilterOnlyDescription
amortizationperiodIntegerFalseNoSpecifies the length of time, in periods, over which the revenue or expense is amortized.
amortizationtypeStringFalseNoIndicates the method or type of amortization applied to the revenue recognition schedule, such as straight-line or proportional.
externalidStringFalseNoA unique identifier (Id) assigned to the revenue recognition template from an external source or system, facilitating integrations and external references.
initialamountStringFalseNoRepresents the initial monetary value or starting amount to be recognized according to the amortization schedule.
isinactiveBooleanFalseNoDetermines whether the revenue recognition template is inactive. A value of 'true' means the template is currently inactive and not available for use.
ispublicBooleanFalseNoIndicates whether the revenue recognition template is publicly accessible to all users within the system. A value of 'true' signifies public availability.
jobStringFalseNoAssociates the revenue recognition template with a specific job or project, enabling tracking and allocation of recognized revenue or expense.
nameStringFalseNoProvides the descriptive name or title assigned to the revenue recognition template for easy identification and selection.
periodoffsetIntegerFalseNoDefines the offset, in periods, from the posting or transaction date before revenue recognition commences.
recogintervalsrcStringFalseNoDetermines the source interval or frequency at which revenue recognition occurs, such as monthly, quarterly, or annually.
recurrencetypeStringFalseNoSpecifies the recurrence pattern or periodicity for revenue recognition, including options like one-time, recurring, or custom schedules.
revrecoffsetIntegerFalseNoSpecifies the offset, in periods, applied before revenue recognition starts, allowing delayed recognition schedules.
totalamountDecimalFalseNoIndicates the total monetary amount that will be recognized over the entire duration of the revenue recognition schedule.

Return to Top

role 

NameTypeReadOnlyReferencesFilterOnlyDescription
idIntegerFalseNoThe unique identifier (Id) assigned to each role within the NetSuite environment.
restrictbydeviceBooleanFalseNoIndicates whether the role is restricted to specific devices for security purposes. When the value is 'true,' users can access NetSuite only from approved devices.
ispartnerroleBooleanFalseNoSpecifies whether the role is designated exclusively for partner users, providing specific permissions tailored for external partners interacting with NetSuite.
issinglesignononlyBooleanFalseNoDetermines if the role is restricted to Single Sign-On (SSO) authentication methods only, disallowing traditional username/password logins.
accountingbooksoptionStringFalseNoDefines the available options for selecting accounting books accessible by this role, such as 'ALL', 'PRIMARY', or specific accounting book IDs.
issalesroleBooleanFalseNoIndicates whether this role is specifically tailored for sales users, granting permissions related to sales operations, transactions, and CRM functionalities.
subsidiaryviewingallowedBooleanFalseNoSpecifies whether the role permits viewing data across multiple subsidiaries within the organization, enabling cross-subsidiary visibility when the value is 'true.'
scriptidStringFalseNoA unique script Id for this role, commonly used when referencing roles via SuiteScript or external integrations.
subsidiaryoptionStringFalseNoDetermines the subsidiary access level options associated with the role, including 'ALL', 'OWN_SUBSIDIARY', or a specific list of subsidiary IDs.
coreadminpermissionBooleanFalseNoIdentifies whether the role possesses core administrative permissions, allowing comprehensive administrative actions within the NetSuite environment.
restricttimeandexpensesBooleanFalseNoIndicates whether the role imposes restrictions on the entry and approval of employee time and expenses, enforcing stricter control over related records.
accountingbooksrestrictionStringFalseNoSpecifies any restrictions applied to accounting book access, potentially limiting the role's visibility and operational scope to certain accounting books.
nameStringFalseNoThe human-readable descriptive name assigned to this role, facilitating easy identification and assignment by system administrators and users.
effectivesubsidiariesStringFalseNoLists the subsidiaries effectively accessible by this role, represented as a comma-separated string containing subsidiary IDs or the keyword 'ALL'.
issupportroleBooleanFalseNoIndicates whether the role is specifically designed for customer support operations, providing specialized permissions for handling support cases and customer interactions.
subsidiaryrestrictionStringFalseNoDefines restrictions placed on subsidiaries that the role can access, limiting interactions and operations to specified subsidiaries or groups.
iswebserviceonlyroleBooleanFalseNoSpecifies whether the role is exclusively intended for web service interactions, restricting regular user interface access and ensuring the role, used solely for API-based integrations.
effectiveaccountingbooksStringFalseNoLists accounting books that are effectively available to this role, represented as a comma-separated string of accounting book IDs or the keyword 'ALL'.
employeerestrictionStringFalseNoIndicates restrictions applied to employee visibility and selection for this role, such as 'NONE', 'OWN', or specific employee group identifiers.
employeeviewingallowedBooleanFalseNoDetermines if the role allows the user to view employee records outside of their immediate organizational unit or reporting structure.
employeeselectionunrestrictedBooleanFalseNoIdentifies whether the role can select from an unrestricted list of employees when assigning transactions or activities, bypassing normal employee-based security restrictions.
centertypeStringFalseNoSpecifies the type of NetSuite center (user interface context) assigned to this role, such as 'ACCOUNTING', 'SALES', 'SUPPORT', or other defined centers.

Return to Top

rolepermissions 

NameTypeReadOnlyReferencesFilterOnlyDescription
roleIntegerFalseNoThe unique numeric identifier (Id) for the NetSuite user role associated with the specific permission. This defines which user role is being assigned or evaluated.
permkeyStringFalseNoThe unique string Id (PermKey) representing the specific permission assigned to the role. This key corresponds to a permission or access right within NetSuite, such as transactions, records, reports, or setup configurations.
nameStringFalseNoThe descriptive name of the permission corresponding to the PermKey. It provides a human-readable description of the specific permission or access capability granted to the NetSuite role.
permlevelIntegerFalseNoAn integer value indicating the access level of the permission granted. Higher values typically represent higher permission levels, such as view-only, create, edit, or full access.
restrictionIntegerFalseNoA numeric indicator specifying any additional restrictions applied to this permission, determining the scope of data access allowed for the given role. Common restrictions include limits based on user department, subsidiary, or employee classification.

Return to Top

rolerestrictions 

NameTypeReadOnlyReferencesFilterOnlyDescription
roleIntegerFalseNoThe unique identifier (Id) for the role associated with the restriction. This value references a specific role defined in NetSuite, determining which user or group is impacted by the given restriction.
itemsrestrictedBooleanFalseNoBoolean flag indicating whether item-level restrictions apply to the specified role. A value of 'true' means that the role's access to certain items is restricted, while 'false' indicates no such restrictions.
segmentIntegerFalseNoThe Id for the segment associated with the restriction. This segment typically corresponds to a specific NetSuite classification, department, or location that further qualifies the scope of the restriction.
viewingallowedBooleanFalseNoBoolean indicator specifying if the role has viewing permissions despite restrictions. When set to 'true', the role can view restricted items or segments; when 'false', viewing is prohibited.
restrictionStringFalseNoDefines the type or nature of the restriction applied to the role. Possible values are ACCOUNT, CLASS, DEPARTMENT, LOCATION, SUBSIDIARY, ITEM, or other NetSuite-specific categorizations, clearly identifying the domain of the restriction.

Return to Top

saleschannel 

NameTypeReadOnlyReferencesFilterOnlyDescription
customformStringFalseNoSpecifies the custom form template used to enter or view data for this sales channel in the NetSuite UI.
descriptionStringFalseNoProvides a detailed explanation of the sales channel’s function, such as online store, retail outlet, or partner platform.
externalidStringFalseNoAn external system identifier used to sync the sales channel record with other systems or third-party platforms.
idIntegerFalseNoUnique internal identifier assigned by NetSuite to reference this specific sales channel.
isinactiveBooleanFalseNoIndicates whether the sales channel is currently inactive. Inactive channels cannot be used in transactions.
nameStringFalseNoThe display name of the sales channel, used across reports, forms, and transaction records.
onlyusereservationassupplyBooleanFalseNoIf the value is 'true', restricts inventory sourcing for this channel to reserved inventory only, limiting fulfillment flexibility.
orderpriorityDoubleFalseNoNumerical value that determines the processing order of sales. Lower numbers are prioritized over higher ones.
templatestoredBooleanFalseNoSpecifies whether this sales channel is saved as a template for reuse in creating new channel records.

Return to Top

salesInvoiced 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account associated with this invoiced line item. Typically reflects the revenue, expense, or other posting account impacted by the transaction.
amountDecimalFalseNoThe total gross amount billed for this line item on the invoice, including any applicable taxes, discounts, and adjustments.
amountnetDecimalFalseNoThe net amount for the invoiced line item, representing the base price before taxes or additional charges are applied.
classStringFalseNoThe classification assigned to this invoice line item for financial reporting or segmentation purposes, such as business unit, product line, or market segment.
costestimateDecimalFalseNoThe estimated cost of the item or service being invoiced. Used in gross profit calculations and profitability forecasting.
departmentStringFalseNoThe internal department responsible for the sale or delivery of the item or service. Supports departmental financial reporting and budgeting.
employeeStringFalseNoThe sales representative credited with this invoice, used for tracking performance, commissions, and team attribution.
entityStringFalseNoThe customer or client receiving the invoice. This identifies the buyer in the sales transaction.
estgrossprofitDecimalFalseNoThe estimated gross profit for this line item, calculated as the net amount minus the estimated cost. Helps assess the profitability of the transaction.
estgrossprofitpercentDoubleFalseNoThe estimated gross profit margin expressed as a percentage of the revenue, offering a relative measure of profitability for this line item.
itemStringFalseNoThe specific product or service being billed on this line of the invoice.
itemcountDoubleFalseNoThe quantity of the product or service sold and included in the invoice line.
locationStringFalseNoThe warehouse, store, or other location responsible for fulfilling the order. Useful for inventory tracking and regional reporting.
memoStringFalseNoAn optional note or comment associated with this invoice line item. May contain internal details, special terms, or customer-facing information.
partnerStringFalseNoThe partner, such as an affiliate or reseller, associated with the transaction. Used for tracking partner sales and allocating credit or commissions.
subsidiaryStringFalseNoThe legal or reporting entity under which the invoice was created. Relevant in multi-subsidiary configurations for compliance and consolidated reporting.
trandateDateFalseNoThe official transaction date of the invoice. This determines accounting period recognition and aging calculations.
tranlineStringFalseNoThe unique identifier or sequence number for this line item within the invoice transaction.
transactionStringFalseNoThe parent transaction record to which this invoice line belongs. Serves as a linkage for reporting and auditing purposes.
typeStringFalseNoThe type of transaction, such as 'Invoice', 'Credit Memo', or another sales-related record.

Return to Top

salesorder 

NameTypeReadOnlyReferencesFilterOnlyDescription
allowemptycardsBooleanFalseNoIf the value is 'true', the system permits submission of payment forms without credit card details, which can be useful in deferred payment workflows or test environments.
althandlingcostDecimalFalseNoRepresents an alternate handling fee calculated outside the standard shipping logic, often used in custom pricing scenarios or third-party integrations.
altsalestotalDecimalFalseNoIndicates an alternate version of the total sales amount, such as a promotional price total or a calculated value in a different currency context.
altshippingcostDecimalFalseNoRepresents a modified shipping cost calculated based on custom rules, promotions, or external rate calculations instead of the standard shipping logic.
aomautomatedBooleanFalseNoIf the value is 'true', this order is automatically processed using Advanced Order Management (AOM) rules, including automated approval, fulfillment, and billing steps.
authcodeStringFalseNoThe authorization code received from the payment processor confirming that the credit card transaction was approved.
balanceDecimalFalseNoThe outstanding amount remaining on the sales order that has not yet been billed or paid, used for accounts receivable tracking.
billaddressStringFalseNoThe full, formatted billing address associated with the sales order, typically used for display and reporting purposes.
billaddresslistStringFalseNoA reference ID pointing to one of the customer's saved billing addresses selected during order entry.
billingaddressStringFalseNoThe raw or structured billing address data entered or stored directly on the sales order.
billingscheduleStringFalseNoThe billing schedule template that governs how and when the customer is invoiced, such as milestone or time-based billing.
billisresidentialStringFalseNoIndicates whether the billing address is considered a residential location, which may impact tax calculations or delivery logistics.
canhavestackableBooleanFalseNoIf the value is 'true', this order can support multiple, stackable promotions or discounts applied to the same transaction, depending on pricing rules.
ccapprovedBooleanFalseNoIf the value is 'true', the credit card transaction associated with the sales order was successfully approved by the payment gateway.
ccavsstreetmatchStringFalseNoIndicates whether the street address provided matches the cardholder’s address on file, based on Address Verification System (AVS) results from the payment processor.
ccavszipmatchStringFalseNoIndicates whether the ZIP or postal code provided during checkout matches the billing address on file for the credit card used.
ccexpiredateStringFalseNoThe expiration date of the credit card used for the transaction, typically in MM/YY format.
ccholdStringFalseNoDescribes whether the credit card payment is currently on hold due to an issue such as insufficient funds or processor rejection.
ccholdetailsStringFalseNoProvides specific reasons or messages returned by the payment processor explaining why the card transaction was held.
cciavsmatchStringFalseNoSummarizes the result of the AVS from the payment gateway, combining street and ZIP code match results.
ccnameStringFalseNoThe full name printed on the credit card used for this transaction, usually required for verification and fraud prevention.
ccnumberStringFalseNoThe (masked) credit card number associated with the order, shown in a secure format (for example, **** **** **** 1234) for reference.
ccprocessoraccountStringFalseNoIdentifies which payment processor account was used for this credit card transaction, supporting multi-gateway configurations.
ccsecuritycodeStringFalseNoThe CVV/CVC security code entered with the credit card, used for verification during transaction authorization.
ccsecuritycodematchStringFalseNoIndicates whether the CVV/CVC security code provided matched the card issuer’s records, based on payment processor response.
ccstreetStringFalseNoThe street portion of the billing address submitted for AVS validation during credit card processing.
cczipcodeStringFalseNoThe ZIP or postal code portion of the billing address submitted for AVS validation during credit card processing.
checknumberStringFalseNoIf payment was made by check, this field stores the check number for audit and reconciliation purposes.
classStringFalseNoA classification used to segment the transaction by business unit, product line, or region, supporting internal reporting structures.
consolidatebalanceDecimalFalseNoReflects the customer’s total outstanding balance across all subsidiaries or related entities, used in consolidated financial reporting.
couponcodeStringFalseNoPromotional or marketing code applied to the sales order to trigger discounts, free shipping, or other incentives.
createddateDatetimeFalseNoThe timestamp when the sales order was first created in the system, used for auditing and reporting.
createdfromStringFalseNoReference to the originating transaction, such as a quote or opportunity, from which this sales order was created.
creditcardStringFalseNoIdentifies the credit card record selected for payment, typically used in saved payment methods or vault references.
creditcardprocessorStringFalseNoIndicates the payment gateway or credit card processor responsible for handling the transaction.
currencyStringFalseNoThe currency in which the sales order is denominated, impacting pricing, totals, and exchange rate calculations.
currencynameStringFalseNoThe human-readable name of the currency (for example, US Dollar, Euro) associated with the sales order.
currencysymbolStringFalseNoThe symbol representing the order’s currency, such as $, €, or £, used in UI display.
customercodeStringFalseNoAn internal or external customer identifier used for EDI, integration, or ERP reference purposes.
customformStringFalseNoThe custom entry form used to create or view the sales order, which may control field visibility and layout.
debitcardissuenoStringFalseNoOptional field for the issue number found on some debit cards, particularly used in international payment processing.
deferredrevenueDecimalFalseNoThe portion of the sales total that is recognized as deferred revenue, often associated with subscription or milestone-based revenue.
departmentStringFalseNoThe department responsible for the transaction, typically used in organizational reporting and cost allocation.
discountitemStringFalseNoThe specific discount item applied to the sales order, which may correspond to a promotional rule or pricing strategy.
discountrateStringFalseNoThe rate or percentage applied to the order as a discount, either manually entered or system-generated.
discounttotalDecimalFalseNoThe total monetary value of all discounts applied to the sales order, deducted from the subtotal.
draccountStringFalseNoRevenue deferral account used when revenue recognition is delayed or managed separately from billing.
dynamicdescriptorStringFalseNoA custom transaction descriptor sent to the customer’s credit card statement via the payment processor, used for branding or transparency.
emailStringFalseNoEmail address used for sending order confirmations, receipts, or other customer-facing communication related to the order.
enddateDateFalseNoThe end date of the transaction period, typically used in recurring orders or service-related sales.
entityStringFalseNoThe customer entity associated with the sales order, typically linked to CRM and billing records.
entitynexusStringFalseNoNexus location used for tax calculation, based on the customer’s location and tax jurisdiction.
entitytaxregnumStringFalseNoTax registration number assigned to the customer, used for VAT or GST compliance in certain regions.
estgrossprofitDecimalFalseNoThe estimated gross profit for the order, calculated as estimated revenue minus estimated costs of goods sold.
estgrossprofitpercentStringFalseNoThe estimated gross profit percentage, giving insight into the expected margin for the order.
exchangerateDecimalFalseNoThe exchange rate used to convert the sales order’s currency to the base or reporting currency.
excludecommissionBooleanFalseNoIf the value is 'true', this sales order is excluded from commission calculations, typically for internal use or adjustments.
externalidStringFalseNoAn external system reference ID, often used in integrations or when syncing records between platforms.
fobStringFalseNoFree on Board (FOB) term that defines when and where ownership of goods transfers, impacting shipping responsibilities and accounting.
forinvoicegroupingBooleanFalseNoIf the value is 'true', this order is eligible to be grouped with others on a single invoice under certain billing rules.
fxaccountStringFalseNoForeign exchange account reference, used when tracking multi-currency transactions and gains/losses.
getauthBooleanFalseNoIf the value is 'true', the system will attempt to obtain payment authorization automatically during order processing.
giftcertappliedDecimalFalseNoThe amount of the order total that is covered by gift certificate redemption.
handlingcostDecimalFalseNoThe total handling fee applied to the order, separate from shipping costs, often used for packaging, insurance, or special logistics.
handlingmodeStringFalseNoThe method or logic used to calculate handling charges, such as flat rate, per item, or based on order total.
handlingtax1rateStringFalseNoThe tax rate applied to the handling fee under the primary tax rule or jurisdiction.
handlingtaxcodeStringFalseNoThe tax code that governs how handling charges are taxed, linked to local or international compliance rules.
ignoreavsBooleanFalseNoIf the value is 'true', the order will bypass AVS checks during credit card authorization, typically for internal testing or override scenarios.
ignorecscBooleanFalseNoIf the value is 'true', the system ignores CVV/CVC validation during payment processing.
inputauthcodeStringFalseNoThe authorization code manually input for the credit card transaction, used when overriding automated processing.
inputpnrefnumStringFalseNoThe processor reference number manually entered for a credit card transaction, typically used in reconciliations.
inputreferencecodeStringFalseNoCustom reference code entered by the user for linking the transaction to an external system or internal process.
intercostatusStringFalseNoThe current status of intercompany processing for the order, such as pending, approved, or completed.
intercotransactionStringFalseNoReference to the related intercompany transaction generated from this order, used for cross-subsidiary processing.
isbasecurrencyBooleanFalseNoIf the value is 'true', this order uses the base currency of the company rather than a foreign or subsidiary-specific currency.
isdefaultshippingrequestStringFalseNoIndicates whether this order follows the default shipping request profile set for the customer or location.
ismultishiptoBooleanFalseNoIf the value is 'true', the order contains line items shipping to multiple addresses, requiring complex fulfillment logic.
ispurchasecardStringFalseNoIndicates whether a purchasing card (P-Card) is used for this transaction, often for business or government clients.
isrecurringpaymentBooleanFalseNoIf the value is 'true', this order is part of a recurring payment arrangement, such as a subscription or installment plan.
istaxableBooleanFalseNoIf the value is 'true', taxes are applicable to the transaction based on item and customer tax status.
lastmodifieddateDatetimeFalseNoThe date and time of the most recent update to the sales order, used for audit trails and data sync.
leadsourceStringFalseNoThe source of the lead that generated this order, useful for marketing attribution or sales funnel analysis.
linkedtrackingnumbersStringFalseNoComma-separated list of shipment tracking numbers associated with this order, used for fulfillment tracking.
locationStringFalseNoThe physical location or warehouse responsible for fulfilling this sales order, impacting inventory and tax logic.
memoStringFalseNoAn internal note or message attached to the order, not visible to customers but used by staff for context or workflow.
messageStringFalseNoA customer-facing message displayed on invoices or emails, such as thank-you notes or custom terms.
messageselStringFalseNoA predefined message selection used to populate the message field quickly based on standard communication templates.
muccpromocodeinstanceStringFalseNoThe internal reference to a Multi-Use Coupon Code (MUCC) applied to this order for discount tracking.
nextbillDateFalseNoThe next billing date for recurring transactions associated with this sales order.
nexusStringFalseNoRepresents the tax jurisdiction for the order based on the shipping or selling location, critical for compliance.
onetimeDecimalFalseNoOne-time charge amount applied to the order, separate from recurring fees or standard items.
opportunityStringFalseNoReference to the CRM opportunity record that led to this sales order, used for pipeline and conversion tracking.
orderstatusStringFalseNoCurrent status of the order in the workflow, such as Pending Approval, Partially Fulfilled, or Billed.
ordertypeStringFalseNoThe classification of the order type, such as Standard, Drop Ship, or Intercompany Transfer.
otherrefnumStringFalseNoAn external reference number (such as PO Number) provided by the customer to help identify this transaction.
outputauthcodeStringFalseNoThe authorization code returned by the payment processor after a credit card transaction is processed, stored for reference.
outputreferencecodeStringFalseNoCustom code returned or generated after payment processing, used for linking to external payment systems.
overrideholdBooleanFalseNoIf the value is 'true', manually overrides any hold placed on the order due to credit, fraud, or payment validation issues.
overrideholdcheckedBooleanFalseNoIf the value is 'true', indicates that the override hold checkbox was manually selected in the UI to release the order from hold.
overrideshippingcostDoubleFalseNoA manually entered shipping amount that overrides calculated shipping costs, often used for special arrangements or adjustments.
partnerStringFalseNoThe partner record linked to the order, typically used for partner commission calculations or sales channel tracking.
paymentcardcscStringFalseNoThe CVV/CVC security code value submitted with the card payment, used to help verify card ownership.
paymenteventdateDatetimeFalseNoThe date and time of the most recent payment-related event on the order, such as authorization, capture, or decline.
paymenteventholdreasonStringFalseNoExplains why the payment is currently on hold, such as address mismatch, insufficient funds, or processor rules.
paymenteventpurchasedatasentStringFalseNoIndicates whether purchase data (such as item breakdown or tax) was successfully sent to the payment gateway for Level 2/3 processing.
paymenteventresultStringFalseNoDescribes the outcome of the latest payment attempt, such as Approved, Declined, or Error.
paymenteventtypeStringFalseNoType of payment event processed, such as Authorization, Capture, Refund, or Void.
paymenteventupdatedbyStringFalseNoIdentifies the user or system process that last updated the payment event on the sales order.
paymentmethodStringFalseNoThe method used for payment, such as Credit Card, PayPal, Invoice, or Wire Transfer.
paymentoperationStringFalseNoDescribes the type of payment operation performed, such as 'Sale', 'Authorization Only', or 'Capture'.
paymentoptionStringFalseNoSpecifies a predefined or customer-specific payment option selected for this sales order.
paymentprocessingprofileStringFalseNoReferences the payment processing configuration profile that controls rules, gateway, and behavior for the order.
paypalauthidStringFalseNoThe authorization ID returned from PayPal for this transaction, used for status tracking and potential refunds.
paypalprocessBooleanFalseNoIf the value is 'true', the order is being processed through PayPal rather than a traditional credit card gateway.
paypalstatusStringFalseNoCurrent status of the PayPal transaction, such as Authorized, Captured, or Canceled.
paypaltranidStringFalseNoThe transaction ID assigned by PayPal for this payment, used for reconciliation and refund purposes.
pnrefnumStringFalseNoReference number generated by the payment processor to uniquely identify the transaction for tracking and audit.
promocodeStringFalseNoPromotional code applied by the customer or system to trigger discounts, free items, or loyalty rewards.
promocodepluginimplStringFalseNoInternal reference to the plugin implementation logic that handles the application of promotion codes.
recognizedrevenueDecimalFalseNoRevenue that has already been recognized from this sales order under the revenue recognition rules or schedule.
recurannuallyDecimalFalseNoThe amount that recurs annually as part of a recurring billing setup related to this order.
recurmonthlyDecimalFalseNoThe monthly recurring charge associated with this sales order, typical for subscriptions or service plans.
recurquarterlyDecimalFalseNoThe quarterly recurring billing amount if the sales order involves installment or subscription plans billed every 3 months.
recurweeklyDecimalFalseNoAmount that recurs weekly under a recurring billing arrangement linked to this order.
returntrackingnumbersStringFalseNoTracking numbers provided for returned shipments associated with this order, separated by commas if multiple.
revcommitstatusStringFalseNoRevenue commitment status for the order, indicating whether revenue is recognized, pending, or deferred.
revenuestatusStringFalseNoDisplays the current revenue status, such as Not Recognized, In Progress, or Fully Recognized.
revreconrevcommitmentBooleanFalseNoIf the value is 'true', revenue recognition is based on committed revenue events rather than billing or fulfillment.
saleseffectivedateDateFalseNoThe effective sales date, which may differ from the order creation date, and is used for reporting, forecasting, or revenue recognition.
salesgroupStringFalseNoThe sales group or team responsible for this order, often used for internal sales reporting and commission tracking.
salesrepStringFalseNoThe individual sales representative assigned to the order, used for sales performance metrics and commission calculation.
shipaddressStringFalseNoThe formatted shipping address for the sales order, typically displayed on printed or emailed documents.
shipaddresslistStringFalseNoReferences the customer's saved list of shipping addresses, indicating which one was selected for this order.
shipcompleteBooleanFalseNoIf the value is 'true', all items on the order must be shipped together; if 'false', partial shipments are allowed.
shipdateDateFalseNoThe scheduled or actual ship date for the order, used in fulfillment planning and delivery tracking.
shipisresidentialStringFalseNoIndicates whether the shipping destination is a residential address, which may affect delivery method or surcharge.
shipmethodStringFalseNoThe selected shipping method (for example, FedEx Ground, UPS Next Day) used to fulfill the order.
shipoverrideStringFalseNoIf present, indicates that standard shipping rules have been manually overridden for this transaction.
shippingaddressStringFalseNoThe full shipping address associated with the order, including all formatted fields.
shippingcostDecimalFalseNoTotal cost of shipping charged on the sales order, before any discounts or overrides are applied.
shippingcostoverriddenStringFalseNoIndicates whether the calculated shipping cost was manually overridden, and if so, how.
shippingtax1rateStringFalseNoThe primary tax rate applied to the shipping portion of the sales order, based on applicable tax rules.
shippingtaxcodeStringFalseNoThe tax code used to determine the taxable status and calculation method for the shipping charge.
softdescriptorStringFalseNoA short custom description that appears on the customer’s credit card statement, typically identifying the business or product.
sourceStringFalseNoThe origin of the order, such as web, phone, in-store, or API, useful for marketing attribution and operational routing.
startdateDateFalseNoThe start date of the order cycle, used for recurring billing or service fulfillment timelines.
statusStringFalseNoThe current lifecycle status of the sales order, such as Pending Approval, Fulfilled, or Billed.
statusRefStringFalseNoInternal system reference to the sales order's status, often used in scripting or integrations.
subsidiaryStringFalseNoThe subsidiary responsible for the transaction, relevant in multi-entity NetSuite environments for accounting and compliance.
subsidiarytaxregnumStringFalseNoTax registration number specific to the subsidiary involved in the order, used for regional tax reporting.
subtotalDecimalFalseNoThe total cost of all line items before taxes, discounts, shipping, and other charges are applied.
syncpartnerteamsBooleanFalseNoIf the value is 'true', partner team records are synchronized with this order for accurate reporting and commission tracking.
syncsalesteamsBooleanFalseNoIf the value is 'true', the sales team assigned to the order is synchronized with CRM or reporting tools.
taxdetailsoverrideBooleanFalseNoIf the value is 'true', tax details on the order have been manually modified instead of being auto-calculated.
taxitemStringFalseNoThe tax item or tax code applied to the order, determining how taxes are calculated and posted.
taxpointdateDateFalseNoThe date used to determine when tax becomes applicable, which may differ from the order or invoice date depending on jurisdiction.
taxpointdateoverrideBooleanFalseNoIf the value is 'true', the standard tax point date has been manually overridden to support specific compliance needs.
taxrateDoubleFalseNoThe total effective tax rate applied to the order, calculated based on item and location-level tax rules.
taxregoverrideBooleanFalseNoIf the value is 'true', the standard tax registration rules have been bypassed or overridden for this transaction.
taxtotalDecimalFalseNoThe total amount of tax charged on the order, calculated based on tax codes, items, shipping, and jurisdiction.
termsStringFalseNoThe payment terms assigned to the sales order, such as Net 30 or Due on Receipt, affecting billing and collections.
threedstatuscodeStringFalseNoThe 3D Secure status code returned from the card issuer during payment authentication, used for fraud prevention tracking.
tobeemailedBooleanFalseNoIf the value is 'true', the sales order is flagged to be emailed to the customer during order processing or billing.
tobefaxedBooleanFalseNoIf the value is 'true', the sales order is flagged to be faxed to the customer using integrated communication tools.
tobeprintedBooleanFalseNoIf the value is 'true', the order is marked for printing, typically as part of a batch print or fulfillment process.
totalDecimalFalseNoThe grand total amount for the sales order, including all items, taxes, discounts, handling, and shipping.
totalcostestimateDecimalFalseNoThe total estimated cost associated with fulfilling the sales order, used for profit margin analysis.
trandateDateFalseNoThe transaction date assigned to the order, which may be used in accounting periods and revenue recognition schedules.
tranidStringFalseNoThe unique identifier for the sales order, typically displayed as the order number in the user interface.
tranisvsoebundleBooleanFalseNoIf the value is 'true', the transaction involves a Vendor-Specific Objective Evidence (VSOE) bundle, affecting revenue recognition rules.
unbilledordersDecimalFalseNoRepresents the portion of the order total that has not yet been billed, useful for tracking open revenue.
validfromStringFalseNoThe date from which the sales order or pricing becomes valid, often used in price agreements or promotions.
vsoeautocalcBooleanFalseNoIf the value is 'true', VSOE amounts and allocations are automatically calculated for this transaction.

Return to Top

salesOrderBillingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoInternal reference key used to associate the billing address with the corresponding sales order record.
addr1StringFalseNoThe first line of the billing street address, typically used for street number and name.
addr2StringFalseNoThe second line of the billing address, often used for suite, apartment, or building information.
addr3StringFalseNoThe third line of the billing address, used when additional address detail is required.
addresseeStringFalseNoThe name of the individual or entity receiving the invoice or billing document.
attentionStringFalseNoThe specific contact person or department the invoice should be directed to, within the addressee organization.
cityStringFalseNoThe city associated with the billing address.
countryStringFalseNoThe country where the billing address is located, used for tax, shipping, and compliance logic.
dropdownstateStringFalseNoThe selected state or province as defined in a dropdown list of regions, typically tied to the chosen country.
overrideBooleanFalseNoIf the value is 'true', the billing address on this order overrides the default billing address saved on the customer record.
stateStringFalseNoThe state or province associated with the billing address, displayed for clarity and postal validation.

Return to Top

salesOrdered 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account associated with the transaction line, used for financial posting and categorization.
amountDecimalFalseNoThe total amount on the transaction line, including tax and discounts where applicable.
amountnetDecimalFalseNoThe net amount on the line item, excluding taxes or additional charges.
classStringFalseNoThe class segmentation value applied to the transaction, often used for departmental or regional reporting.
costestimateDecimalFalseNoThe estimated cost of fulfilling the line item, used for profit margin and forecast analysis.
departmentStringFalseNoThe department associated with the sale, typically used for internal reporting and financial structuring.
employeeStringFalseNoThe sales representative responsible for the transaction, used in sales tracking and commission calculations.
entityStringFalseNoThe customer or entity placing the order, linked to the transaction for billing and reporting.
estgrossprofitDecimalFalseNoThe estimated gross profit on the transaction line, calculated as revenue minus estimated cost.
estgrossprofitpercentDoubleFalseNoThe estimated gross profit as a percentage of revenue, used to assess margin performance.
itemStringFalseNoThe item or Stock Keeping Unit (SKU) being sold on this transaction line.
itemcountDoubleFalseNoThe quantity of the item ordered on this transaction line.
locationStringFalseNoThe physical location or warehouse associated with the transaction, affecting inventory allocation and tax.
memoStringFalseNoAn optional internal note attached to the transaction line, visible only to users with access.
partnerStringFalseNoThe partner associated with the transaction, used for tracking partner sales and calculating partner commissions.
subsidiaryStringFalseNoThe subsidiary under which the transaction is recorded, relevant in multi-entity NetSuite environments.
trandateDateFalseNoThe date of the transaction, used for accounting, period close, and reporting.
tranlineStringFalseNoThe identifier for the specific transaction line, used to reference line-level data within the broader transaction.
transactionStringFalseNoThe overarching transaction record (such as a sales order or invoice) that this line belongs to.
typeStringFalseNoThe type of transaction this line is part of, such as Sales Order, Invoice, or Credit Memo.

Return to Top

salesOrderGiftCertRedemption 

NameTypeReadOnlyReferencesFilterOnlyDescription
authcodeStringFalseNoThe unique code of the gift certificate used for redemption on the sales order.
authcodeappliedDecimalFalseNoThe amount from the gift certificate that was applied toward the total balance of the sales order.

Return to Top

salesOrderItemShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoInternal reference key used to link the shipping address with a specific item on the sales order.
addr1StringFalseNoThe first line of the item's shipping address, typically containing the street number and name.
addr2StringFalseNoThe second line of the item's shipping address, often used for apartment, suite, or unit information.
addr3StringFalseNoThe third line of the item's shipping address, used for additional address details if needed.
addresseeStringFalseNoThe name of the recipient for the item at this shipping address.
attentionStringFalseNoThe individual or department the package should be directed to at the destination.
cityStringFalseNoThe city portion of the item's shipping address.
countryStringFalseNoThe country to which the item is being shipped, used for fulfillment and tax determination.
dropdownstateStringFalseNoThe selected state or province value from a predefined list, based on the country.
overrideBooleanFalseNoIf the value is 'true', this shipping address overrides the customer’s default address for the item on this order.
stateStringFalseNoThe full state or province name used in the shipping address for regional clarity.

Return to Top

salesOrderLinkedTrackingNumberMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
trackingnumberStringFalseNoThe shipment tracking number associated with the sales order, used to trace delivery status through carriers such as UPS, FedEx, or USPS.

Return to Top

salesOrderPartner 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage of credit or commission assigned to the partner for this sales order.
isprimaryBooleanFalseNoIf the value is 'true', this partner is designated as the primary partner for the sales order and receives priority credit.
partnerStringFalseNoThe partner entity associated with the sales order, typically involved in originating or facilitating the sale.
partnerroleStringFalseNoThe role assigned to the partner on this order, such as Reseller or Referral, used for commission and reporting purposes.

Return to Top

salesOrderSalesTeam 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage of the sales credit assigned to the employee for this order, used in sales performance and commission reporting.
employeeStringFalseNoThe sales team member associated with the order, typically a salesperson or account executive.
isprimaryBooleanFalseNoIf the value is 'true', this employee is designated as the primary sales representative for the order.
salesroleStringFalseNoThe role of the sales team member on this order, such as Account Manager or Sales Support, used for tracking and reporting responsibilities.

Return to Top

salesOrderShipGroup 

NameTypeReadOnlyReferencesFilterOnlyDescription
destinationaddressStringFalseNoThe 'Ship To' address for this shipping group, indicating where the items in the group are being delivered.
docStringFalseNoInternal reference to the sales order or shipping document associated with this shipping group.
handlingrateDecimalFalseNoThe handling charge applied to this shipping group, used to offset packaging or manual processing costs.
shippingmethodStringFalseNoThe selected shipping method (such as FedEx Ground or UPS 2nd Day Air) used for this group of items.
shippingrateDecimalFalseNoThe shipping cost applied to this group of items based on the selected shipping method.
sourceaddressStringFalseNoThe 'Ship From' address, typically representing the warehouse or fulfillment location for this shipping group.
uniquekeyIntegerFalseNoA system-generated unique identifier for the shipping group, used to differentiate multiple groups within a single order.

Return to Top

salesOrderShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoInternal reference key that links this shipping address to the corresponding sales order record.
addr1StringFalseNoThe first line of the shipping address, typically used for street number and name.
addr2StringFalseNoThe second line of the shipping address, commonly used for suite, apartment, or unit number.
addr3StringFalseNoThe third line of the shipping address, used for additional address details if required.
addresseeStringFalseNoThe name of the recipient at the shipping address.
attentionStringFalseNoThe specific individual or department that should receive attention at the shipping address.
cityStringFalseNoThe city portion of the shipping address.
countryStringFalseNoThe country for the shipping address, used for determining tax, shipping rules, and compliance.
dropdownstateStringFalseNoThe selected state or province value from a predefined list, based on the selected country.
overrideBooleanFalseNoIf the value is 'true', this address overrides the default shipping address on the customer record.
stateStringFalseNoThe full name of the state or province included in the shipping address.

Return to Top

salesOrderTranPromotion 

NameTypeReadOnlyReferencesFilterOnlyDescription
couponcodeStringFalseNoThe coupon code entered on the sales order, typically used to apply a discount or promotional offer.
promocodeStringFalseNoThe internal promotion record applied to the sales order, which may define eligibility, discount structure, and usage rules.
promotiontypeStringFalseNoThe type of promotion being applied, such as item-level discount, shipping discount, or order-level incentive.

Return to Top

salesrole 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoA brief description of the sales role, typically outlining the responsibilities or function of the role within the sales team.
externalidStringFalseNoAn external identifier for the sales role, used to link with external systems or custom integrations.
isinactiveBooleanFalseNoIf the value is 'true', this sales role is inactive and no longer available for assignment to employees or transactions.
issalesrepBooleanFalseNoIf the value is 'true', this role is flagged as a sales representative role and is eligible for commission and sales credit.
nameStringFalseNoThe display name of the sales role, used throughout the system in dropdowns, reports, and transaction records.

Return to Top

salestaxitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal system ID for the sales tax item, used to uniquely identify the tax item record.
descriptionStringFalseNoA brief description of the sales tax item, such as the tax jurisdiction or purpose of the tax.
isinactiveBooleanFalseNoIf the value is 'true', this sales tax item is inactive and cannot be selected on transactions.

Return to Top

scheduledscript 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal system ID for the scheduled script record, used for referencing and managing the script.
defaultfunctionStringFalseNoThe default entry point function within the script that is executed when the script runs.
descriptionStringFalseNoA summary or explanation of the scheduled script’s purpose and functionality.
externalidStringFalseNoAn external identifier used for integrations or referencing the scheduled script outside of NetSuite.
isinactiveBooleanFalseNoIf the value is 'true', the scheduled script is inactive and will not be executed by the system scheduler.
nameStringFalseNoThe user-defined name of the scheduled script, used to identify it in the NetSuite UI.
notifyadminsBooleanFalseNoIf the value is 'true', administrators will receive notifications related to the script's execution status.
notifyemailsStringFalseNoA comma-separated list of email addresses to notify about the script’s execution results or errors.
notifygroupStringFalseNoThe internal ID of an employee group that should receive notifications regarding this script.
notifyownerBooleanFalseNoIf the value is 'true', the script owner will be notified about execution results and errors.
ownerStringFalseNoThe user or role that owns the scheduled script and is responsible for its maintenance.
scriptfileStringFalseNoThe file path to the script source file in the NetSuite File Cabinet.
scriptidStringFalseNoThe internal script ID used to reference the script in deployments or programmatically.
scripttypeStringFalseNoThe type of script (such as scheduled, user event, or client), defining when and how it is triggered.

Return to Top

scheduledscriptinstance 

NameTypeReadOnlyReferencesFilterOnlyDescription
datecreatedDatetimeFalseNoThe timestamp indicating when this scheduled script instance was created in the system.
enddateDatetimeFalseNoThe timestamp marking when the script instance completed its execution.
formuladateDatetimeFalseNoA calculated date value associated with the script instance, typically used for custom logic or filtering.
formulanumericDoubleFalseNoA calculated numeric value derived from the script's execution, used for custom reporting or tracking.
formulatextStringFalseNoA calculated text value derived from the script's context, often used for logging or tagging purposes.
percentcompleteDoubleFalseNoThe percentage of the scheduled script's execution that has been completed at the time of query.
queueStringFalseNoThe script queue to which this instance was assigned, used to manage concurrent processing in NetSuite.
startdateDatetimeFalseNoThe timestamp marking when the script instance started execution.
statusStringFalseNoThe current execution status of the script instance, such as Pending, Processing, Complete, or Failed.

Return to Top

schedulingMethod 

NameTypeReadOnlyReferencesFilterOnlyDescription
defaultnameStringFalseNoThe system-defined default name for the scheduling method, used when a custom name is not specified.
inactiveBooleanFalseNoIf the value is 'true', this scheduling method is inactive and cannot be selected for new transactions or records.
keyStringFalseNoA unique identifier for the scheduling method used internally by the system.
nameStringFalseNoThe display name of the scheduling method, used in forms, reports, and selection lists.

Return to Top

scriptButton 

NameTypeReadOnlyReferencesFilterOnlyDescription
buttonfunctionStringFalseNoThe name of the script function that is triggered when the custom button is clicked in the NetSuite user interface (UI).
buttonlabelStringFalseNoThe label displayed on the custom button in the NetSuite UI, representing its action or purpose.
ownerStringFalseNoThe user or role responsible for managing the script button and its associated functionality.

Return to Top

scriptdeployment 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal system ID of the script deployment, used to uniquely identify this deployment instance.
allemployeesBooleanFalseNoIf the value is 'true', the script is deployed and accessible to all employees regardless of role or department.
allpartnersBooleanFalseNoIf the value is 'true', the script is deployed and accessible to all partner records.
allrolesBooleanFalseNoIf the value is 'true', the script is accessible to all user roles without restriction.
auddepartmentStringFalseNoThe specific department for which this script deployment is visible or accessible.
audemployeeStringFalseNoThe specific employee to whom the script deployment is assigned or restricted.
audgroupStringFalseNoThe employee group that has permission to access or execute the script.
audpartnerStringFalseNoThe partner to whom this script deployment applies, if restricted to a specific partner.
audslctroleStringFalseNoThe user role selected for this deployment, restricting access to users with this role.
audsubsidiaryStringFalseNoThe subsidiary to which the script deployment is scoped, if NetSuite OneWorld is enabled.
externalidStringFalseNoAn optional external identifier used to reference the deployment in integrations or custom workflows.
externalurlStringFalseNoThe external Uniform Resource Locator (URL) at which this script can be accessed, if applicable to Suitelet or RESTlet scripts.
isdeployedBooleanFalseNoIf the value is 'true', the script is currently deployed and active in the environment.
isonlineBooleanFalseNoIf the value is 'true', the script is accessible via public link or external systems, depending on script type.
loglevelStringFalseNoThe logging level set for the deployment, such as DEBUG or ERROR, which determines the verbosity of logs generated during execution.
recurrenceminutesStringFalseNoThe interval, in minutes, at which the script runs if it is scheduled with a recurring frequency.
scriptStringFalseNoThe internal reference to the script being deployed, linking this deployment to a script record.
scriptidStringFalseNoThe unique identifier assigned to the script deployment, used in scripting and Application Programming Interface (API) references.
starttimeStringFalseNoThe start time configured for the script execution, relevant for scheduled or timed deployments.
statusStringFalseNoThe current status of the script deployment, such as Not Scheduled, Scheduled, or Processing.
titleStringFalseNoThe title of the deployment, which appears in the User Interface (UI) and helps identify the purpose of this script deployment.
urlStringFalseNoThe internal URL where this script deployment is available, typically used for Suitelets or RESTlets.

Return to Top

scriptEventType 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoThe identifier of the script event type, representing a specific trigger point within NetSuite's scripting framework (such as beforeLoad, beforeSubmit, or afterSubmit).

Return to Top

scriptExecutionContextMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
executioncontextStringFalseNoThe execution context in which the script is running, such as 'userinterface', 'webservices', or 'scheduled'. This helps determine how and when the script was triggered.

Return to Top

scriptExecutionContextMapClient 

NameTypeReadOnlyReferencesFilterOnlyDescription
executioncontextStringFalseNoThe execution context for client-side scripts, indicating how the script was triggered in the NetSuite UI (such as 'userinterface' or 'csvimport'). This helps determine behavior and logging for client-side events.

Return to Top

scriptExecutionContextMapUserEvent 

NameTypeReadOnlyReferencesFilterOnlyDescription
executioncontextStringFalseNoThe execution context for user event scripts, specifying the source of the event that triggered the script (such as 'userinterface', 'webservices', or 'csvimport'). This helps control logic execution based on the origin of the action.

Return to Top

scriptFieldType 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoThe identifier representing the type of field used in NetSuite scripting (such as 'text', 'date', or 'currency'). This determines the expected data type and behavior of the field within custom scripts.

Return to Top

scriptLocalizationContextMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
localizationcontextStringFalseNoSpecifies the localization context in which a script is executed, such as a specific language or regional setting. This ensures that scripts behave appropriately based on the user’s locale.

Return to Top

scriptLocalizationContextMapClient 

NameTypeReadOnlyReferencesFilterOnlyDescription
localizationcontextStringFalseNoSpecifies the localization context for client-side scripts, indicating the user's language or regional settings. This allows the script to adapt its behavior or display text accordingly.

Return to Top

scriptMethods 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique identifier for the script method record, used internally by the system.
descriptionStringFalseNoA summary of what the script method does or how it is intended to be used.
methodStringFalseNoThe name of the method or function that can be called within a script, representing a specific operation or task.
ownerStringFalseNoThe user or role responsible for maintaining or having created the script method.

Return to Top

scriptNoteType 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoThe name or identifier of the note type associated with a script, used to categorize or label notes for reference within custom scripting logic.

Return to Top

scriptPortletType 

NameTypeReadOnlyReferencesFilterOnlyDescription
skeyStringFalseNoThe identifier of the portlet type used in a scripted portlet, such as 'list', 'form', or 'inline HTML'. This defines how the content will be displayed on the NetSuite dashboard.

Return to Top

scriptStatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoThe identifier representing the current status of a script, such as 'Not Scheduled', 'Processing', or 'Complete'. This helps track the execution lifecycle of the script.

Return to Top

scriptType 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoThe identifier representing the type of script in NetSuite, such as 'Scheduled', 'User Event', 'Client', or 'Suitelet'. This defines how and when the script is executed within the platform.

Return to Top

scriptVersion 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoThe identifier representing the version of the script. This helps track revisions and ensures the correct version is used during script execution or deployment.

Return to Top

searchCampaign 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe internal system ID used to uniquely identify the search campaign record.
audienceStringFalseNoThe targeted audience segment for the search campaign, such as a customer group or demographic profile.
basecostDecimalFalseNoThe foundational cost of running the search campaign before additional variables are applied.
campaignidStringFalseNoThe unique identifier of the search campaign used for internal tracking or integration purposes.
categoryStringFalseNoThe category or classification assigned to the campaign, used to organize and report on campaign types.
convcostpercustomerDecimalFalseNoThe cost per customer who made a purchase as a result of the campaign.
conversionsIntegerFalseNoThe number of customers who made a purchase due to the campaign.
costDecimalFalseNoThe total cost incurred for executing the campaign, including all related expenses.
costpercustomerDecimalFalseNoThe cost associated with acquiring each new lead or potential customer through the campaign.
enddateDateFalseNoThe date when the campaign officially ends or stops generating results.
expectedrevenueDecimalFalseNoThe projected income or revenue anticipated from running the campaign.
externalidStringFalseNoAn optional external reference ID used for integration or reporting outside of NetSuite.
familyStringFalseNoThe campaign family, used to group campaigns under a shared initiative or strategic goal.
isdefaultleadsourceBooleanFalseNoIf the value is 'true', this campaign is designated as the default lead source for incoming leads.
isinactiveBooleanFalseNoIf the value is 'true', the campaign is inactive and not currently in use.
issalescampaignBooleanFalseNoIf the value is 'true', the campaign is focused specifically on sales rather than general brand awareness.
itemStringFalseNoThe product or service item associated with the campaign, used for attribution and performance tracking.
keywordStringFalseNoThe search engine keyword or phrase targeted by this campaign for visibility or advertisement placement.
leadsgeneratedIntegerFalseNoThe number of potential customers acquired through the campaign.
messageStringFalseNoA description of the campaign message or creative content used in search ads or listings.
offerStringFalseNoThe promotional offer tied to the campaign, such as a discount, limited-time deal, or bundle.
ownerStringFalseNoThe campaign manager responsible for planning and overseeing campaign execution and results.
ownerroleStringFalseNoThe NetSuite role assigned to the campaign manager, which can determine permissions and visibility.
profitDecimalFalseNoThe net profit generated by the campaign after subtracting total costs from revenue.
promotioncodeStringFalseNoThe specific promotion or discount code linked to the campaign.
roiDoubleFalseNoThe return on investment (ROI) of the campaign, calculated as (Profit ÷ Cost) × 100.
searchengineStringFalseNoThe search engine used for running the campaign, such as Google, Bing, or Yahoo.
startdateDateFalseNoThe date when the campaign began generating traffic or customer activity.
titleStringFalseNoThe internal name or title of the campaign used for tracking and reporting.
totalrevenueDecimalFalseNoThe total revenue earned directly from the campaign.
uniquevisitorsIntegerFalseNoThe number of individual visitors who interacted with the campaign content.

Return to Top

searchCampaignItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
campaignStringFalseNoReferences the associated search campaign record. This links the item to the campaign it is part of for reporting and performance tracking purposes.

Return to Top

sentEmail 

NameTypeReadOnlyReferencesFilterOnlyDescription
bccrecipientsStringFalseNoThe list of email addresses that received the message as blind carbon copy (BCC) recipients.
bodyStringFalseNoThe full content of the email message body, including any plain text or HTML formatting.
ccrecipientsStringFalseNoThe list of email addresses that received the message as carbon copy (CC) recipients.
dkimalignmentokBooleanFalseNoIf the value is 'true', the DomainKeys Identified Mail (DKIM) alignment check passed for the email.
dkimrecordStringFalseNoThe DKIM record used to validate the sender's identity through Domain Name System (DNS)-based email authentication.
dkimsignatureokBooleanFalseNoIf the value is 'true', the DKIM signature was successfully verified and matched the expected domain.
dmarccompliantBooleanFalseNoIf the value is 'true', the message complies with the sender’s Domain-based Message Authentication, Reporting and Conformance (DMARC) policy.
dmarcrecordStringFalseNoThe DMARC record retrieved and used during message validation.
emailmessageidStringFalseNoThe unique identifier of the email message, often used for threading or reference.
enveloperecipientsStringFalseNoThe final recipients of the message as recorded in the Simple Mail Transfer Protocol (SMTP) envelope.
failurereasonStringFalseNoDescribes the reason the email failed to send, if applicable.
hostnameStringFalseNoThe hostname of the server involved in sending the email.
keyIntegerFalseNoThe internal system ID used to uniquely identify the email record.
logdateDateFalseNoThe date when the email sending event was logged in the system.
machineStringFalseNoThe server or processing machine used to send or handle the email.
mailingidStringFalseNoThe unique ID used to group or track mass email mailings or campaigns.
messageidStringFalseNoThe globally unique identifier assigned to the email, typically set in the 'Message-ID' header.
netsuiteheaderStringFalseNoCustom header information added by NetSuite to the outgoing email for tracking or processing.
originalenveloperecipientsStringFalseNoThe original list of SMTP envelope recipients before any changes or redirection.
replytoStringFalseNoThe email address that will receive replies to this message, as specified in the 'Reply-To' header.
sentdateDateFalseNoThe date the message was successfully sent.
spfokBooleanFalseNoIf the value is 'true', the message passed Sender Policy Framework (SPF) validation, confirming the sender was authorized.
statusStringFalseNoThe final delivery status of the message, such as 'Sent', 'Failed', or 'Bounced'.
subjectStringFalseNoThe subject line of the email message.
torecipientsStringFalseNoThe list of primary recipient email addresses included in the 'To' field.

Return to Top

sentemailrecipient 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique identifier for the sent email recipient record. Often used internally to track the recipient entry.
keyIntegerFalseNoThe internal system ID that uniquely identifies the email event this recipient is associated with.
recipientStringFalseNoThe email address of the individual who received the message.

Return to Top

serializedassemblyitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
alternatedemandsourceitemStringFalseNoSpecifies an alternate item to be used as the source of demand in planning processes, particularly for Material Requirements Planning (MRP).
assetaccountStringFalseNoThe general ledger account used to track the value of this item as an asset on the balance sheet.
atpmethodStringFalseNoDefines the Available to Promise (ATP) calculation method used to determine item availability based on current supply and demand.
auctionquantityStringFalseNoThe quantity of the item available in an online auction listing, used in eCommerce integrations.
auctiontypeStringFalseNoSpecifies the type of auction, such as fixed price or reserve price, used when listing the item for sale online.
autoleadtimeBooleanFalseNoIf the value is 'true', the lead time for the item is calculated automatically based on historical data. If the value is 'false', lead time must be set manually.
autopreferredstocklevelBooleanFalseNoIf the value is 'true', the system automatically determines the preferred stock level based on usage patterns. If the value is 'false', it must be entered manually.
autoreorderpointBooleanFalseNoIf the value is 'true', the reorder point is calculated automatically based on demand. If the value is 'false', it must be set manually.
availabletopartnersBooleanFalseNoIf the value is 'true', this item is visible and available for business partners (such as resellers or distributors) in their portals. If the value is 'false', it is not.
averagecostDecimalFalseNoThe average cost of the item based on historical purchase or production data, used in inventory valuation.
billexchratevarianceacctStringFalseNoThe account used to track variances caused by fluctuations in exchange rates for vendor bills related to this item.
billingscheduleStringFalseNoThe billing schedule applied to the item, which defines how and when revenue is recognized or invoices are generated.
billpricevarianceacctStringFalseNoThe account used to record differences between expected and actual prices on vendor bills for this item.
billqtyvarianceacctStringFalseNoThe account used to record quantity differences between received goods and vendor bills for this item.
buildentireassemblyBooleanFalseNoIf the value is 'true', the entire assembly must be built before it is available. If the value is 'false', partial builds may be allowed.
buildtimeDoubleFalseNoEstimated time, in hours or minutes, required to fully assemble this item.
buildtimelotsizeDoubleFalseNoDefines the lot size used to calculate the build time. Larger lot sizes may reduce per-unit build time due to economies of scale.
buyitnowpriceDecimalFalseNoThe fixed price for 'Buy It Now' functionality in online marketplaces such as eBay.
classStringFalseNoThe classification or category assigned to this item for internal reporting and segmentation purposes.
cogsaccountStringFalseNoThe Cost of Goods Sold (COGS) account associated with this item, used when recording inventory expense.
conditionenabledStringFalseNoSpecifies whether item conditions (such as new, refurbished, or used) are enabled for this item.
conditionhelpurlStringFalseNoA Uniform Resource Locator (URL) that links to help content explaining the condition options for this item on the web store.
consumptionunitStringFalseNoUnit of measure used to record the consumption of this item, particularly for planning or usage tracking.
copydescriptionBooleanFalseNoIf the value is 'true', the item description is automatically copied to transactions. If the value is 'false', it must be entered manually.
costDecimalFalseNoThe base cost assigned to the item, which may be used in pricing and margin calculations.
costcategoryStringFalseNoThe cost category used to group and report item costs, such as labor, material, or overhead.
costestimateDecimalFalseNoEstimated cost to produce or acquire the item, often used in planning and quoting.
costestimatetypeStringFalseNoIndicates the method used to derive the cost estimate, such as standard, average, or last purchase price.
costingmethodStringFalseNoSpecifies the inventory costing method applied to the item, such as FIFO (First In First Out), LIFO (Last In First Out), or average.
costingmethoddisplayStringFalseNoThe user-friendly display name for the costing method shown in UI and reports.
costunitsStringFalseNoThe unit of measure used when expressing the cost of the item (for example, per unit, per dozen).
countryofmanufactureStringFalseNoIndicates the country where the item was manufactured, used for compliance, customs, and reporting purposes.
createddateDatetimeFalseNoThe date and time when the item record was initially created in the system.
createrevenueplansonStringFalseNoSpecifies the trigger for generating a revenue recognition plan for this item, such as at billing or fulfillment.
currencyStringFalseNoThe default currency associated with this item for pricing and cost calculations.
customformStringFalseNoReferences the custom form used to capture item details, enabling tailored data entry interfaces.
custreturnvarianceaccountStringFalseNoThe general ledger account used to track financial variances arising from customer returns of this item.
defaultrevisionStringFalseNoThe default Bill of Materials (BOM) revision associated with the item for manufacturing or planning processes.
deferredrevenueaccountStringFalseNoThe account used to hold revenue for this item until it is recognized based on revenue rules or fulfillment events.
deferrevrecBooleanFalseNoIf the value is 'true', revenue recognition for this item is deferred. If the value is 'false', revenue is recognized immediately upon invoicing.
demandmodifierStringFalseNoA planning factor applied to adjust the demand forecast for this item, useful for seasonal or promotional adjustments.
demandtimefenceIntegerFalseNoDefines the number of days into the future for which demand is considered in supply planning calculations.
departmentStringFalseNoSpecifies the internal department responsible for this item, often used for cost tracking and reporting.
descriptionStringFalseNoA detailed text description of the item, used in transactions, catalogs, and web store listings.
directrevenuepostingBooleanFalseNoIf the value is 'true', revenue from this item posts directly to the general ledger. If the value is 'false', it follows deferred revenue rules.
displayinebaystoreBooleanFalseNoIf the value is 'true', the item is displayed in your integrated eBay store listings. If the value is 'false', it is excluded.
displaynameStringFalseNoThe name shown in user interfaces and reports to represent this item, distinct from the internal item ID.
distributioncategoryStringFalseNoA custom grouping used to classify the item within a specific distribution or fulfillment framework.
distributionnetworkStringFalseNoSpecifies the network of fulfillment or distribution centers where this item is stored or distributed.
dontshowpriceBooleanFalseNoIf the value is 'true', the item price is hidden on web store listings. If the value is 'false', the price is displayed publicly.
dropshipexpenseaccountStringFalseNoThe expense account used to record costs associated with drop-shipped orders for this item.
ebayhandlingtimeStringFalseNoIndicates the handling time (in days) required to prepare this item for shipment in eBay listings.
ebayintlinsurancefeeDecimalFalseNoThe international insurance fee applied when shipping this item via eBay's international programs.
ebayintlpackagehandlingfeeDecimalFalseNoThe handling fee charged for packaging this item for international shipping via eBay.
ebayintlshipinsuranceStringFalseNoSpecifies whether international shipping insurance is enabled for this item when sold on eBay.
ebayintlshippingitem1StringFalseNoPrimary international shipping method configured for this item in eBay listings.
ebayintlshippingitem2StringFalseNoSecondary international shipping method available for this item in eBay listings.
ebayintlshippingitem3StringFalseNoTertiary international shipping method option listed for this item in eBay.
ebayisintlcalculatedrateStringFalseNoIndicates whether the international shipping rate is calculated automatically in eBay based on location and weight.
ebayisirregularpackageBooleanFalseNoIf the value is 'true', the item is considered irregularly shaped or oversized for eBay shipping calculations. If the value is 'false', it is treated as standard packaging.
ebayitemdescriptionStringFalseNoThe description used in eBay item listings to inform buyers about the product.
ebayitemlocdisplayStringFalseNoSpecifies how the item’s location appears in eBay listings, such as a city or region name.
ebayitemloczipcodeStringFalseNoThe ZIP code displayed on eBay listings indicating where the item is located for shipping and buyer reference.
ebayitemlotsIntegerFalseNoSpecifies the quantity of items included in a single lot for eBay listings, commonly used for bulk or bundled sales.
ebayitemsubtitleStringFalseNoA secondary title displayed in eBay listings that provides additional marketing or descriptive information.
ebayitemtitleStringFalseNoThe main title of the item as shown in eBay listings; should be concise and keyword-rich for search optimization.
ebayitemweightamtStringFalseNoSpecifies the weight of the item for eBay listings, used to calculate shipping charges based on item mass.
ebaylayoutStringFalseNoThe layout template applied to the item’s eBay listing, controlling its visual structure and arrangement of elements.
ebaypackagetypeStringFalseNoDescribes the type of packaging used for this item in eBay listings, such as envelope, box, or oversized packaging.
ebaypagecounterStringFalseNoDetermines whether a page view counter is displayed in eBay listings to show how many people have viewed the item.
ebayrelistingoptionStringFalseNoDefines the behavior for automatically relisting the item on eBay when it doesn’t sell or after expiration.
ebaythemeStringFalseNoThe visual theme applied to the eBay listing to influence color schemes and branding.
ebaythemegroupStringFalseNoA grouping of related eBay themes, often used for organizing branding or template sets within eBay integration.
effectivebomcontrolStringFalseNoIndicates how BOM versions are controlled for the item, such as through date effectiveness or revisions.
endauctionswhenoutofstockBooleanFalseNoIf the value is 'true', the item’s eBay auction will automatically end when inventory reaches zero. If the value is 'false', the auction remains active regardless of stock.
enforceminqtyinternallyBooleanFalseNoIf the value is 'true', internal systems will prevent inventory actions that violate the minimum quantity rule. If the value is 'false', the enforcement is disabled.
excludefromsitemapBooleanFalseNoIf the value is 'true', the item will not be included in the website's sitemap. If the value is 'false', it will be indexed for search engine optimization.
externalidStringFalseNoA unique external identifier for the item, typically used for integrations with external systems or third-party platforms.
featureddescriptionStringFalseNoA short promotional description of the item, used to highlight its key features in marketing or on product listing pages.
fixedbuildtimeDoubleFalseNoRepresents the fixed time (in minutes or hours) required to assemble the item, regardless of the quantity being built.
froogleproductfeedStringFalseNoIndicates the product feed configuration for Froogle (Google Shopping), used to sync item data with Google’s merchant listings.
futurehorizonStringFalseNoDefines the planning horizon for this item in demand and supply forecasting—how far ahead the system looks when creating plans.
gainlossaccountStringFalseNoThe general ledger account used to post gains or losses due to inventory revaluation or transaction differences for this item.
galleryBooleanFalseNoIf the value is 'true', the item is listed in an eBay gallery view with a photo thumbnail. If the value is 'false', it will not appear in gallery format.
galleryfeaturedBooleanFalseNoIf the value is 'true', the item is prioritized as a featured product in the eBay gallery. If the value is 'false', it displays normally.
gifttypeexpressshipBooleanFalseNoIf the value is 'true', the item is available with an express shipping option for gifts. If the value is 'false', this option is not offered.
gifttypegiftwrapBooleanFalseNoIf the value is 'true', the item is eligible for gift wrapping services. If the value is 'false', gift wrapping is not available.
gifttypeshiptorecipientBooleanFalseNoIf the value is 'true', the item can be shipped directly to the gift recipient. If the value is 'false', shipping to the buyer is required.
handlingcostDecimalFalseNoThe base handling fee charged when fulfilling an order for this item, excluding shipping costs.
handlingcostunitsStringFalseNoSpecifies the unit type used to calculate handling cost, such as per item, per weight, or per shipment.
handlinggroupStringFalseNoIndicates the group or classification used to apply specific handling logic or rules to the item during fulfillment.
imagesgroupStringFalseNoThe image group assigned to the item for organizing visual assets, such as thumbnails, swatches, or banners.
imageslocationStringFalseNoSpecifies the file path or URL where images for this item are stored, typically used for external hosting or CDN integration.
includechildrenBooleanFalseNoIf the value is 'true', the item will inherit settings or behaviors from its parent item or category. If the value is 'false', it functions independently.
incomeaccountStringFalseNoSpecifies the general ledger income account used to record revenue generated from the sale of this item.
intercocogsaccountStringFalseNoIndicates the COGS account used specifically for intercompany transactions.
intercoincomeaccountStringFalseNoSpecifies the income account used for intercompany sales revenue, typically part of internal financial reporting.
internalidIntegerFalseNoThe system-generated unique identifier for the item, used internally for referencing the record across the platform.
iscalculatedrateStringFalseNoDefines whether the rate for this item is calculated dynamically, such as using formulas or pricing rules.
isdonationitemBooleanFalseNoIf the value is 'true', the item is marked as a donation item, often used in fundraising scenarios. If the value is 'false', it is treated as a regular inventory item.
isdropshipitemBooleanFalseNoIf the value is 'true', the item is fulfilled directly by a vendor through drop shipping. If the value is 'false', it is fulfilled from internal inventory.
isgcocompliantBooleanFalseNoIf the value is 'true', the item complies with Generally Compliant Objects (GCO) or related product compliance standards. If the value is 'false', the item has no such certification.
isinactiveBooleanFalseNoIf the value is 'true', the item is inactive and cannot be used in transactions. If the value is 'false', the item is active and available.
isonlineBooleanFalseNoIf the value is 'true', the item is published and visible in online channels such as web stores. If the value is 'false', the item is hidden from online listings.
isphantomBooleanFalseNoIf the value is 'true', the item is a phantom assembly, meaning it’s used for planning and grouping but not built physically. If the value is 'false', the item follows regular build processes.
isspecialorderitemBooleanFalseNoIf the value is 'true', the item is flagged as a special order, typically procured only upon customer request. If the value is 'false', it is treated as a standard item.
isspecialworkorderitemBooleanFalseNoIf the value is 'true', the item requires a special work order for production. If the value is 'false', it follows regular production workflows.
isstorepickupallowedBooleanFalseNoIf the value is 'true', customers can select store pickup as a fulfillment method for this item. If the value is 'false', this option is not available.
issueproductStringFalseNoReferences the product associated with an issue or warranty policy, often used for serialized or returnable goods.
itemconditionStringFalseNoDescribes the physical condition of the item (for example, new, refurbished, used), which can affect pricing and listing rules.
itemhandlingfeeDecimalFalseNoSpecifies a fixed handling fee applied per unit of the item, in addition to standard shipping costs.
itemidStringFalseNoThe identifier or Stock Keeping Unit (SKU) used to uniquely distinguish this item in the inventory system.
iteminsurancefeeDecimalFalseNoRepresents the insurance cost per unit of the item, typically charged when additional shipping protection is selected.
itemnumberoptionsStringFalseNoLists the item number configuration options, such as variations by color or size, used in matrix items or custom products.
itemoptionsStringFalseNoSpecifies selectable item options available to customers at checkout, such as personalization, size, or bundle selections.
itemprocessfamilyStringFalseNoGroups items by similar manufacturing or handling processes, used for production planning and reporting.
itemprocessgroupStringFalseNoFurther categorizes items by operational or workflow similarities, often used in assembly or service delivery.
itemrevenuecategoryStringFalseNoDefines the revenue category used for recognition purposes, aligning item sales with financial reporting standards.
itemshipinsuranceStringFalseNoSpecifies whether insurance is available or required for shipping this item, based on item value or category.
itemtypeStringFalseNoIndicates the type of item, such as inventory item, assembly, service, non-inventory, or kit, determining its behavior in transactions.
lastmodifieddateDatetimeFalseNoThe date and time the item record was last updated, used for audit and synchronization purposes.
lastpurchasepriceDecimalFalseNoRepresents the most recent purchase price paid for the item, which can influence cost estimation and vendor negotiations.
leadtimeIntegerFalseNoThe expected number of days required to procure or produce the item from the time it is ordered.
listimmediateStringFalseNoSpecifies whether the item is immediately listed on a sales channel (for example, web store) upon creation or update.
listingdurationStringFalseNoSpecifies the duration of time the item will remain listed for sale on e-commerce platforms, such as eBay.
listingstartdateDateFalseNoIndicates the calendar date when the item listing becomes active on external sales channels.
listingstarttimeStringFalseNoSpecifies the time of day when the item listing becomes active, often used in timed campaigns or auctions.
locationStringFalseNoDenotes the physical location or warehouse where the item is stored, relevant for fulfillment and inventory tracking.
manufacturerStringFalseNoThe name of the company or entity that produces or assembles the item.
manufactureraddr1StringFalseNoFirst line of the manufacturer's address, typically containing the street address or PO box.
manufacturercityStringFalseNoThe city where the manufacturer is located, used for compliance, logistics, or customs.
manufacturerstateStringFalseNoThe state or province of the manufacturer, used for regional tracking and documentation.
manufacturertariffStringFalseNoThe tariff code assigned by the manufacturer for customs and international trade classification.
manufacturertaxidStringFalseNoThe tax identification number of the manufacturer, used for tax reporting and invoicing.
manufacturerzipStringFalseNoThe ZIP or postal code of the manufacturer's address, used for geographic validation and shipping estimates.
matchbilltoreceiptBooleanFalseNoIf the value is 'true', the item requires the bill to be matched to the receipt before processing payment. If the value is 'false', matching is not enforced.
matrixitemnametemplateStringFalseNoTemplate used to generate display names for matrix items based on options like size and color.
maxdonationamountDecimalFalseNoSpecifies the maximum amount that can be accepted or recorded as a donation for this item.
maximumquantityStringFalseNoDefines the maximum number of units that can be ordered or shipped per transaction.
metataghtmlStringFalseNoHTML content used in the meta tag for SEO (Search Engine Optimization) purposes in online listings.
minimumquantityStringFalseNoIndicates the minimum number of units that can be ordered, often used to enforce order thresholds.
minimumquantityunitsStringFalseNoSpecifies the units (for example, pieces, boxes) in which the minimum quantity is defined.
mpnStringFalseNoManufacturer Part Number (MPN), used for identifying items across vendors and suppliers.
multmanufactureaddrBooleanFalseNoIf the value is 'true', the item supports multiple manufacturing addresses. If the value is 'false', only a single address is used.
nextagcategoryStringFalseNoThe category under which the item is listed in the Nextag comparison shopping platform.
nextagproductfeedStringFalseNoProduct feed configuration for Nextag, determining how the item is published to that platform.
nopricemessageStringFalseNoMessage displayed to users when pricing is unavailable, such as 'Contact us for pricing' or 'Price on request.'
numactivelistingsIntegerFalseNoThe number of active listings for this item currently published on supported sales channels.
numcurrentlylistedIntegerFalseNoIndicates how many instances of the item are currently listed across marketplaces.
offersupportBooleanFalseNoIf the value is 'true', support or after-sales service is offered with the purchase of the item. If the value is 'false', no support is provided.
outofstockbehaviorStringFalseNoDefines how the system handles the item when it is out of stock, such as hiding the item or allowing backorders.
outofstockmessageStringFalseNoThe message shown to users when the item is out of stock, such as 'Currently unavailable' or 'Back in stock soon.'
overallquantitypricingtypeStringFalseNoSpecifies the pricing structure used based on total quantity, such as volume discounts or tiered pricing.
packageheightStringFalseNoThe height of the package used for this item, used in dimensional shipping calculations.
packagelengthStringFalseNoThe length of the package used for this item, important for logistics and carrier pricing.
packagewidthStringFalseNoThe width of the item's packaging, used for dimensional shipping calculations and logistics planning.
pagetitleStringFalseNoCustom HTML page title used in search engine results and browser tabs for the item's online listing.
parentStringFalseNoReferences the parent item for this variant, typically used in matrix or grouped item configurations.
planningitemcategoryStringFalseNoSpecifies the item category used in supply planning and demand forecasting scenarios.
preferencecriterionStringFalseNoDefines the criteria that determine item preferences in sourcing or fulfillment processes.
preferredlocationStringFalseNoIndicates the default warehouse or inventory location where the item is expected to be stocked or fulfilled from.
preferredstockleveldaysDoubleFalseNoSpecifies the number of days of supply considered optimal for this item at the preferred location.
pricinggroupStringFalseNoIdentifies the customer pricing group associated with this item, used for applying group-specific discounts or pricing.
primarycatdisplaynameStringFalseNoThe display name of the primary category assigned to this item in online store navigation.
primarycategoryIntegerFalseNoThe internal ID of the primary category to which the item is assigned in web store taxonomy.
printitemsBooleanFalseNoIf the value is 'true', the item is included when printing forms like packing slips or sales orders. If the value is 'false', the item is not printed.
prodpricevarianceacctStringFalseNoThe general ledger account used to track variances between expected and actual production costs due to price differences.
prodqtyvarianceacctStringFalseNoThe account used to record quantity-based variances in production, such as material overuse or waste.
producerBooleanFalseNoIf the value is 'true', indicates that the business acts as the producer or manufacturer of the item. If the value is 'false', the item is sourced externally.
productfeedStringFalseNoSpecifies the external product feed (such as Google Shopping or Amazon) where the item is published for marketing or sales.
purchasedescriptionStringFalseNoDescriptive text used on purchase documents to describe the item to vendors or procurement teams.
purchaseorderamountStringFalseNoRepresents the monetary value specified on purchase orders for this item.
purchaseorderquantityStringFalseNoThe quantity of the item specified in purchase orders, typically used for procurement planning.
purchaseorderquantitydiffStringFalseNoDisplays the difference between the ordered and received quantities for the item on purchase orders.
purchasepricevarianceacctStringFalseNoThe general ledger account used to record variances between expected and actual purchase prices.
purchaseunitStringFalseNoDefines the unit of measure used when purchasing this item, such as 'box', 'dozen', or 'each'.
quantitypricingscheduleStringFalseNoReferences the pricing schedule that adjusts the item's unit price based on purchase or sale quantity thresholds.
quantityreorderunitsStringFalseNoSpecifies the unit of measure used when reordering the item, typically aligned with vendor packaging standards.
receiptamountStringFalseNoThe monetary value associated with the received quantity of the item, often used in receiving and billing.
receiptquantityStringFalseNoThe quantity of the item received, tracked during the goods receipt process.
receiptquantitydiffStringFalseNoDisplays the difference between expected and actual received quantities, helpful for inventory reconciliation.
refundgivenasStringFalseNoSpecifies how refunds for this item are issued, such as credit, cash, or replacement.
relateditemsdescriptionStringFalseNoMarketing or cross-sell description that explains related items or recommended accessories.
reordermultipleStringFalseNoIndicates the quantity increment in which the item must be reordered, typically aligned with vendor packaging.
rescheduleindaysIntegerFalseNoDefines how many days an order line can be rescheduled earlier during planning adjustments.
rescheduleoutdaysIntegerFalseNoDefines how many days an order line can be pushed out or delayed in scheduling processes.
reservepriceDecimalFalseNoThe minimum price required to successfully sell the item in an auction listing. If bids do not meet this price, the item will not be sold.
returnpolicyStringFalseNoSpecifies the general return policy applicable to the item, such as 'No Returns' or '30-Day Returns'.
returnpolicydetailsStringFalseNoProvides additional text describing the return policy, such as restocking fees, conditions for returns, or return instructions.
returnshippingpaidbyStringFalseNoIndicates whether the buyer or the seller is responsible for paying the return shipping cost.
returnswithinStringFalseNoDefines the allowable time frame within which the item can be returned, such as '30 Days' or '60 Days'.
revenueallocationgroupStringFalseNoReferences the revenue allocation group used to manage revenue distribution across items or components in bundled sales.
revenuerecognitionruleStringFalseNoSpecifies the rule used to determine when and how revenue for this item is recognized according to accounting standards.
revrecforecastruleStringFalseNoIndicates the revenue forecast rule that governs expected revenue timing, particularly for subscription or installment-based sales.
revrecscheduleStringFalseNoReferences the revenue recognition schedule that outlines the specific time periods and amounts for recognizing revenue for this item.
safetystocklevelDoubleFalseNoThe quantity of the item that should be maintained in inventory at all times to prevent stockouts due to demand spikes or delays.
safetystockleveldaysIntegerFalseNoThe number of days' worth of inventory to maintain as safety stock based on forecasted demand and lead time.
safetystocklevelunitsStringFalseNoThe unit of measure (such as 'Each' or 'Case') used to express the safety stock level.
saleunitStringFalseNoSpecifies the unit of measure used when selling the item, which may differ from purchasing or stocking units.
schedulebcodeStringFalseNoThe Schedule B classification code used for exporting goods from the United States, required for customs documentation.
schedulebnumberStringFalseNoThe numeric portion of the Schedule B code used for trade compliance reporting.
schedulebquantityStringFalseNoThe unit of quantity required for Schedule B reporting, such as 'Kilograms' or 'Liters'.
scrapacctStringFalseNoThe general ledger account used to record the cost of scrapped or unusable inventory for this item.
searchkeywordsStringFalseNoComma-separated list of keywords used to improve the item's visibility in search results on web stores or marketplaces.
seasonaldemandBooleanFalseNoIf the value is 'true', indicates that the item experiences fluctuations in demand during specific times of year. If the value is 'false', demand is considered stable year-round.
secondarycatdisplaynameStringFalseNoThe display name of the secondary category under which the item is listed on a web store or catalog.
secondarycategoryIntegerFalseNoThe internal ID of the secondary category used to classify the item for online browsing and sorting.
sellonebayBooleanFalseNoIf the value is 'true', the item is listed for sale on eBay. If the value is 'false', it is not available through eBay listings.
shipasiaBooleanFalseNoIf the value is 'true', the item is eligible for shipping to countries in Asia. If the value is 'false', shipping to Asia is disabled.
shipaustraliaBooleanFalseNoIf the value is 'true', the item can be shipped to Australia. If the value is 'false', the item cannot be shipped there.
shipcanadaBooleanFalseNoIf the value is 'true', the item is available for shipment to Canada. If the value is 'false', shipping to Canada is not permitted.
shipeuropeBooleanFalseNoIf the value is 'true', the item is available for shipping to European countries. If the value is 'false', shipping to Europe is disabled.
shipgermanyBooleanFalseNoIf the value is 'true', the item can be shipped to Germany. If the value is 'false', shipping to Germany is restricted.
shipindividuallyBooleanFalseNoIf the value is 'true', the item must be shipped separately from other items in the same order due to packaging or handling constraints. If the value is 'false', it can be shipped with other items.
shipjapanBooleanFalseNoIf the value is 'true', the item is eligible for shipment to Japan. If the value is 'false', it is not allowed for shipping there.
shipmexicoBooleanFalseNoIf the value is 'true', the item can be shipped to Mexico. If the value is 'false', it is restricted from shipping to Mexico.
shipnorthsouthamericaBooleanFalseNoIf the value is 'true', the item is allowed to ship to countries in North and South America. If the value is 'false', it is excluded from those regions.
shippackageStringFalseNoSpecifies the packaging type or container used when shipping the item, such as a box, envelope, or custom packaging.
shippingcostDecimalFalseNoThe base cost charged to the customer for shipping this item, excluding taxes or surcharges.
shippingcostunitsStringFalseNoThe unit of measure for the shipping cost, typically aligned with the item’s unit (such as per item or per package).
shippingdomesticmethodsgroupStringFalseNoReferences a predefined group of domestic shipping methods available for this item, used to simplify shipping rule assignments.
shippingdomgroupStringFalseNoIdentifies the group of domestic shipping options configured for this item, often tied to regions or zones.
shippingintlgroupStringFalseNoSpecifies the set of international shipping methods allowed for this item, applied across all export destinations.
shippingintlgroup1StringFalseNoThe first tier or category of international shipping options available for this item, usually region-specific.
shippingintlgroup2StringFalseNoThe second category of international shipping methods available for this item, allowing further customization by country or service level.
shippingintlgroup3StringFalseNoThe third group of international shipping options, providing additional control over how the item is shipped globally.
shippingitem1StringFalseNoSpecifies the first shipping method or carrier assigned to this item for use in rate calculation and delivery preferences.
shippingitem2StringFalseNoDefines an alternate shipping method that can be used if the primary method is unavailable or not preferred.
shippingitem3StringFalseNoSpecifies a third fallback shipping method available for delivering the item under certain conditions.
shippinglocationsgroupStringFalseNoIndicates the group of fulfillment or shipping locations authorized to ship this item, used for inventory routing.
shippingpackaginggroupStringFalseNoDefines the group of packaging types or standards associated with this item, used to optimize packing logic.
shippingrate1DecimalFalseNoThe first tiered shipping rate assigned to this item, often tied to quantity breaks or shipping zones.
shippingrate2DecimalFalseNoA secondary tiered shipping rate, used when multiple pricing rules apply for shipping based on destination or method.
shippingrate3DecimalFalseNoThe third shipping rate tier, useful for offering more granular control over total shipping charges.
shipukBooleanFalseNoIf the value is 'true', the item is eligible for shipping to the United Kingdom. If the value is 'false', it is restricted from being shipped there.
shipworldwideBooleanFalseNoIf the value is 'true', the item can be shipped to any international destination. If the value is 'false', international shipping is limited or disabled.
shoppingdotcomcategoryStringFalseNoThe category under which the item is listed on the Shopping.com platform, used for marketing and product feed classification.
shoppingproductfeedStringFalseNoIdentifies the product feed configuration used for exporting item data to Shopping.com for external advertising.
shopzillacategoryidIntegerFalseNoThe internal ID of the item's category on the Shopzilla marketplace, used to align the product with the correct taxonomy.
shopzillaproductfeedStringFalseNoDefines the product feed assigned to export this item to Shopzilla for inclusion in comparison shopping listings.
showasgiftBooleanFalseNoIf the value is 'true', the item is displayed with a 'Gift' label on storefronts or checkout pages. If the value is 'false', it is not marketed as a gift.
showdefaultdonationamountBooleanFalseNoIf the value is 'true', a default donation amount is pre-selected for this item. If the value is 'false', the donation field is left empty.
sitemappriorityStringFalseNoDefines the priority level of the item in the website sitemap, used to influence search engine crawling and indexing frequency.
softdescriptorStringFalseNoSpecifies the soft descriptor text shown on customer credit card statements, helping identify the merchant or item purpose.
standardimagesStringFalseNoReferences standard product images used across the web store or marketplaces to visually represent the item.
startingpriceDecimalFalseNoThe initial price for listing the item in auction-style or tiered pricing formats, such as on eBay.
stockdescriptionStringFalseNoA brief internal or external description of the item’s inventory characteristics, condition, or special notes.
stockunitStringFalseNoThe unit of measure used for tracking the item in inventory, such as 'Each', 'Case', or 'Dozen'.
storecatdisplaynameStringFalseNoThe display name of the item's primary store category, shown to customers on the e-commerce storefront.
storecatdisplayname2StringFalseNoThe display name of the item's secondary store category, allowing additional classification in the store hierarchy.
storecategoryIntegerFalseNoThe internal ID referencing the item's primary category within the web store.
storecategory2IntegerFalseNoThe internal ID referencing the item's secondary category within the web store.
storedescriptionStringFalseNoA brief marketing description of the item shown on the store’s product listing page.
storedetaileddescriptionStringFalseNoA longer, formatted HTML description that provides in-depth product information for display on the product detail page.
storedisplayimageStringFalseNoThe main image file used to represent the item visually in online listings and catalog views.
storedisplaynameStringFalseNoThe name of the item as displayed on the storefront, typically more user-friendly than the internal name.
storedisplaythumbnailStringFalseNoThe thumbnail image of the item used in smaller views, such as product carousels or search results.
storeitemtemplateStringFalseNoSpecifies the website item template applied when rendering the item’s product page.
subsidiaryStringFalseNoIdentifies the subsidiary that owns or manages this item, relevant in multi-entity NetSuite deployments.
supersizeimagesBooleanFalseNoIf the value is 'true', the item allows high-resolution images to be displayed in a zoomable format. If the value is 'false', standard resolution applies.
supplyreplenishmentmethodStringFalseNoThe method used to restock this item, such as purchasing, manufacturing, or transferring inventory.
supplytimefenceIntegerFalseNoDefines the number of days into the future to consider supply planning, limiting how far demand triggers replenishment actions.
taxableBooleanFalseNoIf the value is 'true', the item is subject to sales tax calculations. If the value is 'false', the item is exempt from tax.
taxscheduleStringFalseNoThe tax schedule that determines how tax is calculated for the item across different regions and jurisdictions.
templatesgroupStringFalseNoReferences a group of templates used for presenting or printing item data, such as labels, invoices, or listings.
totalvalueDecimalFalseNoThe total inventory value of this item, calculated as cost multiplied by quantity on hand.
tracklandedcostBooleanFalseNoIf the value is 'true', the item tracks landed costs, such as shipping, customs, and insurance. If the value is 'false', these are excluded from cost calculations.
transferpriceDecimalFalseNoThe price used when transferring this item between subsidiaries or locations for intercompany transactions.
transferpriceunitsStringFalseNoThe unit of measure associated with the transfer price, such as 'Each' or 'Pound'.
unbuildvarianceaccountStringFalseNoThe general ledger account used to record cost differences that occur when disassembling items.
unitstypeStringFalseNoReferences the set of units (for example, 'Each', 'Box', 'Carton') that the item can be transacted in.
upccodeStringFalseNoThe Universal Product Code (UPC) assigned to this item for barcode scanning and product identification.
urlcomponentStringFalseNoThe URL fragment used to construct the product page’s web address, often based on item name or SKU.
usebinsBooleanFalseNoIf the value is 'true', the item participates in bin management within the warehouse. If the value is 'false', bin tracking is not used.
usemarginalratesBooleanFalseNoIf the value is 'true', tax is calculated using marginal tax rates. If the value is 'false', standard rates are used.
vendornameStringFalseNoThe default vendor or supplier name associated with the item, used for purchasing and reporting.
vendreturnvarianceaccountStringFalseNoSpecifies the account to track cost differences resulting from vendor returns.
vsoedeferralStringFalseNoDetermines how revenue for this item is deferred under Vendor-Specific Objective Evidence (VSOE) accounting rules.
vsoedeliveredBooleanFalseNoIf the value is 'true', the item is marked as delivered for VSOE revenue recognition. If the value is 'false', delivery is pending.
vsoepermitdiscountStringFalseNoDefines the allowed discount treatment under VSOE guidelines for this item.
vsoepriceDecimalFalseNoThe VSOE price used in revenue allocation calculations.
vsoesopgroupStringFalseNoGroups the item for VSOE purposes to determine how items are bundled and evaluated for revenue allocation.
weightDoubleFalseNoThe physical weight of the item, typically used for shipping calculations.
weightunitStringFalseNoThe unit of measure for the item's weight, such as 'Pounds' or 'Kilograms'.
weightunitsStringFalseNoAlternate field specifying available units for weight, relevant for multi-unit tracking.
willshipStringFalseNoIndicates whether the item is available for shipping and under what conditions (for example, 'Always', 'Sometimes').
wipacctStringFalseNoThe Work-in-Process (WIP) account used to track costs while the item is being manufactured.
wipvarianceacctStringFalseNoThe account used to capture cost differences during the production process.
yahooproductfeedStringFalseNoDefines the product feed configuration for publishing this item to Yahoo Shopping or related marketplaces.

Return to Top

serializedinventoryitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
alternatedemandsourceitemStringFalseNoSpecifies an alternative item that can be used to fulfill demand if the primary item is unavailable.
assetaccountStringFalseNoThe general ledger account used to track the asset value of this inventory item.
atpmethodStringFalseNoIndicates the Available to Promise (ATP) calculation method used for this item.
auctionquantityStringFalseNoDefines the quantity of items available for auction sales.
auctiontypeStringFalseNoSpecifies the type of auction associated with this item, such as regular or fixed-price.
autoleadtimeBooleanFalseNoIf the value is 'true', lead time is automatically calculated based on historical receipt data.
autopreferredstocklevelBooleanFalseNoIf the value is 'true', the preferred stock level is automatically derived from sales or demand history.
autoreorderpointBooleanFalseNoIf the value is 'true', the reorder point is automatically calculated based on item usage trends.
availabletopartnersBooleanFalseNoIf the value is 'true', this item is available to business partners through the partner center.
averagecostDecimalFalseNoRepresents the average cost per unit of the item based on purchase and inventory data.
billexchratevarianceacctStringFalseNoSpecifies the account used to track variances due to billing exchange rate differences.
billingscheduleStringFalseNoThe billing schedule associated with the item for managing installment or recurring charges.
billpricevarianceacctStringFalseNoAccount used to record variances between billed price and expected item cost.
billqtyvarianceacctStringFalseNoAccount used to capture differences between billed and received item quantities.
buyitnowpriceDecimalFalseNoThe price at which the item can be purchased immediately in an auction setting, bypassing bidding.
classStringFalseNoThe classification category used to group and filter this item, often for reporting purposes.
cogsaccountStringFalseNoThe Cost of Goods Sold (COGS) account used to track costs when the item is sold.
conditionenabledStringFalseNoEnables condition-based configuration for the item, allowing for custom business rules.
conditionhelpurlStringFalseNoA URL linking to help or documentation related to item condition settings.
consumptionunitStringFalseNoThe unit of measure used when this item is consumed during manufacturing or other processes.
conversionrateStringFalseNoThe conversion rate used between stock units and alternate units of measure for the item.
copydescriptionBooleanFalseNoIf the value is 'true', the description is automatically copied from the base item to variants or matrix items.
costDecimalFalseNoThe current per-unit cost of the item based on procurement or manufacturing inputs.
costcategoryStringFalseNoThe category assigned to this item for cost tracking and reporting purposes.
costestimateDecimalFalseNoAn estimated cost per unit used in forecasts or planning scenarios.
costestimatetypeStringFalseNoSpecifies the method used to derive the cost estimate, such as average, last purchase, or standard.
costingmethodStringFalseNoDefines the cost calculation method used for this item, such as FIFO, LIFO, or Average.
costingmethoddisplayStringFalseNoDisplays a user-friendly label for the costing method used.
costunitsStringFalseNoThe unit of measure used to express item cost, such as per dozen or per kilogram.
countryofmanufactureStringFalseNoThe country where this item is manufactured, relevant for compliance or customs documentation.
createddateDatetimeFalseNoThe date and time when this inventory item record was originally created.
createrevenueplansonStringFalseNoDetermines the rule or condition under which a revenue recognition plan is created for this item.
currencyStringFalseNoSpecifies the currency in which the item's prices and costs are recorded.
customformStringFalseNoIdentifies the custom form used for displaying and managing this item in the UI.
custreturnvarianceaccountStringFalseNoThe account used to record differences in value when customers return serialized inventory items.
deferredrevenueaccountStringFalseNoThe general ledger account where deferred revenue for this item is posted until it is recognized.
deferrevrecBooleanFalseNoIf the value is 'true', revenue recognition for this item is delayed based on defined recognition rules.
demandmodifierStringFalseNoUsed to adjust the calculated demand for this item in planning and forecasting calculations.
demandtimefenceIntegerFalseNoThe time fence (in days) during which demand planning considers incoming demand for this item.
departmentStringFalseNoThe department associated with the item, typically used for reporting or segmentation.
directrevenuepostingBooleanFalseNoIf the value is 'true', revenue from this item is posted directly to the general ledger, bypassing recognition rules.
displayinebaystoreBooleanFalseNoIf the value is 'true', this item is displayed in the associated eBay store listings.
displaynameStringFalseNoA user-friendly or marketing-friendly name used to display the item across sales channels.
distributioncategoryStringFalseNoThe category used to classify the item for distribution planning and fulfillment logic.
distributionnetworkStringFalseNoSpecifies the distribution network or channel used to move and deliver this item.
dontshowpriceBooleanFalseNoIf the value is 'true', the item’s price is hidden from customer-facing views such as web stores.
dropshipexpenseaccountStringFalseNoAccount used to track expenses related to drop-shipping this item from third-party vendors.
ebayhandlingtimeStringFalseNoSpecifies the handling time commitment for eBay listings, which affects estimated delivery times.
ebayintlinsurancefeeDecimalFalseNoThe international shipping insurance fee applied to this item when sold on eBay.
ebayintlpackagehandlingfeeDecimalFalseNoThe international package handling fee applied to this item when shipped via eBay.
ebayintlshipinsuranceStringFalseNoIndicates whether international shipping insurance is applied to this eBay item.
ebayintlshippingitem1StringFalseNoThe first international shipping option configured for this item in eBay.
ebayintlshippingitem2StringFalseNoThe second international shipping option configured for this item in eBay.
ebayintlshippingitem3StringFalseNoThe third international shipping option configured for this item in eBay.
ebayisintlcalculatedrateStringFalseNoSpecifies whether international shipping rates are automatically calculated for this eBay item.
ebayisirregularpackageBooleanFalseNoIf the value is 'true', the item is considered an irregular package for eBay shipping purposes.
ebayitemdescriptionStringFalseNoA custom description of the item used specifically for eBay listings.
ebayitemlocdisplayStringFalseNoText used to display the item’s location in eBay listings.
ebayitemloczipcodeStringFalseNoZIP or postal code of the item’s shipping location as shown in the eBay listing.
ebayitemlotsIntegerFalseNoSpecifies the number of units per lot if this item is sold in bundles on eBay.
ebayitemsubtitleStringFalseNoAn optional subtitle shown in eBay listings to supplement the main title.
ebayitemtitleStringFalseNoThe main title of the item as it appears in eBay listings.
ebayitemweightamtStringFalseNoSpecifies the item's weight for eBay listings, typically used for shipping cost calculation.
ebaylayoutStringFalseNoDetermines the layout template used when displaying the item on eBay.
ebaypackagetypeStringFalseNoIndicates the packaging type used for eBay shipping, such as box, envelope, or custom.
ebaypagecounterStringFalseNoDisplays a counter on the eBay listing page showing how many views the item has received.
ebayrelistingoptionStringFalseNoSpecifies the automated relisting behavior for expired or unsold eBay items.
ebaythemeStringFalseNoThe eBay listing theme applied to this item for branding and styling purposes.
ebaythemegroupStringFalseNoA grouping of eBay themes used to apply consistent visual styles across listings.
enablecatchweightBooleanFalseNoIf the value is 'true', allows for catch weight functionality where the actual weight may vary from the standard unit.
endauctionswhenoutofstockBooleanFalseNoIf the value is 'true', automatically ends eBay auctions when the item goes out of stock.
enforceminqtyinternallyBooleanFalseNoIf the value is 'true', prevents internal transactions that would violate the minimum stock quantity threshold.
excludefromsitemapBooleanFalseNoIf the value is 'true', the item is excluded from XML sitemaps, which can affect search engine visibility.
externalidStringFalseNoA unique external identifier for the item, often used for integration with external systems.
featureddescriptionStringFalseNoA marketing-enhanced description of the item shown in storefronts and promotional displays.
fraudriskStringFalseNoRepresents the risk level or fraud score associated with the item, based on internal or external evaluation.
froogleproductfeedStringFalseNoSpecifies the feed configuration for listing this item on Google Shopping (formerly Froogle).
futurehorizonStringFalseNoDefines the planning horizon (in time) for which future demand or supply forecasts apply.
gainlossaccountStringFalseNoThe general ledger account used to track gains or losses related to inventory valuation changes.
galleryBooleanFalseNoIf the value is 'true', enables the eBay Gallery feature, displaying item images in search results.
galleryfeaturedBooleanFalseNoIf the value is 'true', promotes the item in eBay search results using the Gallery Featured placement.
gifttypeexpressshipBooleanFalseNoIf the value is 'true', marks the item as eligible for express gift shipping.
gifttypegiftwrapBooleanFalseNoIf the value is 'true', allows customers to select gift wrapping when purchasing the item.
gifttypeshiptorecipientBooleanFalseNoIf the value is 'true', enables direct shipment of the gift item to the recipient.
handlingcostDecimalFalseNoSpecifies the handling fee associated with shipping the item, added to the total cost.
handlingcostunitsStringFalseNoUnit of measure used for calculating handling costs (for example, per item, per shipment).
handlinggroupStringFalseNoDefines the group used for applying specific handling rules to the item, such as processing time or fees.
imagesgroupStringFalseNoDesignates the image group this item belongs to for organizing media assets.
imageslocationStringFalseNoSpecifies the location or directory path where item images are stored or hosted.
includechildrenBooleanFalseNoIf the value is 'true', includes child items or variants in reporting and display contexts.
incomeaccountStringFalseNoThe account where income generated from selling this item is posted in the general ledger.
intercocogsaccountStringFalseNoAccount used to record COGS for intercompany transactions involving this item.
intercoincomeaccountStringFalseNoAccount used to record intercompany revenue generated from this item.
internalidIntegerFalseNoThe internal system-generated ID for the item record, used as a unique identifier across the platform.
iscalculatedrateStringFalseNoIndicates whether the item uses a calculated rate for pricing or cost purposes, such as based on formulas or dynamic rules.
isdonationitemBooleanFalseNoIf the value is 'true', the item is designated as a donation item, typically used for charitable contributions.
isdropshipitemBooleanFalseNoIf the value is 'true', the item is fulfilled directly by a third-party vendor (drop ship), bypassing internal inventory.
isgcocompliantBooleanFalseNoIf the value is 'true', the item complies with Global Commerce Initiative (GCI) standards or internal governance rules.
isinactiveBooleanFalseNoIf the value is 'true', the item is inactive and unavailable for transactions or listings.
isonlineBooleanFalseNoIf the value is 'true', the item is available for online sale or display on the website or web store.
isspecialorderitemBooleanFalseNoIf the value is 'true', the item can be purchased through special orders that may require custom handling or configuration.
isstorepickupallowedBooleanFalseNoIf the value is 'true', customers can choose in-store pickup as a delivery option for this item.
issueproductStringFalseNoIdentifies the related product issued or manufactured as part of inventory or production workflows.
itemconditionStringFalseNoIndicates the item's condition, such as New, Refurbished, or Used, which may appear on listings and affect pricing.
itemhandlingfeeDecimalFalseNoSpecifies the handling fee associated with processing the item for shipment.
itemidStringFalseNoThe item’s unique identifier or Stock Keeping Unit (SKU), used for tracking and reporting.
iteminsurancefeeDecimalFalseNoThe cost of optional insurance for shipping the item, added to the total shipping cost if selected.
itemnumberoptionsStringFalseNoLists the configuration options available for the item number, such as size or color variants.
itemoptionsStringFalseNoSpecifies the customizable or selectable options available for the item during order entry.
itemprocessfamilyStringFalseNoGroups items by processing family to support common manufacturing or procurement rules.
itemprocessgroupStringFalseNoAssigns the item to a process group, helping to manage production workflows and related operations.
itemrevenuecategoryStringFalseNoDefines the revenue category associated with the item for revenue allocation and reporting.
itemshipinsuranceStringFalseNoSpecifies the insurance policy or terms applied when shipping the item.
itemtypeStringFalseNoIndicates the type of item, such as Inventory, Non-inventory, or Service, for classification and behavior in transactions.
lastmodifieddateDatetimeFalseNoThe date and time when the item record was last updated, used for audit and synchronization purposes.
lastpurchasepriceDecimalFalseNoThe price paid for the item on the most recent purchase transaction, useful for cost tracking.
leadtimeIntegerFalseNoThe number of days typically required to procure or manufacture the item, used in supply planning.
listimmediateStringFalseNoDetermines if the item should be listed immediately upon creation or approval, often used for web listings.
listingdurationStringFalseNoDefines the duration of time an item remains listed on external marketplaces like eBay.
listingstartdateDateFalseNoThe calendar date when the item’s external listing goes live.
listingstarttimeStringFalseNoThe exact time of day when the item’s listing becomes active on external channels.
locationStringFalseNoSpecifies the inventory location where the item is stocked or shipped from.
lowerwarninglimitDoubleFalseNoThe threshold quantity below which a warning is triggered to indicate low stock levels.
manufacturerStringFalseNoThe name of the company or brand that produces or supplies the item.
manufactureraddr1StringFalseNoThe first line of the manufacturer's address, typically including street address or P.O. box information.
manufacturercityStringFalseNoThe city in which the manufacturer is located.
manufacturerstateStringFalseNoThe state or province where the manufacturer is based.
manufacturertariffStringFalseNoThe tariff code used for international trade classification of the item, assigned by the manufacturer.
manufacturertaxidStringFalseNoThe tax identification number of the manufacturer, used for regulatory and customs compliance.
manufacturerzipStringFalseNoThe postal or ZIP code of the manufacturer's address.
matchbilltoreceiptBooleanFalseNoIf the value is 'true', billing transactions must match the quantities and amounts on receipts, enforcing a 3-way match validation.
matrixitemnametemplateStringFalseNoTemplate used to dynamically generate item names for matrix items based on their attributes, such as size or color.
matrixtypeStringFalseNoSpecifies the matrix type of the item, indicating whether it is a parent, child, or standalone item in a matrix structure.
maxdonationamountDecimalFalseNoThe maximum donation amount that can be applied to this item when used in a charitable context.
maximumquantityStringFalseNoThe upper limit of item quantity that can be ordered or managed in inventory transactions.
metataghtmlStringFalseNoHTML content used for meta tags on product web pages to improve SEO (Search Engine Optimization) performance.
minimumquantityStringFalseNoThe minimum order or stock quantity allowed or required for the item.
minimumquantityunitsStringFalseNoThe unit of measure associated with the minimum quantity, such as Each or Case.
mossappliesBooleanFalseNoIf the value is 'true', the Mini One Stop Shop (MOSS) VAT scheme applies to this item for cross-border EU transactions.
mpnStringFalseNoThe Manufacturer Part Number (MPN) used to identify the item uniquely across manufacturer catalogs.
multmanufactureaddrBooleanFalseNoIf the value is 'true', the item supports multiple manufacturing addresses for sourcing or production.
nextagcategoryStringFalseNoThe product category assigned for Nextag, a shopping comparison platform, used for categorization in product feeds.
nextagproductfeedStringFalseNoThe Nextag-specific product feed that includes this item for online advertising or sales channels.
nopricemessageStringFalseNoA custom message displayed when pricing is unavailable for this item, such as 'Call for Price'.
numactivelistingsIntegerFalseNoThe total number of currently active listings for this item across online marketplaces.
numcurrentlylistedIntegerFalseNoThe current number of item instances listed for sale, often used for performance and visibility tracking.
offersupportBooleanFalseNoIf the value is 'true', the item includes support services, such as helpdesk access or maintenance agreements.
outofstockbehaviorStringFalseNoSpecifies the system behavior when the item is out of stock, such as backorder or disallow purchase.
outofstockmessageStringFalseNoThe custom message shown to users when the item is out of stock, for example, 'Temporarily unavailable'.
overallquantitypricingtypeStringFalseNoDefines the pricing structure based on quantity tiers, such as per item or per group total.
packageheightStringFalseNoThe height dimension of the item's package, used for shipping calculations and logistics.
packagelengthStringFalseNoThe length dimension of the item's package, measured in defined units for fulfillment purposes.
packagewidthStringFalseNoThe width dimension of the item's package for use in shipping and handling estimations.
pagetitleStringFalseNoThe title displayed in the browser or search results for the item’s web store page.
parentStringFalseNoThe parent item to which this inventory item is linked, typically in matrix or kit configurations.
planningitemcategoryStringFalseNoSpecifies the planning category for the item, used in supply planning and MRP (Material Requirements Planning) processes.
preferencecriterionStringFalseNoDefines the criteria used to prioritize sourcing or supplier options when multiple preferences exist.
preferredlocationStringFalseNoIndicates the default inventory location where the item is stocked or fulfilled from.
preferredstockleveldaysDoubleFalseNoThe number of days of stock coverage used to calculate preferred stock levels for replenishment planning.
pricinggroupStringFalseNoThe pricing group the item belongs to, allowing for grouped discounts or price rules across items.
primarycatdisplaynameStringFalseNoThe display name of the primary web store category where the item is listed.
primarycategoryIntegerFalseNoThe internal ID of the primary category assigned to the item in a web store or catalog.
producerBooleanFalseNoIf the value is 'true', the company is recognized as the producer or manufacturer of this inventory item.
productfeedStringFalseNoThe name of the marketing or shopping feed that includes this item for syndication to external platforms.
purchasedescriptionStringFalseNoThe description of the item as used on purchase orders and vendor-facing documents.
purchaseorderamountStringFalseNoThe monetary amount associated with the item's purchase order transactions.
purchaseorderquantityStringFalseNoThe quantity of the item included in purchase orders.
purchaseorderquantitydiffStringFalseNoThe difference between the ordered and received quantities for purchase orders involving this item.
purchasepricevarianceacctStringFalseNoThe general ledger account used to track differences between expected and actual purchase prices.
purchaseunitStringFalseNoThe unit of measure used when purchasing the item from a vendor, such as Case or Dozen.
quantitypricingscheduleStringFalseNoThe pricing schedule that defines tiered pricing based on ordered quantity ranges.
quantityreorderunitsStringFalseNoThe unit of measure used when reordering the item, which may differ from the base unit.
receiptamountStringFalseNoThe total monetary value of the item received into inventory.
receiptquantityStringFalseNoThe quantity of the item received into inventory from a purchase order or transfer.
receiptquantitydiffStringFalseNoThe difference between expected and received quantities during inventory receiving.
refundgivenasStringFalseNoSpecifies how refunds for the item are issued, such as cash, store credit, or original payment method.
relateditemsdescriptionStringFalseNoText description or notes about items related to this product, often shown for cross-selling or up-selling.
reordermultipleStringFalseNoThe increment in which the item must be reordered, typically used to meet vendor packaging or palletization rules.
rescheduleindaysIntegerFalseNoNumber of days to move incoming supply earlier to meet changing demand.
rescheduleoutdaysIntegerFalseNoNumber of days to delay incoming supply based on decreased or delayed demand.
reservepriceDecimalFalseNoThe minimum acceptable sale price for auction-style listings, below which the item will not be sold.
returnpolicyStringFalseNoThe return policy identifier or name that applies to this item when sold.
returnpolicydetailsStringFalseNoA detailed description of the return policy terms and conditions for the item.
returnshippingpaidbyStringFalseNoIndicates who is responsible for return shipping costs—either the customer or the seller.
returnswithinStringFalseNoThe time window during which the item is eligible for return, such as '30 days'.
revenueallocationgroupStringFalseNoThe group used for allocating revenue across bundled items or packages under revenue recognition rules.
revenuerecognitionruleStringFalseNoSpecifies the revenue recognition rule that governs how revenue is recognized over time for this item.
revrecforecastruleStringFalseNoDefines the forecast rule used for revenue recognition purposes, helping to predict when revenue will be earned.
revrecscheduleStringFalseNoIdentifies the revenue recognition schedule that distributes recognized revenue over a defined period.
safetystocklevelDoubleFalseNoSpecifies the minimum inventory quantity to keep on hand to prevent stockouts due to demand fluctuations.
safetystockleveldaysIntegerFalseNoDefines the number of days' worth of inventory to maintain as safety stock, based on average daily usage.
safetystocklevelunitsStringFalseNoIndicates the unit of measure used when calculating the safety stock level, such as units or cases.
salesdescriptionStringFalseNoThe description of the item as shown on customer-facing documents like sales orders and invoices.
saleunitStringFalseNoThe unit of measure used when selling the item, such as 'Each', 'Box', or 'Pallet'.
schedulebcodeStringFalseNoThe U.S. Schedule B code used for export classification and customs reporting.
schedulebnumberStringFalseNoThe specific numeric identifier from the Schedule B list, used for international trade compliance.
schedulebquantityStringFalseNoThe unit of quantity associated with the Schedule B code, such as 'kg' or 'dozen'.
searchkeywordsStringFalseNoA list of keywords used to help customers find the item in web store searches or product listings.
seasonaldemandBooleanFalseNoIf the value is 'true', this item has demand patterns that vary by season, affecting inventory planning.
secondarybaseunitStringFalseNoThe base unit of measure used for inventory tracking in the secondary unit type configuration.
secondarycatdisplaynameStringFalseNoThe display name of the secondary category where the item is listed in a web store or catalog.
secondarycategoryIntegerFalseNoThe internal ID of the secondary category used for organizing items in the online store.
secondaryconsumptionunitStringFalseNoThe unit of measure used when consuming the item in manufacturing or operations, in a secondary unit configuration.
secondarypurchaseunitStringFalseNoThe unit of measure used for purchasing the item when secondary units are enabled.
secondarysaleunitStringFalseNoThe unit of measure used for selling the item using secondary units.
secondarystockunitStringFalseNoThe stockkeeping unit used when tracking inventory in a secondary unit system.
secondaryunitstypeStringFalseNoThe overall unit type classification for the item's secondary units of measure, defining relationships between them.
sellonebayBooleanFalseNoIf the value is 'true', this item is listed for sale on eBay through an integrated eCommerce feed.
shipasiaBooleanFalseNoIf the value is 'true', the item is eligible for shipment to countries in Asia.
shipaustraliaBooleanFalseNoIf the value is 'true', the item is eligible for shipment to Australia.
shipcanadaBooleanFalseNoIf the value is 'true', the item is eligible for shipment to Canada.
shipeuropeBooleanFalseNoIf the value is 'true', the item is eligible for shipment to countries in Europe.
shipgermanyBooleanFalseNoIf the value is 'true', the item is eligible for shipment specifically to Germany.
shipindividuallyBooleanFalseNoIf the value is 'true', the item must be shipped in its own package and cannot be combined with other items.
shipjapanBooleanFalseNoIf the value is 'true', the item is eligible for shipment to Japan.
shipmexicoBooleanFalseNoIf the value is 'true', the item is eligible for shipment to Mexico.
shipnorthsouthamericaBooleanFalseNoIf the value is 'true', the item is eligible for shipment to both North and South America.
shippackageStringFalseNoIndicates the packaging type used for shipping the item, such as envelope, box, or crate.
shippingcostDecimalFalseNoSpecifies the base cost incurred for shipping the item to a customer.
shippingcostunitsStringFalseNoThe unit of measure used to express the shipping cost, such as 'per item' or 'per weight'.
shippingdomesticmethodsgroupStringFalseNoReferences a predefined group of shipping methods available for domestic shipments.
shippingdomgroupStringFalseNoDefines the domestic shipping group assigned to the item for handling logistics within the same country.
shippingintlgroupStringFalseNoDefines the group of shipping options that apply when shipping the item internationally.
shippingintlgroup1StringFalseNoSpecifies the first international shipping method configured for the item.
shippingintlgroup2StringFalseNoSpecifies the second international shipping method configured for the item.
shippingintlgroup3StringFalseNoSpecifies the third international shipping method configured for the item.
shippingitem1StringFalseNoThe first shipping item associated with this inventory item, such as a specific courier service.
shippingitem2StringFalseNoThe second shipping item configured for the inventory item, used for alternative shipping setups.
shippingitem3StringFalseNoThe third shipping item assigned to the inventory item for additional shipping options.
shippinglocationsgroupStringFalseNoIndicates the group of geographical shipping destinations assigned to this item.
shippingpackaginggroupStringFalseNoIdentifies the packaging configuration or group used when preparing the item for shipment.
shippingrate1DecimalFalseNoSpecifies the first tier of shipping rate applied to this item.
shippingrate2DecimalFalseNoSpecifies the second tier of shipping rate, which may depend on quantity or region.
shippingrate3DecimalFalseNoSpecifies the third shipping rate level, used for advanced pricing models or bulk shipping.
shipukBooleanFalseNoIf the value is 'true', the item is eligible for shipment to the United Kingdom.
shipworldwideBooleanFalseNoIf the value is 'true', the item can be shipped to any international destination without restriction.
shoppingdotcomcategoryStringFalseNoDefines the category used for listing this item on Shopping.com, aiding in proper classification.
shoppingproductfeedStringFalseNoSpecifies the product feed used to export item data to Shopping.com.
shopzillacategoryidIntegerFalseNoThe internal category ID assigned to the item for Shopzilla product listings.
shopzillaproductfeedStringFalseNoDefines the product feed used to export item data to Shopzilla.
showasgiftBooleanFalseNoIf the value is 'true', the item is presented as a gift option during checkout.
showdefaultdonationamountBooleanFalseNoIf the value is 'true', a default donation amount is shown when this item is offered as a donation.
sitemappriorityStringFalseNoSpecifies how prominently the item should appear in a sitemap, guiding search engine indexing.
softdescriptorStringFalseNoA short, customizable text label that appears on customers' credit card statements for this item.
standardimagesStringFalseNoReferences the standard set of product images used to represent the item online or in print.
startingpriceDecimalFalseNoIndicates the initial listing price for the item, such as for auction-style sales.
stockdescriptionStringFalseNoA detailed description used internally to provide additional context about the item in stock.
stockunitStringFalseNoThe standard unit of measure used for managing stock levels, such as 'Each', 'Case', or 'Pound'.
storecatdisplaynameStringFalseNoThe display name of the primary store category where the item appears in your online store.
storecatdisplayname2StringFalseNoThe display name of the secondary store category used for additional online store placement.
storecategoryIntegerFalseNoThe internal identifier for the primary store category assigned to this item.
storecategory2IntegerFalseNoThe internal identifier for the secondary store category associated with the item.
storedescriptionStringFalseNoA short marketing description shown in the online store to highlight the product's key benefits.
storedetaileddescriptionStringFalseNoA more comprehensive version of the item’s description used for online store listings.
storedisplayimageStringFalseNoThe URL or identifier for the main image used to represent the item in the online store.
storedisplaynameStringFalseNoThe public-facing display name of the item as seen by customers in the online store.
storedisplaythumbnailStringFalseNoThe thumbnail image used for compact views of the item, such as category listings or search results.
storeitemtemplateStringFalseNoThe store template applied to this item, controlling layout and appearance in the web store.
subsidiaryStringFalseNoIndicates the subsidiary to which the inventory item belongs, used in multi-subsidiary environments.
supersizeimagesBooleanFalseNoIf the value is 'true', enables the use of supersized images for product presentation in the web store.
supplyreplenishmentmethodStringFalseNoSpecifies the method used to replenish stock for this item, such as purchase order or transfer order.
supplytimefenceIntegerFalseNoDefines the number of days into the future for which supply planning should consider this item.
taxableBooleanFalseNoIf the value is 'true', the item is subject to applicable sales taxes during transaction processing.
taxscheduleStringFalseNoIdentifies the tax schedule used to calculate taxes for this item based on jurisdiction.
templatesgroupStringFalseNoSpecifies the group of templates associated with the item, often used in print or online publishing.
totalvalueDecimalFalseNoThe total value of the inventory on hand, calculated as quantity on hand times unit cost.
tracklandedcostBooleanFalseNoIf the value is 'true', landed cost tracking is enabled for this item, capturing freight, duties, and other charges.
transferpriceDecimalFalseNoDefines the price at which the item is transferred between subsidiaries or locations.
transferpriceunitsStringFalseNoSpecifies the unit of measure used for the item’s transfer price calculation.
unitstypeStringFalseNoIndicates the unit type classification that groups measurement units for sale, purchase, and stock.
upccodeStringFalseNoThe Universal Product Code (UPC) assigned to the item, used for scanning and retail tracking.
upperwarninglimitDoubleFalseNoThe maximum quantity threshold at which a warning is issued during inventory review or planning.
urlcomponentStringFalseNoDefines the SEO-friendly URL component used for the item in the online store.
usebinsBooleanFalseNoIf the value is 'true', the item uses bin management for warehouse storage tracking.
usemarginalratesBooleanFalseNoIf the value is 'true', marginal tax rates are applied to the item instead of flat rates.
vendornameStringFalseNoSpecifies the primary vendor associated with the item, typically used for purchasing or reporting.
vendreturnvarianceaccountStringFalseNoAccount used to track cost variances for returned items received from vendors.
vsoedeferralStringFalseNoSpecifies the deferral method under Vendor-Specific Objective Evidence (VSOE) revenue recognition.
vsoedeliveredBooleanFalseNoIf the value is 'true', indicates that the deliverables for the item have been fulfilled under VSOE rules.
vsoepermitdiscountStringFalseNoControls whether discounting is permitted for this item under VSOE accounting treatment.
vsoepriceDecimalFalseNoThe price assigned to the item for VSOE revenue allocation purposes.
vsoesopgroupStringFalseNoIdentifies the group this item belongs to for SOP (Statement of Position) revenue recognition.
weightDoubleFalseNoThe physical weight of the item, typically used for shipping rate calculations.
weightunitStringFalseNoThe unit of measure for the item's weight, such as pounds or kilograms.
weightunitsStringFalseNoAlternative or additional units available for expressing the item’s weight.
willshipStringFalseNoIndicates shipping eligibility or method, such as standard, expedited, or restricted.
yahooproductfeedStringFalseNoIdentifies the product feed used to send item information to Yahoo’s e-commerce or marketplace platform.

Return to Top

serviceitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
amortizationperiodIntegerFalseNoThe number of accounting periods over which the cost of the service item is amortized.
amortizationtemplateStringFalseNoThe predefined amortization schedule applied to the service item for revenue recognition purposes.
auctionquantityStringFalseNoThe quantity of this service item listed in an auction-based selling format, typically used in online marketplaces.
auctiontypeStringFalseNoThe type of auction applicable to this item, such as fixed-price or traditional auction.
availabletopartnersBooleanFalseNoIf the value is 'true', the service item is available for selection by partner users; if 'false', it is hidden from partners.
billexchratevarianceacctStringFalseNoThe general ledger account used to record variances due to billing exchange rate differences.
billingscheduleStringFalseNoThe billing schedule template that determines how and when the customer is billed for the service item.
billpricevarianceacctStringFalseNoThe account used to track variances between billed and expected prices for the service item.
billqtyvarianceacctStringFalseNoThe account used to capture quantity discrepancies between the billed and actual service quantities.
buyitnowpriceDecimalFalseNoThe fixed price at which a customer can immediately purchase the service item in an auction setting.
classStringFalseNoThe classification assigned to the service item for tracking and reporting purposes, such as business line or region.
conditionenabledStringFalseNoIndicates whether item condition rules are enabled for this service item (for example, refurbished, new).
conditionhelpurlStringFalseNoA Uniform Resource Locator (URL) linking to documentation or guidelines explaining condition settings applicable to this service item.
consumptionunitStringFalseNoThe unit of measure used to track service consumption, such as hours or sessions.
contingentrevenuehandlingBooleanFalseNoIf the value is 'true', contingent revenue recognition rules are applied to this item; if 'false', revenue is recognized as billed.
costDecimalFalseNoThe direct cost associated with delivering the service item, used for profitability analysis.
costcategoryStringFalseNoThe cost category assigned to the service item, which determines how costs are grouped in financial reports.
costestimateDecimalFalseNoAn estimated cost used for forecasting and project planning related to the service item.
costestimatetypeStringFalseNoThe method used to estimate the cost of the service item, such as average or standard cost.
costunitsStringFalseNoThe unit of measure in which the item's cost is expressed, such as per hour or per project.
createddateDatetimeFalseNoThe date and time the service item record was created in the system.
createjobBooleanFalseNoIf the value is 'true', a job or project record is automatically created when this item is used; if 'false', no job is created.
createrevenueplansonStringFalseNoSpecifies the rule or trigger that initiates the creation of a revenue recognition plan for the service item.
currencyStringFalseNoThe currency in which the service item’s pricing and cost data are recorded.
customformStringFalseNoThe custom form template used to display or manage this service item’s record in the user interface.
deferralaccountStringFalseNoThe general ledger account used to temporarily hold deferred amounts until revenue can be recognized.
deferredrevenueaccountStringFalseNoThe revenue account where deferred income is posted for the service item until it is earned.
deferrevrecBooleanFalseNoIf the value is 'true', revenue recognition is deferred for this item; if 'false', revenue is recognized immediately.
departmentStringFalseNoThe internal department responsible for the delivery or management of the service item.
directrevenuepostingBooleanFalseNoIf the value is 'true', revenue for this service item is posted directly without using deferred accounts; if 'false', deferral logic is used.
displayinebaystoreBooleanFalseNoIf the value is 'true', the service item is listed in the connected eBay store; if 'false', it is excluded.
displaynameStringFalseNoThe user-friendly name displayed for the service item across NetSuite interfaces and customer-facing documents.
dontshowpriceBooleanFalseNoIf the value is 'true', the price of the service item is hidden on customer-facing records and portals; if 'false', the price is shown.
ebayhandlingtimeStringFalseNoThe handling time commitment displayed on eBay listings, indicating how soon the item will be processed for shipment after purchase.
ebayintlinsurancefeeDecimalFalseNoThe cost of international shipping insurance for the service item when sold through eBay.
ebayintlpackagehandlingfeeDecimalFalseNoAdditional handling fee charged for international shipments of this service item on eBay.
ebayintlshipinsuranceStringFalseNoSpecifies the type or provider of international shipping insurance for eBay transactions involving this item.
ebayintlshippingitem1StringFalseNoThe first shipping option for international delivery of the service item when listed on eBay.
ebayintlshippingitem2StringFalseNoThe second international shipping method offered on the eBay listing for the service item.
ebayintlshippingitem3StringFalseNoThe third shipping option for international orders of this item on eBay.
ebayisintlcalculatedrateStringFalseNoIndicates whether international shipping rates are calculated automatically for the eBay listing.
ebayisirregularpackageBooleanFalseNoIf the value is 'true', the item is marked as irregular in shape or weight for shipping on eBay; if 'false', it is considered a standard package.
ebayitemdescriptionStringFalseNoThe item description used in eBay listings, providing details of the service being sold.
ebayitemlocdisplayStringFalseNoA custom display value for the item’s physical location in the eBay listing (for example,'Ships from California').
ebayitemloczipcodeStringFalseNoThe ZIP code associated with the service item’s shipping origin in eBay listings.
ebayitemlotsIntegerFalseNoThe number of service units grouped into one lot when listed on eBay, relevant for bulk service sales.
ebayitemsubtitleStringFalseNoAn optional subtitle shown on the eBay listing, used to attract buyers with additional item info.
ebayitemtitleStringFalseNoThe title of the eBay listing for the service item, typically including keywords to improve visibility.
ebayitemweightamtStringFalseNoThe weight of the item as entered for eBay shipping calculations. May include value and unit (for example,'2 lbs').
ebaylayoutStringFalseNoThe listing layout template used for displaying the service item on eBay.
ebaypackagetypeStringFalseNoThe packaging format selected for the service item in eBay listings (for example,box, envelope).
ebaypagecounterStringFalseNoThe page counter setting in the eBay listing, such as 'Basic' or 'Hidden', which tracks page views.
ebayrelistingoptionStringFalseNoSpecifies the relisting behavior on eBay if the service item does not sell, such as 'Auto-Relist'.
ebaythemeStringFalseNoThe visual theme applied to the eBay listing to control branding and layout.
ebaythemegroupStringFalseNoThe theme group to which the eBay theme belongs, helping organize available listing designs.
endauctionswhenoutofstockBooleanFalseNoIf the value is 'true', the eBay auction will end when the available quantity reaches zero; if 'false', the listing remains active.
enforceminqtyinternallyBooleanFalseNoIf the value is 'true', internal rules enforce a minimum quantity requirement for using this service item; if 'false', quantity is unrestricted.
excludefromsitemapBooleanFalseNoIf the value is 'true', this service item is excluded from XML sitemaps used for search engine optimization (SEO) and web indexing.
expenseaccountStringFalseNoThe general ledger account to which the service item’s purchase-related expenses are posted.
externalidStringFalseNoA user-defined external identifier used to reference the service item from external systems or integrations.
featureddescriptionStringFalseNoA short, attention-grabbing description used to highlight the service item in search results or promotional displays.
galleryBooleanFalseNoIf the value is 'true', the item is featured in the gallery section on eBay listings; if 'false', it is not displayed in the gallery.
galleryfeaturedBooleanFalseNoIf the value is 'true', the item is marked as a featured listing in the gallery view on online marketplaces such as eBay.
generateaccrualsBooleanFalseNoIf the value is 'true', accruals will be automatically generated for this service item during financial transactions.
gifttypeexpressshipBooleanFalseNoIf the value is 'true', the item supports express shipping as a gift option.
gifttypegiftwrapBooleanFalseNoIf the value is 'true', the item supports gift wrapping services.
gifttypeshiptorecipientBooleanFalseNoIf the value is 'true', the item can be shipped directly to the gift recipient.
handlinggroupStringFalseNoThe group that determines how the item is handled during order fulfillment, such as packaging or special processing requirements.
imagesgroupStringFalseNoA reference to the group of images associated with the item, used for managing product visuals across listings.
imageslocationStringFalseNoThe file path or URL location where the item's images are stored.
includechildrenBooleanFalseNoIf the value is 'true', child items (such as variants or components) are included in item listings and pricing.
incomeaccountStringFalseNoThe general ledger account that receives revenue from the sale of this service item.
intercodefrevaccountStringFalseNoThe intercompany deferred revenue account used when this item is involved in transactions between subsidiaries.
intercoexpenseaccountStringFalseNoThe intercompany expense account associated with costs incurred for this item between subsidiaries.
intercoincomeaccountStringFalseNoThe intercompany income account used when this item is sold between subsidiaries.
internalidIntegerFalseNoThe unique internal identifier for the item within NetSuite’s system.
iscalculatedrateStringFalseNoIndicates whether the rate for this item is calculated automatically or entered manually.
isdonationitemBooleanFalseNoIf the value is 'true', the item is treated as a donation item and may be used in charitable transactions or campaigns.
isfulfillableBooleanFalseNoIf the value is 'true', the item can be fulfilled like a physical product, even though it is a service.
isgcocompliantBooleanFalseNoIf the value is 'true', the item complies with Generally Compliant Operations (GCO) standards, typically for global commerce.
isinactiveBooleanFalseNoIf the value is 'true', the item is inactive and not available for new transactions.
isonlineBooleanFalseNoIf the value is 'true', the item is available in the online store or e-commerce platform.
issueproductStringFalseNoA reference to the product that this service item is issued with or related to.
itemconditionStringFalseNoThe condition of the item such as new, refurbished, or used—relevant in marketplaces or regulated industries.
itemhandlingfeeDecimalFalseNoThe fee charged for handling this service item during fulfillment or delivery.
itemidStringFalseNoThe item’s unique identifier or Stock Keeping Unit (SKU) used for tracking and sales.
iteminsurancefeeDecimalFalseNoThe fee charged for optional insurance coverage during delivery of the service.
itemoptionsStringFalseNoA list of customizable or selectable options available for the item such as duration or level of service.
itemrevenuecategoryStringFalseNoThe revenue category used for classifying income generated by this item, useful in revenue recognition and reporting.
itemshipinsuranceStringFalseNoSpecifies the shipping insurance option associated with this item.
itemtypeStringFalseNoThe type of item, such as 'service', which determines how it is processed in transactions.
lastmodifieddateDatetimeFalseNoThe date and time when the item record was last modified in the system.
listimmediateStringFalseNoIndicates whether the item should be listed immediately in an online store or held for manual publishing.
listingdurationStringFalseNoThe duration for which the item is listed on an external marketplace, such as 7 days, 30 days, or 'Good Till Cancelled'.
listingstartdateDateFalseNoThe calendar date when the listing becomes active on external marketplaces or e-commerce platforms.
listingstarttimeStringFalseNoThe specific time of day when the listing is scheduled to start.
locationStringFalseNoThe inventory or service location associated with the item, often used for fulfillment and tax calculations.
manufacturingchargeitemBooleanFalseNoIf the value is 'true', the service item is used to represent manufacturing overhead or charges during production.
matrixitemnametemplateStringFalseNoA template used to generate the names of matrix items, which are items with variations such as size or color.
matrixtypeStringFalseNoSpecifies the role of the item in a matrix setup, such as 'parent' or 'child'.
maxdonationamountDecimalFalseNoThe maximum donation amount allowed when this service item is used in a charitable transaction.
maximumquantityStringFalseNoThe upper limit of quantity that can be ordered for this item in a single transaction.
metataghtmlStringFalseNoCustom HTML meta tags used to enhance SEO for this item on e-commerce sites.
minimumquantityStringFalseNoThe minimum quantity required when purchasing or processing this item.
minimumquantityunitsStringFalseNoThe unit of measurement that applies to the minimum quantity value.
mossappliesBooleanFalseNoIf the value is 'true', the item is subject to the Mini One Stop Shop (MOSS) VAT reporting rules for digital services in the European Union.
nopricemessageStringFalseNoA custom message displayed when no price is available for this item, such as 'Contact us for pricing'.
numactivelistingsIntegerFalseNoThe number of active listings for this item across all sales channels and marketplaces.
numcurrentlylistedIntegerFalseNoThe number of current listings available for this item at the present time.
offersupportBooleanFalseNoIf the value is 'true', the item includes or enables customer support services.
outofstockbehaviorStringFalseNoSpecifies how the system should behave when the item is out of stock, such as 'Allow Backorders' or 'Prevent Sales'.
outofstockmessageStringFalseNoA message shown to users when the item is not currently available, such as 'Out of stock—check back soon'.
overheadtypeStringFalseNoThe type of overhead cost associated with this item, such as labor or material overhead in manufacturing.
packageheightStringFalseNoThe height of the item’s packaging, used for shipping calculations and logistics planning.
packagelengthStringFalseNoThe length of the item’s packaging for shipping and dimensional weight considerations.
packagewidthStringFalseNoThe width of the item’s packaging for determining shipping costs.
pagetitleStringFalseNoThe HTML page title used for this item’s detail page, helpful for SEO and browser display.
parentStringFalseNoThe parent item in a matrix or hierarchical relationship, if applicable.
pricinggroupStringFalseNoThe pricing group assigned to this item, which determines pricing rules for different customer segments.
primarycatdisplaynameStringFalseNoThe display name of the primary category to which this item belongs, shown in storefronts.
primarycategoryIntegerFalseNoThe internal identifier of the item's main product category.
purchasedescriptionStringFalseNoA detailed description used on purchase transactions such as vendor bills or purchase orders.
purchaseorderamountStringFalseNoThe total amount specified for the item on a purchase order.
purchaseorderquantityStringFalseNoThe quantity of the item specified on a purchase order.
purchaseorderquantitydiffStringFalseNoThe difference between the expected quantity and the received quantity on purchase orders for this service item.
purchaseunitStringFalseNoThe unit of measurement used when ordering this item from a vendor, such as 'hours' or 'each'.
receiptamountStringFalseNoThe monetary amount received for the item as recorded on the receipt document.
receiptquantityStringFalseNoThe quantity of this item received into inventory or service fulfillment.
receiptquantitydiffStringFalseNoThe difference between the expected quantity and actual quantity received for this item.
refundgivenasStringFalseNoSpecifies the method by which refunds are issued for this item, such as store credit or original payment method.
relateditemsdescriptionStringFalseNoA descriptive text that highlights related or complementary items to encourage cross-selling.
reservepriceDecimalFalseNoThe minimum acceptable price set for the item in auction-style listings.
residualStringFalseNoThe residual value of the item used in financial or amortization calculations.
returnpolicyStringFalseNoThe return policy applied to this item, defining general return terms such as eligibility or timeframe.
returnpolicydetailsStringFalseNoDetailed information about the return policy, such as restocking fees or return process steps.
returnshippingpaidbyStringFalseNoIndicates who is responsible for return shipping costs, such as 'buyer' or 'seller'.
returnswithinStringFalseNoSpecifies the allowable period for returning the item, such as '30 days from receipt'.
revenueallocationgroupStringFalseNoA group used to allocate revenue for multi-element arrangements involving this item.
revenuerecognitionruleStringFalseNoThe rule that governs how and when revenue is recognized for this item.
revrecforecastruleStringFalseNoThe rule used to forecast revenue recognition amounts and timing for this item.
revreclassfxaccountStringFalseNoThe foreign currency reclassification account used during revenue reclassification.
revrecscheduleStringFalseNoThe revenue recognition schedule associated with the item, such as monthly or quarterly.
salesdescriptionStringFalseNoA description of the item intended for display on sales documents or e-commerce listings.
saleunitStringFalseNoThe unit in which the item is sold, such as 'per hour' or 'per session'.
searchkeywordsStringFalseNoKeywords associated with this item to improve searchability on storefronts and marketplaces.
secondarycatdisplaynameStringFalseNoThe name of the secondary category where this item is displayed online.
secondarycategoryIntegerFalseNoThe internal ID for the item's secondary category, often used for navigation or filtering.
sellonebayBooleanFalseNoIf the value is 'true', the item is available for sale on eBay via integrated listing functionality.
shipasiaBooleanFalseNoIf the value is 'true', the item can be shipped to countries in Asia.
shipaustraliaBooleanFalseNoIf the value is 'true', the item can be shipped to customers in Australia.
shipcanadaBooleanFalseNoIf the value is 'true', the item is available for shipping to Canada.
shipeuropeBooleanFalseNoIf the value is 'true', the item can be shipped to countries in Europe.
shipgermanyBooleanFalseNoIf the value is 'true', the item can be shipped to Germany.
shipjapanBooleanFalseNoIf the value is 'true', the item is eligible for shipping to Japan.
shipmexicoBooleanFalseNoIf the value is 'true', the item can be shipped to customers in Mexico.
shipnorthsouthamericaBooleanFalseNoIf the value is 'true', the item can be shipped to countries in North and South America.
shippingdomesticmethodsgroupStringFalseNoThe group of shipping methods available for domestic deliveries of this service item.
shippingdomgroupStringFalseNoThe internal group used to organize domestic shipping settings for the item.
shippingintlgroupStringFalseNoThe group that defines international shipping options for the item across all global regions.
shippingintlgroup1StringFalseNoThe first specific group of international shipping settings applicable to this item.
shippingintlgroup2StringFalseNoThe second group of international shipping configurations available for this item.
shippingintlgroup3StringFalseNoThe third group of international shipping methods defined for this item.
shippingitem1StringFalseNoThe first shipping item or method associated with this service item for fulfillment purposes.
shippingitem2StringFalseNoThe second designated shipping item or method associated with the item.
shippingitem3StringFalseNoThe third defined shipping method or item applicable to this product.
shippinglocationsgroupStringFalseNoThe group of shipping locations where this item is available for delivery.
shippingpackaginggroupStringFalseNoThe group that determines the packaging configuration used when shipping this item.
shippingrate1DecimalFalseNoThe first tier or level of the shipping rate applied to this item.
shippingrate2DecimalFalseNoThe second tier of shipping rates assigned to the item, often used for bulk pricing.
shippingrate3DecimalFalseNoThe third shipping rate level, typically used when multiple shipping options are configured.
shipukBooleanFalseNoIf the value is 'true', the item can be shipped to customers located in the United Kingdom.
shipworldwideBooleanFalseNoIf the value is 'true', the item is available for shipping to all supported international destinations.
showasgiftBooleanFalseNoIf the value is 'true', this item is flagged as eligible for gifting on storefronts and receipts.
showdefaultdonationamountBooleanFalseNoIf the value is 'true', a default donation amount is displayed when this item is part of a donation offering.
sitemappriorityStringFalseNoThe priority level this item should have in the site's XML sitemap, which affects search engine indexing.
softdescriptorStringFalseNoA short text description that appears on a customer’s credit card statement when they purchase this item.
standardimagesStringFalseNoThe set of standard images associated with this item for display on web store listings and product pages.
startingpriceDecimalFalseNoThe initial price for this item when used in auction-style listings.
storecatdisplaynameStringFalseNoThe display name of the primary store category this item belongs to, shown on the storefront.
storecatdisplayname2StringFalseNoThe display name of the secondary store category where this item is listed.
storecategoryIntegerFalseNoThe internal ID of the primary store category used to classify this item on the web store.
storecategory2IntegerFalseNoThe internal ID of the secondary store category used for additional classification on the storefront.
storedescriptionStringFalseNoA brief marketing description of the item used on web store listings to attract buyers.
storedetaileddescriptionStringFalseNoA detailed description of the item shown on the web store product page, providing features and benefits.
storedisplayimageStringFalseNoThe image file used as the default product image when the item appears in listings.
storedisplaynameStringFalseNoThe name of the item as it appears on the storefront, customer invoices, and order confirmations.
storedisplaythumbnailStringFalseNoThe thumbnail image used for the item in smaller web store views, such as category listings or promotional banners.
storeitemtemplateStringFalseNoThe template used to format the item's appearance on the web store, including layout and styling.
subsidiaryStringFalseNoThe subsidiary associated with this service item, used in multi-subsidiary environments to manage ownership and availability.
subtypeStringFalseNoThe subtype classification of the item, which provides more detailed categorization within the broader item type.
supersizeimagesBooleanFalseNoIf the value is 'true', the web store displays a larger or high-resolution version of the item's image when available.
taxableBooleanFalseNoIf the value is 'true', the item is subject to tax based on the applicable tax rules and jurisdictions.
taxscheduleStringFalseNoThe tax schedule that determines how tax is calculated for the item based on location, customer, or other criteria.
templatesgroupStringFalseNoThe group of templates used to generate printed or digital documents related to this item, such as invoices or receipts.
unitstypeStringFalseNoThe unit type assigned to the item, which defines how the item is measured and tracked in inventory or service billing.
upccodeStringFalseNoThe Universal Product Code (UPC) assigned to the item, used for barcoding and point-of-sale scanning.
urlcomponentStringFalseNoThe URL-friendly identifier for this item, appended to the website domain to create the item’s product page link.
vendornameStringFalseNoThe name of the preferred vendor or supplier associated with this service item.
vsoedeferralStringFalseNoIndicates the revenue deferral rule under the Vendor-Specific Objective Evidence (VSOE) method for this item.
vsoedeliveredBooleanFalseNoIf the value is 'true', the item is flagged as delivered under VSOE accounting, allowing revenue recognition to proceed.
vsoepermitdiscountStringFalseNoDefines the discount policy that applies to the item under VSOE guidelines, permitting or restricting discounts.
vsoepriceDecimalFalseNoThe established VSOE price for this item, used to allocate revenue in multi-element transactions.
vsoesopgroupStringFalseNoThe grouping this item belongs to for Statement of Position (SOP) revenue recognition under VSOE guidelines.
willshipStringFalseNoIndicates the shipping behavior or preference for the item, such as whether it is fulfilled physically or digitally.

Return to Top

serviceItemBillingRate 

NameTypeReadOnlyReferencesFilterOnlyDescription
billingclassStringFalseNoThe billing class associated with the service item, used to group similar services for billing rate calculations and customer invoicing.
rateDecimalFalseNoThe base price charged for the service item under the specified billing class, typically used as the starting point before discounts or overrides.

Return to Top

serviceItemCorrelateditem 

NameTypeReadOnlyReferencesFilterOnlyDescription
correlationfldDoubleFalseNoThe percentage value representing how strongly this item is correlated with the primary service item, based on historical sales or usage data.
countfldIntegerFalseNoThe number of times this correlated item has been associated with the primary item, indicating the frequency of their co-occurrence.
itemStringFalseNoThe internal identifier for the correlated item; no label is displayed in the interface.
itemnkeyfldStringFalseNoThe unique key representing the correlated item in the system for internal reference and lookups.
liftfldDoubleFalseNoThe lift percentage showing the increase in the likelihood of this item being selected when the primary item is chosen.

Return to Top

serviceItemItemAccountingBookDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe name or identifier of the accounting book that defines the financial rules and currency for reporting associated with this service item.
itemStringFalseNoThe internal reference to the service item.

Return to Top

serviceItemItemQuantityPricingDiscount 

NameTypeReadOnlyReferencesFilterOnlyDescription
leveldiscountDoubleFalseNoThe percentage discount applied at this pricing level based on quantity thresholds for the associated service item.
levelpricenameStringFalseNoThe name of the price level used to determine discount tiers for quantity-based pricing.
parentitemStringFalseNoThe service item to which this quantity pricing discount rule applies.

Return to Top

serviceItemItemQuantityPricingLevel 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe service item that uses this quantity-based pricing level.
leveldiscountDoubleFalseNoThe percentage discount applied when the quantity threshold for this pricing level is met.

Return to Top

serviceItemItemVendor 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe service item associated with this vendor record.
preferredvendorBooleanFalseNoIf the value is 'true', this vendor is marked as the preferred supplier for the item.
purchasepriceStringFalseNoThe purchase price agreed with the vendor for this item, typically in the vendor's currency.
scheduleStringFalseNoThe pricing or procurement schedule linked to this vendor-item relationship.
subsidiaryStringFalseNoThe subsidiary that is authorized to purchase this item from the vendor.
vendorStringFalseNoThe name of the vendor supplying the service item.
vendorcodeStringFalseNoThe internal or external reference code used for this item by the vendor.
vendorcostenteredDecimalFalseNoThe cost entered manually for the item as provided by the vendor.
vendorcurrencyidStringFalseNoThe currency in which the vendor conducts transactions for this item.

Return to Top

serviceItemPresentationItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
basepriceDecimalFalseNoThe base price of the presentation item before any discounts or adjustments are applied.
descriptionStringFalseNoA descriptive summary of the presentation item, used for display and identification purposes.
onlinepriceDecimalFalseNoThe price of the item when listed or sold through an online channel or web store.
presentationitemStringFalseNoThe internal identifier or name of the related presentation item.
presitemidIntegerFalseNoThe internal system ID used to uniquely identify this presentation item record.
superitemStringFalseNoThe parent or grouping item to which this presentation item belongs.

Return to Top

serviceItemPrice 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencypageStringFalseNoThe currency in which the price is specified for this service item.
discountdisplayDoubleFalseNoThe default discount percentage applied to the service item when this price level is used.
isinactiveBooleanFalseNoIf the value is 'true', this price entry is inactive and will not be used in transactions; if the value is 'false', the price is active and available.
itemStringFalseNoThe internal reference to the service item to which this price record belongs.
priceDecimalFalseNoThe actual amount charged for the service item at this price level, before any additional discounts or taxes.

Return to Top

serviceItemQuantity 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe internal identifier of the service item associated with this quantity rule.
maxcountIntegerFalseNoThe maximum quantity of the service item that can be selected or sold in a single transaction.
mincountIntegerFalseNoThe minimum quantity of the service item that must be selected or sold in a single transaction.

Return to Top

serviceItemSiteCategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
categorydescriptionStringFalseNoThe display description for the category where the service item is listed on the website.
isdefaultBooleanFalseNoIf the value is 'true', this category is the preferred or default category for the service item on the specified site.
itemStringFalseNoThe internal identifier of the service item associated with this site category.
websiteStringFalseNoThe website or online store to which the category assignment applies.

Return to Top

serviceItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe internal identifier of the service item that is mapped to a subsidiary. This mapping allows the item to be available for use within the specified subsidiary.

Return to Top

serviceItemTaskTemplate 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe internal identifier of the service item linked to this task template. This ties a specific item to a predefined task structure.
taskdurationDoubleFalseNoThe estimated number of hours required to complete the task associated with the service item.
taskstartoffsetIntegerFalseNoThe number of days before or after the project start date that this task should begin. Used to schedule tasks relative to project timelines.

Return to Top

serviceItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe internal identifier of the service item associated with this translation record.
displaynameStringFalseNoThe localized name of the service item that appears in the storefront or customer-facing interfaces.
languageStringFalseNoThe language in which the service item information is translated, such as English, Spanish, or French.
nopricemessageStringFalseNoA localized message displayed when no price is available for the item in the selected language.
outofstockmessageStringFalseNoA localized message shown when the item is currently out of stock for the selected language or region.
pagetitleStringFalseNoThe translated title of the item page used in browser tabs and search engine results.
salesdescriptionStringFalseNoThe translated marketing or sales description of the item used in customer-facing contexts.
storedescriptionStringFalseNoThe translated brief description of the item displayed in the store catalog.
featureddescriptionStringFalseNoThe translated description used when the item is marked as featured in the store layout.
specialsdescriptionStringFalseNoThe translated promotional description shown when the item is part of a special offer.
storedisplaynameStringFalseNoThe localized name of the item used specifically for online store display purposes.
storedetaileddescriptionStringFalseNoThe translated, detailed description of the item presented on the product detail page.

Return to Top

servicePurchaseItemItemAccountingBookDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe name or internal ID of the accounting book associated with the service purchase item, used for managing parallel accounting standards such as GAAP or IFRS.
itemStringFalseNoThe internal identifier of the service purchase item being mapped to the specified accounting book.

Return to Top

servicePurchaseItemItemVendor 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe internal ID of the service purchase item associated with this vendor record.
preferredvendorBooleanFalseNoIf the value is 'true', this vendor is marked as the preferred vendor for the item. If the value is 'false', the vendor is not preferred.
purchasepriceStringFalseNoThe standard purchase price for the item as agreed with the vendor.
scheduleStringFalseNoThe pricing schedule or vendor contract schedule applied to this item.
subsidiaryStringFalseNoThe subsidiary to which this vendor-item relationship applies, used in multi-subsidiary configurations.
vendorStringFalseNoThe internal ID or name of the vendor supplying the item.
vendorcodeStringFalseNoThe vendor's internal or external code used to reference the item in their system.
vendorcostenteredDecimalFalseNoThe manually entered purchase price of the item from the vendor, used for pricing or audit purposes.
vendorcurrencyidStringFalseNoThe currency in which the vendor's purchase price is denominated, matching the vendor’s default currency or contract.

Return to Top

servicePurchaseItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe internal ID of the service purchase item that is mapped to one or more subsidiaries. This enables the item to be used in transactions specific to those subsidiaries in a multi-subsidiary environment.

Return to Top

servicePurchaseItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe internal ID of the service purchase item to which this translation applies.
displaynameStringFalseNoThe translated display name of the item, used in user interfaces and reports for the specified language.
languageStringFalseNoThe language code or identifier for this translation entry, such as 'en_US' or 'fr_FR'.
nopricemessageStringFalseNoA localized message displayed when pricing is unavailable for the item in the current context or currency.
outofstockmessageStringFalseNoA localized message shown to customers when the item is out of stock in the specified language.
pagetitleStringFalseNoThe translated page title used for search engine optimization (SEO) and display in the browser tab when viewing the item on a web store.
salesdescriptionStringFalseNoThe translated description used for sales purposes, such as quotes or invoices, in the selected language.
storedescriptionStringFalseNoThe localized description of the item for display in the web store.
featureddescriptionStringFalseNoThe translated description used when the item is featured, such as in promotions or highlighted listings.
specialsdescriptionStringFalseNoThe translated description used for limited-time or special offers involving this item.
storedisplaynameStringFalseNoThe localized version of the item’s name displayed on the storefront.
storedetaileddescriptionStringFalseNoThe translated detailed description of the item, providing more comprehensive information to customers in the specified language.

Return to Top

serviceResaleItemBillingRate 

NameTypeReadOnlyReferencesFilterOnlyDescription
billingclassStringFalseNoThe billing class that determines how rates are applied to service resale items for specific groups of customers or transactions.
rateDecimalFalseNoThe base price associated with the billing class for the service resale item. This value is used to calculate the charge before any discounts or markups are applied.

Return to Top

serviceResaleItemCorrelateditem 

NameTypeReadOnlyReferencesFilterOnlyDescription
correlationfldDoubleFalseNoThe correlation percentage indicating the statistical relationship between the sale of this item and the sale of another related item.
countfldIntegerFalseNoThe number of times this correlation has occurred in historical transactions.
itemStringFalseNoThe internal identifier for the service resale item being analyzed for correlation.
itemnkeyfldStringFalseNoThe correlated item that has a notable purchasing relationship with the primary service resale item.
liftfldDoubleFalseNoThe lift percentage representing how much more likely the correlated item is to be purchased when the primary item is purchased.

Return to Top

serviceResaleItemItemAccountingBookDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe name or identifier of the accounting book that contains financial data specific to this service resale item. Used for managing parallel accounting standards or jurisdictions.
itemStringFalseNoThe internal identifier for the service resale item being associated with the specified accounting book.

Return to Top

serviceResaleItemItemQuantityPricingDiscount 

NameTypeReadOnlyReferencesFilterOnlyDescription
leveldiscountDoubleFalseNoThe percentage discount applied at this pricing level for the service resale item. Used in quantity-based pricing tiers to offer reduced rates for bulk purchases.
levelpricenameStringFalseNoThe name of the price level associated with the quantity discount (for example, 'Wholesale' or 'Volume Tier 2').
parentitemStringFalseNoThe internal identifier for the service resale item to which this pricing level and discount apply.

Return to Top

serviceResaleItemItemQuantityPricingLevel 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe internal identifier of the service resale item associated with the quantity pricing level.
leveldiscountDoubleFalseNoThe percentage discount applied at this specific quantity pricing level. This discount is used to incentivize purchases in larger quantities.

Return to Top

serviceResaleItemItemVendor 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe internal identifier of the service resale item linked to the vendor record.
preferredvendorBooleanFalseNoIf the value is 'true', this vendor is marked as the preferred source for purchasing the item.
purchasepriceStringFalseNoThe negotiated purchase price for the item from the vendor.
scheduleStringFalseNoThe vendor schedule that determines the frequency or timing of purchases for this item.
subsidiaryStringFalseNoThe subsidiary for which the vendor relationship is applicable.
vendorStringFalseNoThe name or identifier of the vendor associated with the item.
vendorcodeStringFalseNoThe vendor’s internal code or SKU (Stock Keeping Unit) for the item, if applicable.
vendorcostenteredDecimalFalseNoThe entered cost of the item from the vendor, used for cost tracking and reporting.
vendorcurrencyidStringFalseNoThe currency in which the vendor transaction is conducted.

Return to Top

serviceResaleItemPresentationItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
basepriceDecimalFalseNoThe standard base price for the service resale item before any discounts or promotions.
descriptionStringFalseNoA description of the presentation item as it should appear in listings or marketing materials.
onlinepriceDecimalFalseNoThe price of the service resale item when sold through an online channel, such as an e-commerce site.
presentationitemStringFalseNoThe internal ID of the presentation or related item that groups this item for display or sale purposes.
presitemidIntegerFalseNoThe unique internal ID assigned to the presentation item record in the system.
superitemStringFalseNoThe parent or higher-level item associated with this presentation item, if applicable.

Return to Top

serviceResaleItemPrice 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencypageStringFalseNoThe currency in which the resale item price is listed, such as USD or EUR.
discountdisplayDoubleFalseNoThe default discount percentage applied to the item price for display or calculation purposes.
isinactiveBooleanFalseNoIf the value is 'true', the price entry is marked as inactive and will not be used in pricing calculations.
itemStringFalseNoThe internal ID or reference to the service resale item this price record is associated with.
priceDecimalFalseNoThe price amount for the item in the specified currency, before applying discounts.

Return to Top

serviceResaleItemQuantity 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe internal ID or reference to the service resale item to which the quantity constraints apply.
maxcountIntegerFalseNoThe maximum number of units that can be ordered or processed for this service resale item.
mincountIntegerFalseNoThe minimum number of units that must be ordered or processed for this service resale item.

Return to Top

serviceResaleItemSiteCategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
categorydescriptionStringFalseNoThe description of the site category associated with the service resale item, used for organizing items on the web store.
isdefaultBooleanFalseNoIf the value is 'true', this category is the preferred or default category for the item on the specified site.
itemStringFalseNoThe internal ID or reference to the service resale item assigned to the site category.
websiteStringFalseNoThe identifier of the website or web store where the item and category relationship applies.

Return to Top

serviceResaleItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe internal ID or reference to the service resale item associated with the subsidiary mapping. This link is used to determine availability or accounting treatment of the item across different subsidiaries.

Return to Top

serviceResaleItemTaskTemplate 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe internal ID or reference to the service resale item associated with the task template. This identifies which item the task setup applies to.
taskdurationDoubleFalseNoThe estimated number of hours required to complete the task related to the item.
taskstartoffsetIntegerFalseNoThe number of days after a start event (such as a sales order) when the task should begin.

Return to Top

serviceResaleItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe internal ID or reference to the service resale item for which the translation is provided.
displaynameStringFalseNoThe translated display name of the item as shown to customers in the selected language.
languageStringFalseNoThe language code or name that this translation applies to.
nopricemessageStringFalseNoThe translated message displayed when the item has no associated price in the selected language.
outofstockmessageStringFalseNoThe translated message shown when the item is currently out of stock.
pagetitleStringFalseNoThe translated title of the item page used for search engine optimization (SEO) and browser tabs.
salesdescriptionStringFalseNoThe translated description used in the sales context to explain the item’s purpose or features.
storedescriptionStringFalseNoThe translated description that appears in the online store, giving an overview of the item.
featureddescriptionStringFalseNoThe translated description used to highlight the item in featured promotions or displays.
specialsdescriptionStringFalseNoThe translated description used when the item is part of a special offer or deal.
storedisplaynameStringFalseNoThe translated name of the item as displayed in the store view.
storedetaileddescriptionStringFalseNoThe translated, in-depth description shown on the item's detailed product page in the online store.

Return to Top

serviceSaleItemCorrelateditem 

NameTypeReadOnlyReferencesFilterOnlyDescription
correlationfldDoubleFalseNoThe correlation percentage indicating how frequently the correlated item is purchased alongside the main item.
countfldIntegerFalseNoThe number of times the correlated item was purchased with the main item.
itemStringFalseNoThe internal ID of the primary service sale item for which correlation data is tracked.
itemnkeyfldStringFalseNoThe internal ID of the correlated item associated with the main item.
liftfldDoubleFalseNoThe lift percentage indicating the increase in likelihood that the correlated item will be purchased when the main item is selected.

Return to Top

serviceSaleItemItemAccountingBookDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoThe name or identifier of the accounting book in which the service sale item is recorded.
itemStringFalseNoThe internal ID of the service sale item associated with the specified accounting book.

Return to Top

serviceSaleItemItemQuantityPricingDiscount 

NameTypeReadOnlyReferencesFilterOnlyDescription
leveldiscountDoubleFalseNoThe percentage discount applied at this pricing level for the service sale item.
levelpricenameStringFalseNoThe name of the pricing level used to determine the discount tier for the item.
parentitemStringFalseNoThe internal ID of the service sale item to which the quantity pricing discount applies.

Return to Top

serviceSaleItemItemQuantityPricingLevel 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe internal ID of the service sale item for which the pricing level applies.
leveldiscountDoubleFalseNoThe percentage discount associated with the specific quantity pricing level for the item.

Return to Top

serviceSaleItemPresentationItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
basepriceDecimalFalseNoThe standard or starting price for the presentation item before any discounts are applied.
descriptionStringFalseNoA short description of the service sale item as it will appear in presentations or listings.
onlinepriceDecimalFalseNoThe price of the item specifically shown in online listings or web store presentations.
presentationitemStringFalseNoThe internal ID of the presentation item related to the service sale item.
presitemidIntegerFalseNoThe unique internal identifier for this presentation item entry.
superitemStringFalseNoThe parent or primary service item to which this presentation item is linked.

Return to Top

serviceSaleItemPrice 

NameTypeReadOnlyReferencesFilterOnlyDescription
currencypageStringFalseNoThe currency in which the item's price is displayed or recorded, such as USD or EUR.
discountdisplayDoubleFalseNoThe default discount percentage applied to this item for display or pricing purposes.
isinactiveBooleanFalseNoIf the value is 'true', the pricing entry is marked as inactive and is not used in transactions. If the value is 'false', the pricing is active.
itemStringFalseNoThe internal identifier of the service sale item to which this pricing entry applies.
priceDecimalFalseNoThe monetary amount assigned to the item, representing its price before discounts or taxes.

Return to Top

serviceSaleItemQuantity 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe internal identifier of the service sale item for which quantity thresholds are defined.
maxcountIntegerFalseNoThe maximum number of units allowed for the item in a single transaction or inventory setting.
mincountIntegerFalseNoThe minimum number of units required for the item in a single transaction or inventory setting.

Return to Top

serviceSaleItemSiteCategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
categorydescriptionStringFalseNoA short description of the website category to which the service sale item belongs.
isdefaultBooleanFalseNoIf the value is 'true', this category is marked as the preferred or default site category for the item.
itemStringFalseNoThe internal identifier of the service sale item being associated with the site category.
websiteStringFalseNoThe specific website or web store where the item and category association applies.

Return to Top

serviceSaleItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe internal identifier of the service sale item that is being mapped to one or more subsidiaries for use in a multi-subsidiary environment.

Return to Top

serviceSaleItemTaskTemplate 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe internal identifier of the service sale item associated with the task template.
taskdurationDoubleFalseNoThe estimated effort required to complete the task, expressed in hours.
taskstartoffsetIntegerFalseNoThe number of days to offset from the project or item start date to begin the task.

Return to Top

serviceSaleItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe internal identifier of the service sale item to which the translation applies.
displaynameStringFalseNoThe localized name displayed for the item on the storefront or user interface.
languageStringFalseNoThe language code or name representing the language of the translation.
nopricemessageStringFalseNoThe message shown when no price is available for the item in the specified language.
outofstockmessageStringFalseNoThe message displayed when the item is out of stock in the specified language.
pagetitleStringFalseNoThe localized page title used for the item’s product detail page.
salesdescriptionStringFalseNoThe translated sales description of the item, used in sales and marketing contexts.
storedescriptionStringFalseNoThe localized version of the item description shown in the online store.
featureddescriptionStringFalseNoThe translated text used for promoting the item as a featured product.
specialsdescriptionStringFalseNoThe translated message highlighting the item as part of a special offer or promotion.
storedisplaynameStringFalseNoThe localized name shown for the item in the online store navigation and listings.
storedetaileddescriptionStringFalseNoThe full translated description of the item used in the detailed view on the store page.

Return to Top

ShipGroup 

NameTypeReadOnlyReferencesFilterOnlyDescription
destinationaddressStringFalseNoThe shipping destination address where the items in this shipping group will be delivered.
docStringFalseNoThe internal reference or identifier for the associated transaction or document.
handlingrateDecimalFalseNoThe handling fee charged for this shipping group, typically covering packaging and processing costs.
shippingmethodStringFalseNoThe shipping method or carrier used to ship the items in this group (for example, UPS Ground or FedEx Overnight).
shippingrateDecimalFalseNoThe shipping cost applied to this shipping group based on the selected method and weight/destination.
sourceaddressStringFalseNoThe origin address from which the items in this shipping group will be shipped.
uniquekeyIntegerFalseNoA unique identifier for this specific shipping group record, used for reference and tracking.

Return to Top

shipitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the shipping item.
accountStringFalseNoThe account used for shipping-related transactions.
accounthandlingStringFalseNoThe account used for handling fee transactions.
costbasisStringFalseNoThe base rate used for calculating shipping costs.
countriesStringFalseNoList of countries where this shipping item is available.
descriptionStringFalseNoDetailed information or notes about the shipping item.
discountrateDoubleFalseNoThe rate at which a discount is applied to the shipping cost.
displaynameStringFalseNoThe name or code used to identify the shipping item.
doiftotalBooleanFalseNoSpecifies whether website visibility is limited by the total order amount.
doiftotalamtDecimalFalseNoThe minimum order amount required for visibility on the website.
doiftotaloperatorStringFalseNoThe criteria type used for website visibility based on total.
doifweightamtDoubleFalseNoThe minimum weight required for website visibility.
doifweightoperatorStringFalseNoThe criteria type used for website visibility based on weight.
doifweightunitStringFalseNoThe unit of measure (UOM) for weight visibility settings.
excludecountriesBooleanFalseNoSpecifies whether the shipping item is not available for specific countries.
excludesitesBooleanFalseNoSpecifies whether the shipping item is not available for specific sites.
externalidStringFalseNoAn external identifier that links to other systems or data.
fedexonerateBooleanFalseNoSpecifies whether FedEx One Rate® pricing applies.
freeifordertotalisoveramountDecimalFalseNoSpecifies the order total over which shipping is free.
handlingaspercentageoftotalDoubleFalseNoHandling fee as a percentage of the total order cost.
handlingbyweightamountDecimalFalseNoHandling fee calculated based on the total weight of the order.
handlingbyweightperquantityDoubleFalseNoHandling fee rate per unit weight.
handlingbyweightperunitStringFalseNoUOM for the handling fee by weight.
handlingcostStringFalseNoBase rate used for calculating handling costs.
handlingflatrateamountDecimalFalseNoFlat fee applied to the handling cost regardless of weight or quantity.
handlingperitemamountDecimalFalseNoHandling fee calculated per item in the order.
handlingtablechargebyStringFalseNoThe type of table used for calculating handling rates.
handlingtableuomStringFalseNoUOM for handling rate calculations.
hasmaximumshippingcostBooleanFalseNoSpecifies whether a maximum limit on shipping cost is set.
hasminimumshippingcostBooleanFalseNoSpecifies whether a minimum limit on shipping cost is set.
integrationservicecodeStringFalseNoCode used for integrating shipping label generation.
invt_dispnameStringFalseNoName displayed on the website or interface.
isfreeifordertotalisoverBooleanFalseNoSpecifies whether shipping is free when the order total exceeds a threshold.
ishandlingbyweightbracketedBooleanFalseNoSpecifies whether the handling rate is calculated in brackets based on weight.
isinactiveBooleanFalseNoSpecifies whether the shipping item is currently inactive or disabled.
isonlineBooleanFalseNoSpecifies whether the shipping item is available on the website.
isshippingbyweightbracketedBooleanFalseNoSpecifies whether the shipping rate is calculated in brackets based on weight.
itemidStringFalseNoName assigned to the shipping item for identification.
maximumshippingcostDecimalFalseNoThe highest allowable shipping charge.
minimumshippingcostDecimalFalseNoThe lowest allowable shipping charge.
needsallfreeshippingitemsBooleanFalseNoSpecifies whether all items must be ordered for the shipping item to apply.
omitpackagingBooleanFalseNoSpecifies whether packaging costs are omitted.
returnservicecodeStringFalseNoCode used for integrating return label generation.
servicecodeStringFalseNoCode used to identify the shipping service provider.
shippingaspercentageoftotalDoubleFalseNoShipping fee as a percentage of the total order cost.
shippingbyweightamountDecimalFalseNoShipping fee calculated based on the total weight of the order.
shippingbyweightperquantityDoubleFalseNoShipping fee rate per unit weight.
shippingbyweightperunitStringFalseNoUOM for the shipping fee by weight.
shippingflatrateamountDecimalFalseNoFlat fee applied to the shipping cost regardless of weight or quantity.
shippingperitemamountDecimalFalseNoShipping fee calculated per item in the order.
shippingtablechargebyStringFalseNoThe type of table used for calculating shipping rates.
shippingtableuomStringFalseNoUOM for shipping rate calculations.
siteStringFalseNoSites to which this shipping item is restricted.
statesStringFalseNoList of states where this shipping item is available.
subsidiaryStringFalseNoAssociated subsidiaries that use this shipping item.

Return to Top

ShipItemFreeShippingItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe name or identifier of the item associated with the shipping item.
shipitemStringFalseNoAn undefined label, likely referring to a general shipping item or placeholder.

Return to Top

ShipItemHandlingRate 

NameTypeReadOnlyReferencesFilterOnlyDescription
handlingtablechargeDecimalFalseNoThe fee applied based on the handling-rate table calculation.
shipitemStringFalseNoAn undefined label, likely referring to a general shipping item or placeholder.

Return to Top

ShipItemShippingRate 

NameTypeReadOnlyReferencesFilterOnlyDescription
shipitemStringFalseNoAn undefined label, likely referring to a general shipping item or placeholder.
shippingtablechargeDecimalFalseNoThe fee applied based on the shipping-rate table calculation.

Return to Top

ShipItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
displaynameStringFalseNoThe user-friendly name displayed for the shipping item or related entity.
languageStringFalseNoThe language associated with the display name or content.

Return to Top

ShipmentPackage 

NameTypeReadOnlyReferencesFilterOnlyDescription
admissibilitypackagetypeStringFalseNoThe type of package required for admissibility purposes.
alcoholrecipienttypeStringFalseNoSpecifies whether the recipient is allowed to receive alcohol shipments.
authorizationnumberStringFalseNoThe authorization or permit number associated with the shipment.
carrierpackagingStringFalseNoThe type of packaging provided by the carrier for the shipment.
cashondeliveryamountDecimalFalseNoThe monetary amount to be collected upon delivery.
cashondeliverymethodStringFalseNoThe payment method used for cash on delivery (COD) transactions.
codotherchargeDecimalFalseNoAdditional charge associated with a COD transaction.
contentsdescriptionStringFalseNoA description of the contents of the shipment.
declaredvalueDecimalFalseNoThe value declared for insurance or customs purposes.
deliveryconfirmationStringFalseNoThe type of delivery confirmation required for the shipment.
dimensionunitStringFalseNoThe unit of measurement for package dimensions (for example, inches or centimeters).
dryiceweightDoubleFalseNoThe weight of dry ice included in the shipment, if applicable.
freightchargeaddedtocodStringFalseNoSpecifies whether freight charges are added to the COD amount.
hasadditionalhandlingBooleanFalseNoSpecifies whether the shipment requires special handling instructions.
hascashondeliveryBooleanFalseNoSpecifies whether the shipment is being sent with COD service.
hasdeclaredvalueBooleanFalseNoSpecifies whether a declared value has been specified for the shipment.
hasinsuredvalueBooleanFalseNoSpecifies whether the shipment is covered by insurance.
heightIntegerFalseNoThe height of the package being shipped.
insuredvalueDecimalFalseNoThe amount of insurance coverage applied to the shipment.
isalcoholBooleanFalseNoSpecifies whether the shipment contains alcoholic beverages.
isnonhazardouslibatteriesBooleanFalseNoSpecifies whether the shipment contains non-hazardous lithium batteries.
isnonstandardcontainerBooleanFalseNoSpecifies whether the package is a non-standard container.
itemfulfillmentStringFalseNoThe specific item fulfillment instance related to the shipment.
lengthIntegerFalseNoThe length of the package being shipped.
priorityalertcontentStringFalseNoDescription of the contents for priority alert purposes.
priorityalerttypeStringFalseNoThe type of priority alert applied to the shipment (for example, critical, standard).
referenceStringFalseNoAdditional reference or tracking information for the shipment.
reference2StringFalseNoA secondary reference or tracking information field.
sequencenumberIntegerFalseNoThe order in which this package appears within a multi-package shipment.
signatureoptionStringFalseNoThe signature option selected for FedEx shipments (for example, direct, indirect, adult signature required).
signaturereleaseStringFalseNoAuthorization allowing the package to be delivered without a signature.
trackingnumberStringFalseNoThe tracking number assigned to the shipment for monitoring purposes.
weightinlbsDoubleFalseNoThe total weight of the shipment, measured in pounds.
widthIntegerFalseNoThe width of the package being shipped.

Return to Top

ShipperPackageTypeCode 

NameTypeReadOnlyReferencesFilterOnlyDescription
codeStringFalseNoA unique code representing the shipping item or carrier.
inactiveBooleanFalseNoSpecifies whether the item or carrier is currently inactive or unavailable.
keyIntegerFalseNoUnique identifier for the shipping item or carrier.
nameStringFalseNoThe name of the shipping item, carrier, or related entity.
shipperStringFalseNoThe shipping service provider associated with the item.

Return to Top

shippingMethodRuleRelation 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoThe specific item being shipped, identified by its name or code.
parentStringFalseNoAn undefined label, likely referring to a parent item or general category.

Return to Top

ShippingPackage 

NameTypeReadOnlyReferencesFilterOnlyDescription
pkgdefaultBooleanFalseNoSpecifies whether this package is the default option for shipping.
pkgheightIntegerFalseNoThe height of the package being shipped, measured in specified units.
pkgkeyIntegerFalseNoUnique identifier for the package configuration or definition.
pkglengthIntegerFalseNoThe length of the package being shipped, measured in specified units.
pkgmaxitemsIntegerFalseNoThe maximum number of items that can be contained within the package.
pkgnameStringFalseNoThe name or label assigned to the package configuration.
pkgweightDoubleFalseNoThe weight of the package, measured in specified units.

Return to Top

shoppingcart 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoThe unique internal identifier for the shopping cart or transaction.
customerStringFalseNoThe customer associated with the shopping cart or transaction.
datecreatedDateFalseNoThe date when the shopping cart was first created.
datemodifiedDateFalseNoThe most recent date an item was added to the shopping cart.
subtotalDecimalFalseNoThe total amount of all items in the cart before taxes, discounts, or shipping.

Return to Top

ShoppingCartLine 

NameTypeReadOnlyReferencesFilterOnlyDescription
cartStringFalseNoThe identifier for the shopping cart containing the listed items.
itemStringFalseNoThe name or identifier of the item added to the shopping cart.
lastaddtocartDateFalseNoThe date when the item was last added to the shopping cart.
qtyIntegerFalseNoThe quantity of the specific item in the shopping cart.
unitpriceDecimalFalseNoThe price of each individual item in the shopping cart.

Return to Top

siteAudience 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique identifier for the specific record or configuration.
allcustomersBooleanFalseNoSpecifies whether the setting applies to all customers.
allemployeesBooleanFalseNoSpecifies whether the setting applies to all employees.
allpartnersBooleanFalseNoSpecifies whether the setting applies to all partners.
allrolesBooleanFalseNoSpecifies whether the setting applies to all roles within the system.
allvendorsBooleanFalseNoSpecifies whether the setting applies to all vendors.
audcustomerStringFalseNoThe list of specific customers included in the setting.
auddepartmentStringFalseNoThe list of departments included in the setting.
audemployeeStringFalseNoThe list of specific employees included in the setting.
audgroupStringFalseNoThe list of specific groups included in the setting.
audpartnerStringFalseNoThe list of specific partners included in the setting.
audslctroleStringFalseNoThe list of specific roles included in the setting.
audsubsidiaryStringFalseNoThe list of subsidiaries included in the setting.
isonlineBooleanFalseNoSpecifies whether the setting is available for display on the website.

Return to Top

siteAudienceCustomer 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoAn undefined label, likely referring to a target audience or group.

Return to Top

siteAudienceDepartment 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoAn undefined label, potentially representing a targeted audience or user group.

Return to Top

siteAudienceEmployee 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoAn unspecified label, likely indicating a target audience or category associated with the item.

Return to Top

siteAudienceGroup 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoAn undefined label, possibly referring to a specific audience or user group targeted by the item.

Return to Top

siteAudiencePartner 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoAn unspecified label, potentially indicating a defined audience or user group associated with the item.

Return to Top

siteAudienceRole 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoAn undefined label, likely referring to a targeted audience or group associated with the item.

Return to Top

siteAudienceSubsidiary 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoAn undefined label, possibly referring to a targeted audience or user segment associated with the item.

Return to Top

siteAudienceVendor 

NameTypeReadOnlyReferencesFilterOnlyDescription
audienceStringFalseNoAn unspecified label, likely referring to a target audience or group for this item or setting.

Return to Top

sitecategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique identifier assigned to each category entry.
categorylistlayoutStringFalseNoThe layout format used for displaying categories on the site.
correlateditemslistlayoutStringFalseNoThe layout format for displaying upsell items related to the category.
currentaudienceStringFalseNoThe specific group or audience targeted by this category entry.
excludefromsitemapBooleanFalseNoSpecifies whether this category should be excluded from the sitemap.
externalidStringFalseNoAn external identifier that links to another system or reference.
fullnameStringFalseNoThe complete name of the category, including hierarchy if applicable.
isinactiveBooleanFalseNoSpecifies whether this category is currently inactive or hidden.
isonlineBooleanFalseNoSpecifies whether the category is available for display on the website.
itemlistlayoutStringFalseNoThe layout format used for displaying items under this category.
metataghtmlStringFalseNoHTML content for meta tags associated with this category, enhancing search engine optimization (SEO).
nameStringFalseNoThe name of the category being defined.
pagetitleStringFalseNoThe title displayed for the category page, used for SEO and navigation.
parentStringFalseNoThe parent category to which this category belongs, if applicable.
relateditemslistlayoutStringFalseNoThe layout format used for displaying related items.
searchkeywordsStringFalseNoKeywords associated with the category to improve searchability.
sectiondescriptionStringFalseNoA brief description of the category's purpose or content.
sectiondetaileddescriptionStringFalseNoA more comprehensive description of the category, providing detailed information.
sitecategorytypeStringFalseNoThe classification type of the category (for example, standard or special).
sitemappriorityStringFalseNoThe priority level of the category within the sitemap structure.
storedisplayimageStringFalseNoThe primary image associated with the category for display purposes.
storedisplaythumbnailStringFalseNoA smaller version of the primary image, typically used for preview displays.
urlcomponentStringFalseNoThe specific URL path segment used to access this category on the site.

Return to Top

siteCategoryPresItemPresCategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
basepriceDecimalFalseNoThe standard price of the item before any discounts or adjustments.
categoryStringFalseNoAn unspecified category, possibly referring to a grouping or classification of items.
descriptionStringFalseNoA detailed description of the item, providing essential information.
filecabinetStringFalseNoThe location within the file storage system where the item is stored.
infoitemStringFalseNoA descriptive or informational item not meant for sale but for reference.
itemStringFalseNoThe specific product or service being referenced.
nameStringFalseNoThe name or title assigned to the item.
onlinepriceDecimalFalseNoThe price of the item as displayed online, which may differ from the base price.

Return to Top

siteCategoryTagSubstitution 

NameTypeReadOnlyReferencesFilterOnlyDescription
sectionStringFalseNoThe section or segment of the document or item where the value is applied.
valueStringFalseNoA placeholder value that is substituted dynamically during processing.

Return to Top

siteCategoryTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoA short description or greeting that provides a quick overview or welcoming message.
displaynameStringFalseNoThe name, title, or category associated with the item for identification purposes.
languageStringFalseNoThe language in which the content is presented or displayed.
pagetitleStringFalseNoThe title displayed on the page, useful for search engine optimization (SEO) and user navigation.
salesdescriptionStringFalseNoA comprehensive description or message providing detailed information.

Return to Top

siteCategoryType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier or lookup key used for referencing specific data.

Return to Top

sitetheme 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoA unique numeric identifier used for referencing specific data entries.

Return to Top

softDescriptor 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoA unique numeric identifier used for referencing specific entries or records.

Return to Top

soldOnTransaction 

NameTypeReadOnlyReferencesFilterOnlyDescription
snumberStringFalseNoThe unique code or serial number associated with a gift certificate.

Return to Top

solution 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier assigned to this record.
assignedStringFalseNoThe individual or group responsible for managing this record.
displayonlineBooleanFalseNoSpecifies whether this record is visible on the website or online interface.
externalidStringFalseNoAn identifier used to link this record to external systems or integrations.
isinactiveBooleanFalseNoSpecifies whether this record is currently inactive or not in use.
longdescriptionStringFalseNoA detailed description providing more context about this record.
messageStringFalseNoA brief summary or high-level overview of the record's content or purpose.
solutionsStringFalseNoAssociated solutions or related information linked to this record.
statusStringFalseNoThe current state or condition of the record (for example, active, pending, or completed).
titleStringFalseNoThe title or name associated with this record.

Return to Top

solutionSolutionMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
relatedsolutionStringFalseNoAn undefined label, likely referring to a related solution or associated record.

Return to Top

solutiontopicmap 

NameTypeReadOnlyReferencesFilterOnlyDescription
solutionStringFalseNoAn unspecified label, likely referring to a solution or resolution associated with a record.

Return to Top

specialAccountType 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoA unique string identifier associated with the record or entry.

Return to Top

standardcostdefaulttype 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique internal identifier used to reference specific records or entries.

Return to Top

standardCostVersion 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique numeric identifier assigned to this inventory record.
externalidStringFalseNoAn identifier used to link this record to external systems or data sources.
inventorystandardcostStringFalseNoThe standard cost assigned to inventory items for valuation purposes.
locationStringFalseNoThe various locations where the inventory items are stored or available.
nameStringFalseNoThe name or label associated with the inventory record.

Return to Top

standardCostVersionLocationMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
locationStringFalseNoAn unspecified label, likely referring to a specific inventory location or storage area.

Return to Top

statisticaljournalentry 

NameTypeReadOnlyReferencesFilterOnlyDescription
approvedBooleanFalseNoSpecifies whether the transaction or record has been approved.
createddateDatetimeFalseNoThe date and time when the transaction or record was created.
customformStringFalseNoThe specific form or template used for recording this transaction.
externalidStringFalseNoAn external identifier used to link this record to external systems or references.
memoStringFalseNoA note or comment providing additional information about the transaction.
parentexpenseallocStringFalseNoThe parent expense allocation associated with this record, if applicable.
postingperiodStringFalseNoThe financial period in which the transaction is posted.
reversaldateDateFalseNoThe date on which the transaction reversal is scheduled to occur.
reversaldeferBooleanFalseNoSpecifies whether the transaction reversal is deferred to a later date.
subsidiaryStringFalseNoThe subsidiary or business unit associated with this transaction.
trandateDateFalseNoThe date when the transaction occurred.
tranidStringFalseNoThe transaction identifier or reference number.
unitstypeStringFalseNoThe type of units associated with the transaction or record (for example, hours or items).

Return to Top

statisticalScheduleDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
classStringFalseNoThe classification or category associated with the transaction or record.
currentbalanceIntegerFalseNoThe current balance or amount associated with the transaction or record.
dateDateFalseNoThe specific date associated with the transaction or record entry.
departmentStringFalseNoThe department linked to the transaction or record for reporting purposes.
differenceIntegerFalseNoThe difference between the current and previous balances.
entityStringFalseNoThe name of the entity associated with the transaction or record.
locationStringFalseNoThe specific location related to the transaction or record.
parentscheduleStringFalseNoThe parent schedule associated with the transaction or record, if applicable.
previousbalanceIntegerFalseNoThe previous balance or amount before the current transaction occurred.
runidIntegerFalseNoA unique identifier for the processing run associated with this transaction or record.
statisticaljournalStringFalseNoThe statistical journal associated with the transaction, if applicable.

Return to Top

stockBehaviorType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique string identifier or key used for referencing specific entries.
nameStringFalseNoThe name or title associated with the record or entry.

Return to Top

storepickupfulfillment 

NameTypeReadOnlyReferencesFilterOnlyDescription
createdfromStringFalseNoThe original transaction or record from which this record was created.
customformStringFalseNoThe specific form or template used to capture this record's details.
entityStringFalseNoThe person or organization associated with this record.
locationStringFalseNoThe physical or virtual location relevant to this record.
memoStringFalseNoAn additional note or description providing context for this record.
pickeddateDateFalseNoThe date when the item was picked for processing or fulfillment.
pickedupdateDateFalseNoThe date when the picked status was last updated.
pickupexpirationdateDateFalseNoThe date when the pickup process is set to expire if not completed.
pickupstatusStringFalseNoThe current status of the pickup process (for example, pending or completed).
requestedbyStringFalseNoThe individual or entity that initiated the request for this record.
statusStringFalseNoThe current status of the transaction or record (for example, open, closed, or pending).
trandateDateFalseNoThe date on which the transaction occurred.
tranidStringFalseNoThe unique identifier or reference number assigned to the transaction.

Return to Top

storeTab 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique identifier assigned to this section or record.
categorylistlayoutStringFalseNoThe layout format used for displaying categories on the site.
correlateditemslistlayoutStringFalseNoThe layout format used for displaying upsell items related to the category.
currentaudienceStringFalseNoThe group or audience targeted by this section or content.
excludefromsitemapBooleanFalseNoSpecifies whether this section should be excluded from the sitemap.
isinactiveBooleanFalseNoSpecifies whether this section is currently inactive or hidden.
isonlineBooleanFalseNoSpecifies whether the section is available for display on the website.
itemlistlayoutStringFalseNoThe layout format used for displaying items within this section.
limitedsearchBooleanFalseNoRestricts search capabilities within this section.
mediaitemStringFalseNoThe webpage associated with this content or section.
metataghtmlStringFalseNoHTML tags used for metadata, improving search engine optimization (SEO).
mstoreflashStringFalseNoThe image or multimedia file used for visual representation.
orderconfirmationmessageStringFalseNoThe message displayed to users upon successful order placement.
pagetitleStringFalseNoThe title displayed on the page, useful for SEO and navigation.
placeordermessageStringFalseNoThe message shown to users during the order placement process.
relateditemslistlayoutStringFalseNoThe layout format used for displaying related items within this section.
sectiondescriptionStringFalseNoA brief introduction or welcome message for the section.
sectiondetaileddescriptionStringFalseNoA detailed message or description providing additional information.
siteStringFalseNoThe website where this section or content is displayed.
sitemappriorityStringFalseNoThe priority level of the section within the sitemap.
tabnameStringFalseNoThe label or name assigned to the tab or section.
tabtypeStringFalseNoThe type of tab used for organizing content (for example, information, product, or media).
urlcomponentStringFalseNoThe specific URL segment used to access this section on the site.

Return to Top

storeTabPresItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
basepriceDecimalFalseNoThe standard price of the item before any discounts or promotions are applied.
categoryStringFalseNoAn unspecified category, possibly referring to a classification or grouping of items.
descriptionStringFalseNoA detailed description providing information about the item's features and purpose.
filecabinetStringFalseNoThe storage location within the system where the item-related documents are kept.
infoitemStringFalseNoA non-purchasable item meant to provide additional information or context.
itemStringFalseNoThe product or service being referenced, identified by its name or code.
nameStringFalseNoThe name or title used to identify the item within the system.
onlinepriceDecimalFalseNoThe price of the item displayed for online transactions, which can differ from the base price.

Return to Top

storeTabSiteCategoryTranslationStoreTab 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoA short welcoming or introductory message displayed to users.
displaynameStringFalseNoThe name or title associated with this record, used for identification purposes.
languageStringFalseNoThe language in which the content is presented or intended to be displayed.
pagetitleStringFalseNoThe title displayed on the page, useful for search engine optimization (SEO) and user navigation.
salesdescriptionStringFalseNoA detailed message or description providing additional information.

Return to Top

storeTabTagSubstitution 

NameTypeReadOnlyReferencesFilterOnlyDescription
sectionStringFalseNoA specific part or segment of the document or content where the value applies.
valueStringFalseNoA value that is dynamically replaced within the content or template.

Return to Top

storeTabType 

NameTypeReadOnlyReferencesFilterOnlyDescription
nameStringFalseNoThe name or title associated with this record, used for identification or categorization.

Return to Top

sublist 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique identifier for this record, used for internal reference.
assemblybuildBooleanFalseNoSpecifies whether the transaction involves building an assembly item.
billofmaterialsBooleanFalseNoSpecifies whether the transaction involves a bill of materials or an assembly record.
callBooleanFalseNoA record of a phone call related to a customer, partner, or other entity.
campaignBooleanFalseNoA marketing campaign or promotional effort.
contactBooleanFalseNoAn individual or entity's contact record within the system.
customerBooleanFalseNoAn individual or organization that purchases goods or services.
customtransactionsStringFalseNoUser-defined transactions customized for specific business needs.
depositBooleanFalseNoA monetary deposit made by or received from a customer or vendor.
depositapplicationBooleanFalseNoA record of applying a deposit to an outstanding invoice or bill.
employeeBooleanFalseNoAn individual employed by the organization.
eventBooleanFalseNoA scheduled or completed event related to a customer, partner, or other entity.
expenseitemBooleanFalseNoAn individual expense item recorded for reimbursement or tracking.
expensereportBooleanFalseNoA report summarizing multiple expenses submitted for approval or reimbursement.
fulfillmentrequestBooleanFalseNoA request for fulfilling a specific order or item delivery.
inventoryadjustmentBooleanFalseNoRecords of changes made to inventory levels.
inventoryitemBooleanFalseNoA tangible or intangible item stored in inventory for sale or use.
issueBooleanFalseNoA reported problem or bug logged for tracking and resolution.
itemfulfillmentBooleanFalseNoThe process of shipping or delivering an item to a customer.
itemgroupBooleanFalseNoA collection of related items or entities treated as a single unit.
itemreceiptBooleanFalseNoThe receipt of items from a vendor, confirming the physical delivery.
jobBooleanFalseNoA project or task tracked over time with associated resources and costs.
journalBooleanFalseNoA record of financial transactions recorded within the system.
kitBooleanFalseNoA predefined group of items sold as a single unit.
labelStringFalseNoA descriptive tag or identifier associated with the record.
noninventoryitemBooleanFalseNoAn item that is not kept in inventory, such as a service or expense item.
opportunityBooleanFalseNoA potential sales deal or project being pursued.
otherchargeBooleanFalseNoA miscellaneous charge not directly associated with a product or service.
partnerBooleanFalseNoA business partner associated with the organization for collaborations or referrals.
paymentBooleanFalseNoA financial transaction involving the transfer of funds.
purchaseBooleanFalseNoA record of a purchase transaction involving goods or services.
saleBooleanFalseNoA record of a sales transaction involving goods or services.
savedsearchStringFalseNoA saved search configuration for retrieving specific records or data.
scriptidStringFalseNoA unique identifier for a custom script used within the system.
serviceBooleanFalseNoAn intangible item provided as a service to customers.
solutionBooleanFalseNoA documented resolution to a reported issue or problem.
storepickupBooleanFalseNoThe process of fulfilling an order where the customer picks up the item at a designated location.
sublisttypeStringFalseNoThe classification or type of sublist associated with the record.
taskBooleanFalseNoA specific activity or assignment to be completed by an individual or group.
vendorBooleanFalseNoA business or individual providing goods or services to the organization.

Return to Top

subscription 

NameTypeReadOnlyReferencesFilterOnlyDescription
advancerenewalperiodnumberIntegerFalseNoThe number of periods before renewal that notifications are sent.
advancerenewalperiodunitStringFalseNoThe unit of time used for advance renewal notifications (for example, days or months).
autonameBooleanFalseNoSpecifies whether the record is automatically named based on system rules.
autorenewalBooleanFalseNoSpecifies if the subscription automatically renews upon expiration.
billingaccountStringFalseNoThe billing account associated with the subscription.
billingaccountstartdateDateFalseNoThe start date of the billing account's active period.
billingscheduleStringFalseNoThe schedule governing billing frequency and amounts.
billingsubscriptionstatusStringFalseNoThe current status of the subscription's billing (for example, active or inactive).
classStringFalseNoThe classification or category assigned to the subscription for reporting purposes.
currencyStringFalseNoThe currency used for transactions related to this subscription.
customerStringFalseNoThe customer associated with this subscription record.
customformStringFalseNoThe specific form template used for capturing this subscription record.
defaultrenewalmethodStringFalseNoThe standard method used for handling subscription renewals.
defaultrenewalplanStringFalseNoThe default plan applied when the subscription is renewed.
defaultrenewalpricebookStringFalseNoThe default price book used during subscription renewal.
defaultrenewaltermStringFalseNoThe standard duration of the renewal period.
defaultrenewaltrantypeStringFalseNoThe type of transaction generated during renewal (for example, sales order or invoice).
departmentStringFalseNoThe department associated with the subscription for reporting or billing purposes.
enddateDateFalseNoThe date when the subscription expires or ends.
estimatedrevrecenddateDateFalseNoThe estimated date for the end of revenue recognition for this subscription.
externalidStringFalseNoAn external identifier used to link this record to other systems.
frequencyStringFalseNoThe frequency of subscription billing (for example, monthly or annually).
idIntegerFalseNoThe unique identifier for this subscription record.
idnumberStringFalseNoThe unique identification number assigned to the subscription.
initialtermStringFalseNoThe initial term length for the subscription.
initialtermdurationStringFalseNoThe duration of the initial term (for example, 12 months).
initialtermtypeStringFalseNoThe type of initial term applied (for example, fixed or evergreen).
initialtermunitsStringFalseNoThe units of time used for defining the initial term (for example, months or years).
internalidIntegerFalseNoA unique internal identifier used within the system.
lastbillcycledateDateFalseNoThe date when the last billing cycle was completed.
lastbilldateDateFalseNoThe date when the last bill was generated.
locationStringFalseNoThe location associated with the subscription.
nameStringFalseNoThe name assigned to the subscription or plan.
nextbillcycledateDateFalseNoThe scheduled date for the next billing cycle.
nextrenewalstartdateDateFalseNoThe start date of the next scheduled renewal period.
otherrecordnumberStringFalseNoA reference number linking to another related record.
pricebookStringFalseNoThe pricing structure or catalog used for this subscription.
renewalnumberIntegerFalseNoThe number of times this subscription has been renewed.
salesorderStringFalseNoThe sales order associated with this subscription.
startdateDateFalseNoThe start date of the subscription's active period.
subscriptionplanStringFalseNoThe subscription plan applied to this record.
subscriptionplannameStringFalseNoThe name of the subscription plan associated with this record.
subscriptionrevisionIntegerFalseNoThe revision number indicating updates or changes to the subscription.
subsidiaryStringFalseNoThe subsidiary or business unit linked to this subscription.
templatestoredBooleanFalseNoSpecifies whether the subscription template is stored within the system.

Return to Top

subscriptionchangeorder 

NameTypeReadOnlyReferencesFilterOnlyDescription
approvaldateDatetimeFalseNoThe date and time when the record or subscription was approved.
approvalstatusStringFalseNoThe current status of the approval process (for example, pending, approved, or rejected).
billingaccountStringFalseNoThe billing account associated with the subscription or transaction.
createdbyStringFalseNoThe individual or system responsible for creating the record.
customerStringFalseNoThe customer associated with this subscription or transaction.
datecreatedDatetimeFalseNoThe date and time when the record was initially created.
effectivedateDateFalseNoThe date when the subscription or transaction becomes effective.
externalidStringFalseNoAn external identifier used to link this record to external systems or references.
idnumberStringFalseNoA unique identification number assigned to this record or transaction.
memoStringFalseNoA note or comment providing additional context or information about the record.
reactivationoptionStringFalseNoThe option selected for reactivating the subscription or transaction.
renewalenddateDateFalseNoThe end date of the current subscription or renewal period.
renewalmethodStringFalseNoThe method used to handle subscription renewals (for example, manual or automatic).
renewalplanStringFalseNoThe subscription plan applied during the renewal process.
renewalpricebookStringFalseNoThe pricing structure applied during the renewal process.
renewalstartdateDateFalseNoThe start date of the new subscription period following renewal.
renewaltermStringFalseNoThe length of the subscription renewal period.
renewaltrantypeStringFalseNoThe type of transaction used for renewal processing (for example, invoice or sales order).
requestoffcycleinvoiceBooleanFalseNoSpecifies whether an off-cycle invoice is requested for the subscription.
requestorStringFalseNoThe individual or entity that initiated the subscription request.
subscriptionStringFalseNoThe specific subscription record being referenced.
subscriptionplanStringFalseNoThe subscription plan associated with this record.
subscriptiontermdurationStringFalseNoThe length of the subscription term (for example, 12 months or 1 year).
subscriptiontermtypeStringFalseNoThe type of subscription term (for example, fixed or evergreen).
subsidiaryStringFalseNoThe subsidiary or business unit associated with this subscription or transaction.

Return to Top

subscriptionChangeOrderNewLine 

NameTypeReadOnlyReferencesFilterOnlyDescription
discountDoubleFalseNoThe percentage or amount of discount applied to the line item.
includeStringFalseNoSpecifies whether the item is included as part of a larger package or plan.
itemdisplayStringFalseNoThe name or description of the item included in the subscription or order.
multiplierlineIntegerFalseNoA factor used to adjust the included quantity of the item.
priceplanStringFalseNoThe pricing structure or model applied to the item or service.
quantityDoubleFalseNoThe number of units of the item included in the subscription or order.
requiredStringFalseNoSpecifies whether the item is mandatory as part of the subscription or plan.
sequenceStringFalseNoThe sequence number indicating the order of the line item in the subscription.
subscriptionchangeorderStringFalseNoAn undefined label, likely referring to a subscription change order or related entry.
subscriptionlinetypeStringFalseNoThe classification of the line item (for example, product, service, or discount).

Return to Top

subscriptionline 

NameTypeReadOnlyReferencesFilterOnlyDescription
advancerenewalperiodnumberIntegerFalseNoThe number of periods in advance when renewal notifications are sent.
advancerenewalperiodunitStringFalseNoThe unit of time used for advance renewal notifications (for example, days or months).
billingaccountstartdateDateFalseNoThe date when the billing account became active for this subscription line.
billingmodeStringFalseNoThe mode of billing applied to the subscription (for example, prepaid or postpaid).
catalogtypeStringFalseNoThe classification or type of catalog to which the subscription item belongs.
classStringFalseNoThe classification or category assigned for reporting purposes.
currencyStringFalseNoThe currency used for transactions related to this subscription line.
customformStringFalseNoThe specific form template used to capture details of the subscription line.
departmentStringFalseNoThe department associated with the subscription line for reporting purposes.
enddateDateFalseNoThe date when the subscription line is scheduled to end.
externalidStringFalseNoAn external identifier linking this record to external systems or references.
includeinrenewalBooleanFalseNoSpecifies whether this line is included during subscription renewal.
itemStringFalseNoThe specific product or service associated with this subscription line.
linenumberIntegerFalseNoThe line number indicating the order of items in the subscription.
locationStringFalseNoThe location associated with the subscription line.
ponumberStringFalseNoThe purchase order number associated with this subscription line.
prorateenddateBooleanFalseNoSpecifies whether proration is applied at the end of the subscription term.
proratestartdateBooleanFalseNoSpecifies whether proration is applied at the start of the subscription term.
recurrencestartdateDateFalseNoThe date when recurring billing starts for this subscription line.
salesorderStringFalseNoThe sales order associated with this subscription line.
salesorderlinenumberIntegerFalseNoThe line number within the associated sales order.
startdateDateFalseNoThe start date when the subscription line becomes active.
subscriptionStringFalseNoThe specific subscription record associated with this line.
subscriptionlinestatusStringFalseNoThe current status of the subscription line (for example, active or suspended).
subscriptionlinetypeStringFalseNoThe type of subscription line (for example, product, service, or charge).
subscriptionplanStringFalseNoThe subscription plan to which this line belongs.
subscriptionplanlineStringFalseNoA specific line item within the subscription plan.
terminationdateDateFalseNoThe date when the subscription line is terminated or canceled.
totalDecimalFalseNoThe total monetary amount associated with this subscription line.

Return to Top

subscriptionLineStatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier used for referencing specific records or entries.

Return to Top

subscriptionMessageType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique string used as an identifier or reference key for the record.

Return to Top

subscriptionplan 

NameTypeReadOnlyReferencesFilterOnlyDescription
advancerenewalperiodnumberIntegerFalseNoThe number of periods before renewal that notifications are sent.
advancerenewalperiodunitStringFalseNoThe unit of time used for advance renewal notifications (for example, days or months).
autorenewalBooleanFalseNoSpecifies whether the item or subscription automatically renews upon expiration.
classStringFalseNoThe classification or category associated with the item for reporting purposes.
createddateDatetimeFalseNoThe date and time when this record was initially created.
defaultrenewalmethodStringFalseNoThe default method used for handling renewals (for example, manual or automatic).
defaultrenewalplanStringFalseNoThe default plan applied when the item or subscription is renewed.
defaultrenewaltermStringFalseNoThe standard duration applied for renewal periods.
defaultrenewaltrantypeStringFalseNoThe type of transaction used during renewal processing (for example, invoice or sales order).
departmentStringFalseNoThe department associated with this item or subscription for reporting purposes.
descriptionStringFalseNoA detailed description providing information about the item or subscription.
displaynameStringFalseNoThe name displayed for this item or subscription for identification purposes.
externalidStringFalseNoAn external identifier linking this record to other systems or references.
includechildrenBooleanFalseNoSpecifies whether child items or components are included under this record.
incomeaccountStringFalseNoThe income account associated with this item for revenue tracking.
initialtermStringFalseNoThe initial term length of the item or subscription (for example, 12 months).
isinactiveBooleanFalseNoSpecifies whether this item or subscription is currently inactive or hidden.
itemidStringFalseNoThe unique identifier or code assigned to this item.
itemtypeStringFalseNoThe type or category of the item (for example, product, service, or subscription).
lastmodifieddateDatetimeFalseNoThe date and time when this record was last modified or updated.
locationStringFalseNoThe specific location associated with the item or subscription.
subsidiaryStringFalseNoThe subsidiary or business unit linked to this item or subscription.

Return to Top

subscriptionPlanSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoAn unspecified label, likely referring to an item or product associated with the record.

Return to Top

subscriptionterm 

NameTypeReadOnlyReferencesFilterOnlyDescription
externalidStringFalseNoAn identifier used to link this record to external systems or references.
idIntegerFalseNoA unique identifier assigned to this subscription term record.
isinactiveBooleanFalseNoSpecifies whether this subscription term is inactive or hidden.
nameStringFalseNoThe name or title associated with the subscription term.
subscriptiontermdurationStringFalseNoThe length of the subscription term (for example, 12 months or 1 year).
subscriptiontermtypeStringFalseNoThe type of subscription term (for example, fixed or evergreen).
subscriptiontermunitStringFalseNoThe unit of measurement used for defining the subscription term (for example, months or years).

Return to Top

subscriptiontermunit 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoA unique string identifier associated with the record or entry.

Return to Top

subsidiary 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique numeric identifier used to reference this subsidiary record.
countryStringFalseNoThe country where the subsidiary operates or is registered.
currencyStringFalseNoThe currency used for financial transactions associated with this subsidiary.
dropdownstateStringFalseNoThe state or province where the subsidiary operates.
editionStringFalseNoThe edition or version of the subsidiary's configuration.
emailStringFalseNoThe email address used for communication purposes, especially returns.
externalidStringFalseNoAn external identifier for linking this subsidiary record to other systems.
faxStringFalseNoThe fax number associated with the subsidiary.
federalidnumberStringFalseNoThe employee identification number (EIN) used for tax identification purposes.
fiscalcalendarStringFalseNoThe fiscal calendar followed by the subsidiary for financial reporting.
fullnameStringFalseNoThe complete name of the subsidiary, including hierarchy if applicable.
iseliminationBooleanFalseNoSpecifies whether this subsidiary is used for consolidation eliminations.
isinactiveBooleanFalseNoSpecifies whether this subsidiary is currently inactive.
languagelocaleStringFalseNoThe default language used for the subsidiary's communications and records.
legalnameStringFalseNoThe official legal name of the subsidiary for tax and regulatory purposes.
mainaddressStringFalseNoThe primary address associated with the subsidiary.
nameStringFalseNoThe name or title used to identify the subsidiary.
parentStringFalseNoThe parent subsidiary to which this subsidiary belongs.
purchaseorderamountDoubleFalseNoThe tolerance level for discrepancies between vendor bills and purchase order amounts.
purchaseorderquantityDoubleFalseNoThe tolerance level for discrepancies between vendor bills and purchase order quantities.
purchaseorderquantitydiffDoubleFalseNoThe difference between the received quantity and the ordered quantity for vendor bills.
receiptamountDoubleFalseNoThe tolerance level for discrepancies between vendor bills and item receipt amounts.
receiptquantityDoubleFalseNoThe tolerance level for discrepancies between vendor bills and item receipt quantities.
receiptquantitydiffDoubleFalseNoThe difference between the received quantity and the expected quantity for item receipts.
returnaddressStringFalseNoThe address used for processing returns associated with the subsidiary.
shippingaddressStringFalseNoThe address used for shipping purposes associated with the subsidiary.
showsubsidiarynameBooleanFalseNoSpecifies whether the subsidiary name is always displayed in transactions.
ssnortinStringFalseNoThe Social Security Number (SSN) or Taxpayer Identification Number (TIN) of the subsidiary.
stateStringFalseNoThe state or region where the subsidiary is registered or operates.
state1taxnumberStringFalseNoAustralian Company Number, used for business identification in Australia.
tranprefixStringFalseNoA prefix applied to document numbers generated for this subsidiary.

Return to Top

SubsidiaryMainAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoAn undefined label, possibly serving as a unique identifier or reference key.
addr1StringFalseNoThe primary street address or first line of the address.
addr2StringFalseNoThe secondary address line, such as apartment, suite, or unit number.
addr3StringFalseNoAn additional address line for further specification if needed.
addresseeStringFalseNoThe name of the individual or organization to whom the address is directed.
attentionStringFalseNoA specific person or department within an organization to receive the item.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country where the address is located.
dropdownstateStringFalseNoThe state or region related to the address.
overrideBooleanFalseNoSpecifies whether the default address is overridden by this specific address.
stateStringFalseNoThe state or province related to the address, providing further geographic specification.

Return to Top

SubsidiaryReturnAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoAn undefined label, possibly serving as a unique identifier or reference key.
addr1StringFalseNoThe primary street address or first line of the address.
addr2StringFalseNoThe secondary address line, such as apartment, suite, or unit number.
addr3StringFalseNoAn additional address line for further specification if needed.
addresseeStringFalseNoThe name of the individual or organization to whom the address is directed.
attentionStringFalseNoA specific person or department within an organization to receive the item.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country where the address is located.
dropdownstateStringFalseNoThe state or region related to the address.
overrideBooleanFalseNoSpecifies whether the default address is overridden by this specific address.
stateStringFalseNoThe state or province related to the address, providing further geographic specification.

Return to Top

subsidiarysettings 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbooksStringFalseNoThe set of accounting books associated with this record.
allowperiodendjournalentriesBooleanFalseNoSpecifies whether journal entries are allowed during period-end processing.
balancesheetclosingaccountStringFalseNoThe account used to record balance sheet closing entries.
balancesheetopeningaccountStringFalseNoThe account used to record balance sheet opening entries.
createbscloseandopenjournalsBooleanFalseNoSpecifies whether journals for closing and opening balance sheets are created.
createincomesummaryjournalsBooleanFalseNoSpecifies whether income summary journals are created during period-end processing.
excludebsfromglnumberingBooleanFalseNoSpecifies whether balance sheet entries are excluded from general ledger numbering.
externalidStringFalseNoAn external identifier used to link this record to external systems or references.
groupbythesesegmentsStringFalseNoThe segments used to group transactions for reporting or processing purposes.
idIntegerFalseNoA unique numeric identifier assigned to this accounting book or configuration.
incomesummarylossaccountStringFalseNoThe account used to record income summary losses.
incomesummaryprofitaccountStringFalseNoThe account used to record income summary profits.
requirememoonperiodendjournalsBooleanFalseNoSpecifies whether memos are required on period-end journal entries.
subsidiaryStringFalseNoThe subsidiary associated with this accounting configuration.

Return to Top

SubsidiaryShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoAn undefined label, possibly serving as a unique identifier or reference key.
addr1StringFalseNoThe primary street address or first line of the address.
addr2StringFalseNoThe secondary address line, such as apartment, suite, or unit number.
addr3StringFalseNoAn additional address line for further specification if needed.
addresseeStringFalseNoThe name of the individual or organization to whom the address is directed.
attentionStringFalseNoA specific person or department within an organization to receive the item.
cityStringFalseNoThe city associated with the address.
countryStringFalseNoThe country where the address is located.
dropdownstateStringFalseNoThe state or region related to the address.
overrideBooleanFalseNoSpecifies whether the default address is overridden by this specific address.
stateStringFalseNoThe state or province related to the address, providing further geographic specification.

Return to Top

subsidiaryTaxRegistration 

NameTypeReadOnlyReferencesFilterOnlyDescription
subsidiaryStringFalseNoThe business entity or division within the organization associated with this record.

Return to Top

SUBSIDIARYTRANSLATION 

NameTypeReadOnlyReferencesFilterOnlyDescription
languageStringFalseNoThe language used for communication or data presentation (for example, English or Spanish).
localeStringFalseNoThe locale code that defines regional or cultural settings associated with the language (for example, en_US or fr_CA).
nameStringFalseNoThe descriptive name or title associated with this language or locale.

Return to Top

subtotalitem 

NameTypeReadOnlyReferencesFilterOnlyDescription
availabletopartnersBooleanFalseNoSpecifies whether the item or product is available for partners to view or use.
createddateDatetimeFalseNoThe date and time when this record was initially created.
customformStringFalseNoThe custom form template associated with capturing this record's details.
descriptionStringFalseNoA detailed explanation or overview of the item or product.
displaynameStringFalseNoThe name displayed to users or customers for identification purposes.
externalidStringFalseNoAn external identifier used to link this record to external systems or references.
includechildrenBooleanFalseNoSpecifies if child items or related records are included under this record.
isinactiveBooleanFalseNoSpecifies whether the item or product is currently inactive or hidden.
issueproductStringFalseNoThe product associated with a reported issue or related transaction.
itemidStringFalseNoA unique identifier or code assigned to the item or product.
itemtypeStringFalseNoThe classification or type of item (for example, product, service, or subscription).
lastmodifieddateDatetimeFalseNoThe date and time when this record was last modified or updated.
subsidiaryStringFalseNoThe subsidiary or business unit associated with this item or product.

Return to Top

subtotalItemSubsidiaryMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
itemStringFalseNoAn undefined label, likely referring to an item or product associated with the record.

Return to Top

subtotalItemTranslation 

NameTypeReadOnlyReferencesFilterOnlyDescription
item [KEY]StringFalseNoThe name or identifier of the product or service being described.
displaynameStringFalseNoThe name displayed to customers or users when viewing the item.
featureddescriptionStringFalseNoA brief, highlighted description used to promote the item.
languageStringFalseNoThe language in which the content is presented.
nopricemessageStringFalseNoThe message displayed when no price is available for the item.
outofstockmessageStringFalseNoThe message displayed when the item is out of stock.
pagetitleStringFalseNoThe title displayed on the webpage, useful for search engine optimization (SEO) and navigation.
salesdescriptionStringFalseNoA detailed description promoting the features and benefits of the item.
specialsdescriptionStringFalseNoAn additional description used for special promotions or offers.
storedescriptionStringFalseNoA general description of the item displayed in the online store.
storedetaileddescriptionStringFalseNoAn extensive description providing comprehensive details about the item.
storedisplaynameStringFalseNoThe internal or system-generated name used to reference the item.

Return to Top

suitelet 

NameTypeReadOnlyReferencesFilterOnlyDescription
defaultfunctionStringFalseNoThe main function within the script that is executed by default.
descriptionStringFalseNoA brief explanation detailing the purpose or functionality of the script.
externalidStringFalseNoAn external identifier used to link this script to external systems or references.
isinactiveBooleanFalseNoSpecifies whether the script is currently inactive or disabled.
nameStringFalseNoThe name assigned to the script for identification purposes.
notifyadminsBooleanFalseNoSpecifies whether system administrators are notified of script activity or errors.
notifyemailsStringFalseNoA list of email addresses to notify regarding script execution or errors.
notifygroupStringFalseNoThe user group to notify when certain script actions occur.
notifyownerBooleanFalseNoSpecifies whether the script owner is notified of script-related events.
notifyuserBooleanFalseNoSpecifies whether the user executing the script receives notifications.
ownerStringFalseNoThe individual or entity responsible for maintaining the script.
scriptfileStringFalseNoThe file location or name of the script being referenced.
scriptidStringFalseNoA unique identifier assigned to the script within the system.
scripttypeStringFalseNoThe category or type of script (for example, client script, server script, or user event).

Return to Top

SuiteScriptDetail 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoA unique numeric identifier used to reference this script execution record.
apiversionStringFalseNoThe version of the API used during the script execution.
bundleStringFalseNoThe software bundle associated with the script execution.
dateDateFalseNoThe date when the script execution occurred.
emailsIntegerFalseNoThe total number of emails sent during the script execution.
entityStringFalseNoThe entity associated with the script execution (for example, customer or vendor).
executiontimeIntegerFalseNoThe amount of time (in milliseconds) taken to execute the script.
faxesIntegerFalseNoThe number of faxes sent during the script execution.
filesIntegerFalseNoThe number of files processed or generated by the script.
httpmethodStringFalseNoThe HTTP method used during the execution (for example, GET or POST).
instructionsIntegerFalseNoThe number of script instructions executed during the process.
ranasadminBooleanFalseNoSpecifies whether the script was executed with administrator privileges.
recordidStringFalseNoThe unique identifier of the record being processed by the script.
recordsIntegerFalseNoThe number of records processed during the script execution.
recordtypeidStringFalseNoThe type of record being processed (for example, sales order or customer).
roleStringFalseNoThe user role under which the script was executed.
scriptStringFalseNoThe name or identifier of the script being executed.
scriptcontextStringFalseNoThe context in which the script was executed (for example, user event or scheduled).
scriptdeploymentStringFalseNoThe specific deployment instance of the script being executed.
scripttypeStringFalseNoThe category or type of script (for example, user event, client, or scheduled).
searchesIntegerFalseNoThe number of searches performed during the script execution.
sessionidStringFalseNoThe unique identifier for the user session during which the script was executed.
threadidIntegerFalseNoThe thread identifier used for concurrent script processing.
totaltimeIntegerFalseNoThe total time (in milliseconds) taken by the script execution, including all processes.
triggersIntegerFalseNoThe number of before/after submit scripts triggered by this execution.
urlrequestsIntegerFalseNoThe number of outbound URL requests made during the script execution.

Return to Top

supplychainsnapshot 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique numeric identifier used to reference this supply chain record.
daterunDateFalseNoThe date when the supply chain data was generated or processed.
externalidStringFalseNoAn external identifier used to link this record to other systems.
futurehorizonIntegerFalseNoThe number of days or periods considered for future supply planning.
futurehorizondateDateFalseNoThe end date for the future horizon period used in planning.
itemStringFalseNoThe specific product or item being referenced within the supply chain process.
memoStringFalseNoA note or description providing additional information about the record.
replenishmentmethodStringFalseNoThe strategy used for restocking or replenishing inventory (for example, reorder point or MRP).
stockunitStringFalseNoThe unit of measurement used for inventory tracking (for example, pieces or boxes).

Return to Top

supplyChainSnapshotDetails 

NameTypeReadOnlyReferencesFilterOnlyDescription
dateDateFalseNoThe date associated with the supply chain transaction or snapshot.
dayspastdueStringFalseNoThe number of days by which a demand or supply is overdue.
demandquantityDoubleFalseNoThe quantity of items requested or required within the supply chain.
entityStringFalseNoThe company or individual associated with the demand or supply transaction.
invbalanceDoubleFalseNoThe current stock level of the item available at a location.
itemStringFalseNoThe specific product or item being referenced within the supply chain process.
locationbaseStringFalseNoThe physical or virtual location where the item is stored or processed.
originaltransactiondateStringFalseNoThe original date of the transaction related to the demand or supply.
otherdemandquantityDoubleFalseNoDemand quantities not related to standard sales orders or purchase orders.
othersupplyquantityDoubleFalseNoSupply quantities not related to standard purchase orders or production orders.
purchaserrderquantityDoubleFalseNoThe quantity of items requested through a purchase order.
replenishmentmethodStringFalseNoThe strategy used for restocking or replenishing inventory (for example, reorder point or MRP).
salesorderquantityDoubleFalseNoThe quantity of items requested through a sales order.
sourcetypeStringFalseNoThe origin of the supply or demand (for example, purchase, transfer, or work order).
statusStringFalseNoThe current status of the transaction (for example, open, completed, or pending).
subsidiaryStringFalseNoThe business unit or entity associated with the supply chain transaction.
supplychainsnapshotStringFalseNoAn unnamed field likely representing a supply chain snapshot or reference.
supplyquantityDoubleFalseNoThe quantity of items available to meet demand within the supply chain.
transactionStringFalseNoThe specific transaction associated with the supply or demand (for example, sales order or PO).
transferorderquantityDoubleFalseNoThe quantity of items requested through a transfer order.
trantypeStringFalseNoThe type of transaction processed (for example, sales order, transfer order, or purchase order).

Return to Top

supplychainsnapshotsimulation 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique identifier assigned to the simulation or planning scenario.
demandlocationStringFalseNoThe location where the demand for items originates.
demandlocationdateDateFalseNoThe date when the demand is expected or planned to be fulfilled.
demandlocationsubsidiaryStringFalseNoThe subsidiary associated with the demand location.
docnumcreatedfromStringFalseNoThe originating document that triggered this simulation or transaction.
externalidStringFalseNoAn external identifier used to link this simulation to external systems.
isforrescheduleBooleanFalseNoSpecifies whether the simulation is intended for rescheduling purposes.
itemnamenumberStringFalseNoThe name or identifier of the item being simulated or planned.
linecreatedfromIntegerFalseNoThe line number or reference from the originating document.
memoStringFalseNoA note providing additional details or context about the simulation.
ownerStringFalseNoThe individual or entity responsible for the simulation or planning scenario.
quantityDoubleFalseNoThe quantity of items associated with the simulation or planning scenario.
statusStringFalseNoThe current status of the simulation (for example, pending, completed, or rescheduled).
supplylocationStringFalseNoThe location from where the supply is sourced to fulfill the demand.
supplylocationdateDateFalseNoThe date when the supply is expected to be available or fulfilled.
supplylocationsubsidiaryStringFalseNoThe subsidiary associated with the supply location.

Return to Top

supplychangeorder 

NameTypeReadOnlyReferencesFilterOnlyDescription
approvalstatusStringFalseNoThe current status of the approval process for the supply plan change.
changeactionStringFalseNoThe action to be taken as part of the supply plan change (for example, create, update, or delete).
customformStringFalseNoThe specific custom form used for the supply plan change record.
externalidStringFalseNoAn external identifier used to link this record to external systems or references.
idIntegerFalseNoA unique numeric identifier associated with this supply plan change record.
memoStringFalseNoA note or description providing additional details about the supply plan change.
newdateDateFalseNoThe revised or proposed new date for the supply plan change.
nextapproverStringFalseNoThe individual or role responsible for reviewing and approving the change next.
originaldateDateFalseNoThe initial date before any changes were proposed or applied.
supplyplandefinitionStringFalseNoThe supply plan definition associated with this change request.
transactionlineidStringFalseNoThe unique identifier for the specific transaction line being modified.

Return to Top

supplyplandefinition 

NameTypeReadOnlyReferencesFilterOnlyDescription
customformStringFalseNoThe specific custom form used to capture details of the supply plan template.
descriptionStringFalseNoA brief explanation of the purpose or functionality of the supply plan template.
externalidStringFalseNoAn external identifier used to link this record to external systems or references.
generatepeggingBooleanFalseNoSpecifies whether pegging relationships are generated for demand and supply sources.
horizonindaysIntegerFalseNoThe number of days for which the supply plan is generated or applied.
idIntegerFalseNoA unique numeric identifier assigned to this supply plan template.
itemgroupStringFalseNoThe group of items associated with the supply plan template.
nameStringFalseNoThe name or title assigned to the supply plan template for identification.
rulegroupStringFalseNoThe set of rules applied to the supply plan template for planning purposes.
templatestoredBooleanFalseNoSpecifies whether the supply plan template is stored within the system.

Return to Top

SupplyReplenishmentType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique string identifier used to reference this record within the system.

Return to Top

supportcase 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique numeric identifier for the case record within the system.
assignedStringFalseNoThe individual or group to whom the case is assigned for resolution.
casenumberStringFalseNoThe unique case number or identifier assigned to the support case.
companyStringFalseNoThe company associated with the support case.
datecreatedDateFalseNoThe date and time when the support case was created.
escalatetoStringFalseNoThe user or department to escalate the case for further review or handling.
externalidStringFalseNoAn external identifier used to link the case to other systems or references.
helpdeskBooleanFalseNoSpecifies whether the case is flagged for help desk support handling.
initialresponsetimeDoubleFalseNoThe time taken to provide the first response to the customer (in minutes).
isinactiveBooleanFalseNoSpecifies whether the case record is marked as inactive or closed.
issueStringFalseNoThe primary issue or problem described in the case.
issuesStringFalseNoAdditional issues or related problems documented in the case.
itemStringFalseNoThe specific product or service associated with the case.
lastcustomermessagereceivedDateFalseNoThe date when the last message was received from the customer.
originStringFalseNoThe source or channel through which the case was initiated (for example, phone, email, or web).
priorityStringFalseNoThe priority level assigned to the case (for example, low, medium, or high).
profileStringFalseNoThe customer or company profile associated with the case.
serialnumberStringFalseNoThe serial or lot number associated with the item involved in the case.
solutionsStringFalseNoThe proposed or implemented solutions for resolving the case.
startdateDateFalseNoThe date when the incident or issue originally occurred.
statusStringFalseNoThe current status of the case (for example, open, resolved, or pending).
subsidiaryStringFalseNoThe subsidiary or business unit associated with the case.
supportfirstreplyDateFalseNoThe date when the support team provided the first response to the case.
timeelapsedDoubleFalseNoThe total time elapsed since the case was created (in minutes).
timeonholdDoubleFalseNoThe total time the case was placed on hold (in minutes).
timeopenDoubleFalseNoThe total time the case has been actively worked on (in minutes).
timetoassignDoubleFalseNoThe amount of time taken to assign the case to a responsible party (in minutes).
timetocloseDoubleFalseNoThe total time taken to resolve and close the case (in minutes).
titleStringFalseNoThe brief description or title summarizing the issue being reported.

Return to Top

supportCaseEscalateHist 

NameTypeReadOnlyReferencesFilterOnlyDescription
datetimeDateFalseNoThe date and time when the escalation or action occurred.
fromentityStringFalseNoThe entity or user initiating the escalation or action.
supportcaseStringFalseNoThe support case associated with the escalation or action.
territoryStringFalseNoThe territory or department responsible for handling the escalation.
toentityStringFalseNoThe specific action taken or response provided for the escalation.

Return to Top

supportCaseEscalateToMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
supportcaseStringFalseNoThe support case or ticket related to a specific issue or customer request.

Return to Top

supportCaseMediaItemMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
supportcaseStringFalseNoThe support case or ticket related to a specific issue or customer request.

Return to Top

supportCaseSolutionMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
supportcaseStringFalseNoThe support case or ticket related to a specific issue or customer request.

Return to Top

SystemEmailTemplate 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoA unique numeric identifier for the template or content record within the system.
contentStringFalseNoThe body or main text of the template or content item.
descriptionStringFalseNoA brief summary or explanation of the purpose or function of the template.
isautoconvertedBooleanFalseNoSpecifies whether the template was generated automatically from another source.
isinactiveBooleanFalseNoSpecifies whether the template is currently inactive or not in use.
isprivateBooleanFalseNoSpecifies whether the template is restricted for private or internal use only.
mediaitemStringFalseNoThe associated media file or reference linked to the template.
nameStringFalseNoThe name or title used to identify the template.
subjectStringFalseNoThe subject line or title associated with the template, often used for emails or documents.

Return to Top

SystemNote 

NameTypeReadOnlyReferencesFilterOnlyDescription
contextStringFalseNoThe environment or purpose associated with the record modification (for example, user interface or script).
dateDateFalseNoThe date when the change or modification occurred.
fieldStringFalseNoThe specific field or attribute that was modified within the record.
nameStringFalseNoThe name associated with the record or user making the modification.
newvalueStringFalseNoThe updated value applied to the field during the modification.
oldvalueStringFalseNoThe previous value of the field before the modification occurred.
recordStringFalseNoThe specific record or entry being modified or audited.
recordidIntegerFalseNoA unique numeric identifier used to reference the record within the system.
recordtypeidStringFalseNoThe type of record being modified (for example, customer, transaction, or item).
roleStringFalseNoThe user role associated with the modification (for example, administrator, user, or script).

Return to Top

SystemNote2 

NameTypeReadOnlyReferencesFilterOnlyDescription
actorStringFalseNoThe user or system that made changes to the object or value.
contextStringFalseNoThe environment or purpose associated with the modification (for example, user interface or script).
datefromDateFalseNoThe starting date for the period or range considered.
datetoDateFalseNoThe ending date for the period or range considered.
elementfullnameStringFalseNoThe complete name of the element being modified or referenced.
instancenameStringFalseNoThe name of the object being modified or referenced.
localeStringFalseNoThe regional or language settings associated with the object or change.
objectactiontypeStringFalseNoThe type of action performed on the object (for example, create, update, or delete).
objectelementkeyIntegerFalseNoA unique identifier for the element being modified within the object.
objectelementnameStringFalseNoThe name of the element being modified within the object.
objectidIntegerFalseNoThe unique identifier for the object being modified or referenced.
objectparentIntegerFalseNoThe unique identifier of the parent object.
objectrootIntegerFalseNoThe unique identifier of the root object in the hierarchy.
roleIntegerFalseNoThe numeric identifier of the user role associated with the modification.
rolenameStringFalseNoThe name of the user role associated with the modification.
rootinstancenameStringFalseNoThe name of the root object in the hierarchy.
rootobjectbkey1BooleanFalseNoThis key represents a Boolean indicator associated with a root object.
rootobjectbkey2BooleanFalseNoThis key represents an additional Boolean indicator associated with a root object.
rootobjectdkey1DateFalseNoThis key represents a date value related to a root object.
rootobjectelementkeyIntegerFalseNoA unique identifier associated with an element within the root object. This key is used for linking or referencing specific components within a larger structure.
rootobjectelementnameStringFalseNoThe name of the element within the root object. It serves as a descriptive label or identifier to differentiate components.
rootobjectnkey1IntegerFalseNoA numeric key associated with the root object. Often used for storing quantitative values such as counts, indexes, or IDs.
rootobjectnkey2IntegerFalseNoAn additional numeric key associated with the root object. Typically used for storing secondary numeric data relevant to the root object.
rootobjectnkey3IntegerFalseNoAnother numeric key associated with the root object. It may be used to represent various numeric attributes or metrics related to the object.
rootobjectnkey4IntegerFalseNoA fourth numeric key associated with the root object. This key can be used for specialized numerical data storage or calculations.
rootobjectskey1StringFalseNoA string key associated with the root object. This key may contain textual information relevant to the object's context or description.
rootobjectskey3StringFalseNoAn additional string key associated with the root object, often used for supplementary text-based attributes or metadata.
runidIntegerFalseNoThe identifier for the specific execution or process run.
timestamputcDateFalseNoThe date and time when the modification was applied.
valueactiontypeStringFalseNoThe type of action applied to the value (for example, added, modified, or removed).
valuedatatypeStringFalseNoThe data type of the modified value (for example, string, integer, or Boolean).
valueelementkeyIntegerFalseNoA unique identifier for the value element being modified.
valuenewbooleanBooleanFalseNoThe new Boolean value applied to the object.
valuenewdateDateFalseNoThe new date value applied to the object.
valuenewdisplaynameStringFalseNoThe new display name or text applied to the object.
valuenewnumberDecimalFalseNoThe new numeric value applied to the object.
valuenewreferenceIntegerFalseNoThe primary reference to a related object or value.
valuenewreference2IntegerFalseNoThe secondary reference to a related object or value.
valuenewstringStringFalseNoThe new text or string value applied to the object.
valueoldbooleanBooleanFalseNoThe previous Boolean value before modification.
valueolddateDateFalseNoThe previous date value before modification.
valueolddisplaynameStringFalseNoThe previous display name or text before modification.
valueoldnumberDecimalFalseNoThe previous numeric value before modification.
valueoldreferenceIntegerFalseNoThe previous primary reference to a related object or value.
valueoldreference2IntegerFalseNoThe previous secondary reference to a related object or value.
valueoldstringStringFalseNoThe previous text or string value before modification.

Return to Top

systemNoteContextType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique string identifier used to reference or link this record within the system.

Return to Top

SystemNoteField 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique string identifier used to reference or link this record within the system.

Return to Top

tag 

NameTypeReadOnlyReferencesFilterOnlyDescription
defaultnameStringFalseNoStores the default name assigned to the tag, typically used when no custom name is specified.
defaultvalueStringFalseNoStores the default value assigned to the tag, serving as a fallback when no specific value is set.
featureStringFalseNoIndicates the feature associated with the tag, helping categorize its function within the system.
isinactiveBooleanFalseNoIndicates whether the tag is inactive. If the value is true, the tag is disabled and not available for use.
keyStringFalseNoRepresents a unique identifier for the tag, used to reference it in the system.

Return to Top

task 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoStores the internal identifier for the task, used for system reference and tracking.
accesslevelBooleanFalseNoIndicates whether the task is private. If the value is true, only authorized users can view it.
assignedStringFalseNoSpecifies the user or team assigned to complete the task.
bomStringFalseNoReferences the Bill of Materials (BOM) associated with the task, detailing required components.
bomrevisionStringFalseNoStores the revision details of the associated BOM.
companyStringFalseNoIndicates the company linked to the task, typically for business or project tracking.
completeddateDateFalseNoRecords the date when the task was marked as completed.
contactStringFalseNoLinks a contact to the task, useful for communication and follow-ups.
createddateDateFalseNoStores the date when the task was initially created.
duedateDateFalseNoSpecifies the deadline by which the task should be completed.
externalidStringFalseNoHolds an external identifier for integration with external systems.
lastmodifieddateDateFalseNoTracks the date when the task was last modified.
messageStringFalseNoContains comments or notes related to the task.
mfgroutingStringFalseNoStores the manufacturing routing details associated with the task, guiding production processes.
milestoneStringFalseNoRepresents a milestone associated with the task, marking key progress points.
orderStringFalseNoDetermines where the task should be inserted in a sequence or workflow.
ownerStringFalseNoIndicates the user who created the task.
parentStringFalseNoSpecifies the parent task if this task is part of a hierarchical structure.
percentcompleteDoubleFalseNoRepresents the percentage of task completion based on progress tracking.
percenttimecompleteDoubleFalseNoIndicates task completion percentage based on time spent versus estimated duration.
priorityStringFalseNoDefines the priority level of the task, such as high, medium, or low.
relateditemStringFalseNoLinks an item to the task, often used for inventory or work order tracking.
reminderminutesStringFalseNoSpecifies the number of minutes before the due date when a reminder should be triggered.
remindertypeStringFalseNoDefines the type of reminder associated with the task, such as email or popup notification.
startdateDateFalseNoRecords the planned start date of the task.
statusStringFalseNoIndicates the current status of the task, such as open, in progress, or completed.
supportcaseStringFalseNoLinks the task to a support case, tracking its relation to customer issues.
timedeventBooleanFalseNoIndicates whether the task is a timed event that follows a predefined schedule.
titleStringFalseNoStores the title or name of the task, summarizing its purpose.

Return to Top

TaskCompanyMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
companyStringFalseNoLinks a company to a task, identifying the organization responsible for or associated with the task.

Return to Top

TaskContactMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
contactStringFalseNoLinks a contact to a task, representing individuals associated with the task for communication or responsibility purposes.

Return to Top

TaskEventFile 

NameTypeReadOnlyReferencesFilterOnlyDescription
eventStringFalseNoAssociates an event with a task, linking related meetings, milestones, or occurrences for better tracking.

Return to Top

taxacct 

NameTypeReadOnlyReferencesFilterOnlyDescription
countryStringFalseNoSpecifies the country associated with the tax account, determining applicable tax regulations.
descriptionStringFalseNoProvides a detailed description of the tax account, outlining its purpose and usage.
externalidStringFalseNoStores an external identifier for the tax account, used for integration with external systems.
isinactiveBooleanFalseNoIndicates whether the tax account is inactive. If the value is 'true', the account is disabled and not used in transactions.
nameStringFalseNoStores the name of the tax account, used for identification and reporting.
nexusStringFalseNoSpecifies the tax nexus associated with the tax account, defining the jurisdiction where taxes apply.
taxaccttypeStringFalseNoDefines the type of tax account, categorizing it based on tax regulations and financial reporting needs.

Return to Top

taxgroup 

NameTypeReadOnlyReferencesFilterOnlyDescription
cityStringFalseNoSpecifies the city where the tax group is applicable.
countyStringFalseNoIndicates the county associated with the tax group for jurisdictional tax calculations.
descriptionStringFalseNoProvides a detailed description of the tax group, outlining its purpose and coverage.
externalidStringFalseNoStores an external identifier for the tax group, used for integration with external systems.
includechildrenBooleanFalseNoIndicates whether the tax group includes child entities, applying tax rules accordingly.
isdefaultBooleanFalseNoSpecifies whether this tax group is set as the default for transactions.
isinactiveBooleanFalseNoIndicates whether the tax group is inactive. If the value is 'true', the tax group is disabled and not used in transactions.
itemidStringFalseNoStores the unique identifier for the tax item within the tax group.
itemtypeStringFalseNoDefines the type of tax item within the tax group, such as sales tax or VAT.
nexuscountryStringFalseNoSpecifies the country associated with the tax nexus, determining applicable tax jurisdictions.
piggybackBooleanFalseNoIndicates whether the tax group applies an additional tax on top of an existing tax rate.
rateStringFalseNoDefines the tax rate applicable to this tax group.
stateStringFalseNoSpecifies the state where the tax group applies, affecting regional tax calculations.
subsidiaryStringFalseNoLinks the tax group to a specific subsidiary, ensuring tax compliance for different business units.
taxitem1StringFalseNoIdentifies the primary tax item within the tax group, used for tax calculations.
taxitem2StringFalseNoIdentifies the secondary tax item within the tax group, if applicable.
taxtypeStringFalseNoSpecifies the type of tax associated with the group, such as sales tax, VAT, or service tax.
unitprice1StringFalseNoStores the unit price associated with the first tax item in the group.
unitprice2StringFalseNoStores the unit price associated with the second tax item in the group.
zipStringFalseNoSpecifies the zip code where the tax group is applicable, ensuring accurate regional taxation.

Return to Top

taxItemTaxGroup 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoStores the internal identifier for the tax item tax group, used for reference and system tracking.
descriptionStringFalseNoProvides a description of the tax item tax group, outlining its purpose and usage.
isinactiveBooleanFalseNoIndicates whether the tax item tax group is inactive. If the value is true, it is disabled and not used in tax calculations.

Return to Top

taxOverrideMethod 

NameTypeReadOnlyReferencesFilterOnlyDescription
overridenameStringFalseNoStores the name of the tax override method, identifying the specific tax calculation rule being applied.
validtaxcalcoverrideskeyStringFalseNoRepresents a unique key for valid tax calculation overrides, ensuring proper application of tax adjustments.

Return to Top

taxperiod 

NameTypeReadOnlyReferencesFilterOnlyDescription
allclosedBooleanFalseNoIndicates whether all transactions for the tax period are closed, preventing further modifications.
enddateDateFalseNoStores the end date of the tax period, marking its closure for reporting purposes.
externalidStringFalseNoHolds an external identifier for the tax period, used for integration with external systems.
isadjustBooleanFalseNoIndicates whether the tax period includes adjustments, typically for corrections or amendments.
isquarterBooleanFalseNoSpecifies whether the tax period represents a quarterly reporting period.
isyearBooleanFalseNoIndicates whether the tax period covers a full fiscal year.
periodnameStringFalseNoStores the name of the tax period, typically reflecting its fiscal period designation.
startdateDateFalseNoRecords the start date of the tax period, marking when it begins for tax reporting.

Return to Top

taxtype 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoStores the internal identifier for the tax type, uniquely distinguishing it within the system for reference, reporting, and transaction processing.
countryStringFalseNoSpecifies the country where the tax type is applicable, ensuring compliance with regional tax laws and regulatory requirements.
descriptionStringFalseNoProvides a detailed description of the tax type, explaining its purpose, applicability, and any specific conditions under which it is used.
nameStringFalseNoStores the official name of the tax type, which is used for classification in tax reporting, financial transactions, and system-wide references.

Return to Top

term 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoStores the internal identifier for the payment term, uniquely identifying it within the system.
daydiscountexpiresIntegerFalseNoSpecifies the day of the month when an early payment discount expires, encouraging prompt payments.
dayofmonthnetdueIntegerFalseNoDefines the specific day of the month when the full payment is due.
daysuntilexpiryIntegerFalseNoIndicates the number of days from the invoice date until the early payment discount is no longer valid.
daysuntilnetdueIntegerFalseNoSpecifies the number of days after the invoice date when the full payment becomes due.
discountpercentDoubleFalseNoStores the percentage discount offered for early payment, reducing the total amount due.
discountpercentdatedrivenDoubleFalseNoDefines a date-driven percentage discount for early payments based on specific invoice conditions.
duenextmonthifwithindaysIntegerFalseNoIndicates whether the due date should be pushed to the next month when it falls within a specified number of days before month-end.
externalidStringFalseNoStores an external identifier for the payment term, facilitating integration with external systems.
isinactiveBooleanFalseNoIndicates whether the payment term is inactive. If the value is true, the term is disabled and not available for use in transactions.
preferredBooleanFalseNoSpecifies whether this payment term is the preferred default for new transactions.

Return to Top

Terminationregretted 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoRepresents a unique identifier for regretted terminations, used for tracking and reporting employee departures with significant impact.

Return to Top

testCell 

NameTypeReadOnlyReferencesFilterOnlyDescription
cellnameStringFalseNoStores the name of the test cell, used for categorization and identification within testing environments.
groupStringFalseNoSpecifies the group to which the test cell belongs, organizing related test cases or experiments.

Return to Top

ThreeDSECommerceIndicator 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoRepresents a unique identifier for the 3D Secure e-commerce indicator, used in transaction authentication and fraud prevention.

Return to Top

ThreeDSTranStatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoRepresents a unique identifier for the 3D Secure transaction status, used to track authentication results in secure payments.

Return to Top

ThreeDSTranStatusReason 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoRepresents a unique identifier for the 3D Secure transaction status reason, providing details on why a transaction was approved, declined, or challenged.

Return to Top

ThreeDSVersion 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoRepresents a unique identifier for the 3D Secure version, ensuring accurate tracking of authentication protocol versions used in transactions.

Return to Top

timebill 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoStores the internal identifier for the time billing record, uniquely identifying it within the system.
casetaskeventStringFalseNoLinks the time entry to a specific case, task, or event, ensuring proper tracking of work activities.
classStringFalseNoCategorizes the time billing entry by class, allowing classification for reporting and financial tracking.
customerStringFalseNoAssociates the time entry with a specific customer, ensuring accurate billing and project tracking.
departmentStringFalseNoSpecifies the department responsible for the time entry, aiding in financial reporting and cost allocation.
displayfieldStringFalseNoIndicates the time tracking display field, summarizing key time entry details for users.
employeeStringFalseNoIdentifies the employee who logged the time entry, linking it to their work hours and payroll.
externalidStringFalseNoStores an external identifier for the time entry, facilitating integration with external systems.
hoursDoubleFalseNoRecords the duration of the time entry in hours, capturing the total work time.
isbillableBooleanFalseNoIndicates whether the logged time is billable to a customer. If the value is true, the time will be included in invoices.
isexemptBooleanFalseNoSpecifies whether the time entry is exempt from billing or payroll calculations.
isproductiveBooleanFalseNoIndicates whether the recorded time is considered productive work.
itemStringFalseNoLinks the time entry to a service item, defining the type of work performed.
locationStringFalseNoSpecifies the location where the work was performed, useful for tracking remote or on-site work.
memoStringFalseNoStores additional notes or comments related to the time entry for reference.
overriderateBooleanFalseNoIndicates whether the rate for this time entry is locked, preventing automatic adjustments.
payrollworkplaceStringFalseNoSpecifies the payroll item or workplace associated with the time entry, aiding in payroll calculations.
priceStringFalseNoDefines the price level applied to the billable time entry, affecting the final billing rate.
rateDecimalFalseNoStores the hourly rate or unit price for the time entry, used for billing calculations.
subsidiaryStringFalseNoAssociates the time entry with a specific subsidiary, ensuring correct financial reporting in multi-entity organizations.
supervisorapprovalBooleanFalseNoIndicates whether the time entry requires supervisor approval before it can be processed.
timemodifiedBooleanFalseNoTracks whether the time entry has been modified after initial submission.
timetypeStringFalseNoDefines the type of time entry, such as regular hours, overtime, or vacation.
trandateDateFalseNoRecords the date the time entry was logged, determining the period for payroll and billing purposes.

Return to Top

timeentry 

NameTypeReadOnlyReferencesFilterOnlyDescription
approvalstatusStringFalseNoIndicates the approval status of the time entry, tracking whether it is pending, approved, or rejected.
billingclassStringFalseNoSpecifies the billing class associated with the time entry, determining how the time is categorized for invoicing.
casetaskeventStringFalseNoLinks the time entry to a case, task, or event, ensuring proper tracking of work activities.
classStringFalseNoCategorizes the time entry by class, facilitating financial reporting and classification.
createddateDatetimeFalseNoRecords the date and time when the time entry was created, useful for tracking historical records.
customerStringFalseNoAssociates the time entry with a specific customer, ensuring accurate project tracking and invoicing.
dayDateFalseNoSpecifies the date for which the time entry was logged.
departmentStringFalseNoLinks the time entry to a specific department, supporting cost allocation and financial tracking.
employeeStringFalseNoIdentifies the employee who recorded the time entry, ensuring accurate payroll and work hour tracking.
externalidStringFalseNoStores an external identifier for the time entry, facilitating integration with external systems.
hoursStringFalseNoRecords the number of hours logged in the time entry, used for payroll and billing calculations.
isbillableBooleanFalseNoIndicates whether the logged time is billable to a customer. If the value is true, the time is included in invoices.
isexemptBooleanFalseNoSpecifies whether the time entry is exempt from billing or payroll calculations.
isproductiveBooleanFalseNoIndicates whether the recorded time is considered productive work contributing to deliverables.
isutilizedBooleanFalseNoIndicates whether the time entry is counted towards resource utilization calculations.
itemStringFalseNoLinks the time entry to a specific item, such as a service or product associated with the work performed.
locationStringFalseNoSpecifies the location where the work was performed, helping track remote or on-site activities.
memoStringFalseNoStores additional notes or comments related to the time entry for documentation and reference.
overriderateStringFalseNoIndicates whether a custom rate has been applied to this time entry, overriding default rates.
paidexternallyBooleanFalseNoSpecifies whether the time entry has been paid through an external payroll system.
payrollitemStringFalseNoLinks the time entry to a payroll item, ensuring proper classification in payroll processing.
priceStringFalseNoDefines the price level applied to the billable time entry, affecting the final billing rate.
projecttaskassignmentStringFalseNoAssociates the time entry with a specific project task assignment, ensuring accurate tracking of project effort.
rateStringFalseNoStores the hourly rate or unit price applied to the time entry for billing calculations.
subsidiaryStringFalseNoLinks the time entry to a specific subsidiary, ensuring proper financial reporting for multi-entity organizations.
timetypeStringFalseNoDefines the type of time entry, such as regular hours, overtime, or time off.

Return to Top

timeLineApprovalStatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyIntegerFalseNoStores the internal identifier for the timeline approval status, uniquely identifying approval records within the system.

Return to Top

TimelineType 

NameTypeReadOnlyReferencesFilterOnlyDescription
nameStringFalseNoStores the name of the timeline type, categorizing different timeline structures for scheduling and tracking purposes.

Return to Top

timeOffAccrualFrequency 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoRepresents a unique identifier for the time-off accrual frequency, defining how often employees accumulate leave time.

Return to Top

timeOffAccrualType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoRepresents a unique identifier for the time-off accrual type, categorizing different methods of accruing leave time, such as fixed, progressive, or tenure-based accrual.

Return to Top

timeoffrequest 

NameTypeReadOnlyReferencesFilterOnlyDescription
approvalstatusStringFalseNoIndicates the approval status of the time-off request, tracking whether it is pending, approved, or denied. Helps managers and HR teams monitor leave approvals.
creationdateStringFalseNoRecords the date when the time-off request was created, providing a timestamp for submission tracking. Useful for auditing and tracking employee leave history.
employeeStringFalseNoIdentifies the employee who submitted the time-off request, ensuring that leave records are accurately linked to individuals.
enddateDateFalseNoSpecifies the last date of the requested time off, marking the end of the employee’s absence.
externalidStringFalseNoStores an external identifier for the time-off request, facilitating integration with third-party HR and payroll systems for better record synchronization.
idIntegerFalseNoStores the unique identifier for the time-off request, ensuring proper tracking and management within the system.
internalidIntegerFalseNoRepresents the internal system-generated identifier for the time-off request, used for database operations and backend processes.
isautodeletetimeentryBooleanFalseNoIndicates whether associated time entries should be automatically deleted when the time-off request is approved. If the value is true, the system removes overlapping time entries, preventing double counting of work hours.
messageStringFalseNoStores any additional comments or notes submitted with the time-off request. Employees may use this field to provide reasons for the leave or communicate special circumstances.
startdateDateFalseNoSpecifies the first date of the requested time off, marking the beginning of the employee’s leave period.

Return to Top

timeOffRequestDetailsMachine 

NameTypeReadOnlyReferencesFilterOnlyDescription
amountoftimeDoubleFalseNoSpecifies the total duration of time off requested by the employee, measured in the selected time unit.
timeoffdateDateFalseNoIndicates the specific date on which the time off is scheduled to occur.
timeoffrequestStringFalseNoLinks the record to the associated time-off request, ensuring accurate tracking of leave details.
timeunitStringFalseNoDefines the unit of time used for the request, such as hours or days, to standardize leave calculations.

Return to Top

timesheet 

NameTypeReadOnlyReferencesFilterOnlyDescription
allocatedhoursStringFalseNoRecords the number of hours allocated to an employee for a specific period, helping track resource utilization.
approvalstatusStringFalseNoIndicates the approval status of the timesheet, tracking whether it is pending, approved, or rejected.
customformStringFalseNoSpecifies the custom form used for the timesheet, allowing for organization-specific formatting and fields.
employeeStringFalseNoIdentifies the employee associated with the timesheet, ensuring accurate payroll and work hour tracking.
enddateDateFalseNoSpecifies the last date covered by the timesheet, marking the end of the recorded work period.
externalidStringFalseNoStores an external identifier for the timesheet, facilitating integration with third-party systems.
idIntegerFalseNoStores the unique identifier for the timesheet, ensuring proper tracking and management.
iscompleteBooleanFalseNoIndicates whether the timesheet is marked as complete. If the value is true, no further changes can be made.
plannedhoursStringFalseNoSpecifies the number of hours initially planned for the employee, used for comparing actual vs. expected work time.
rejectedhoursStringFalseNoRecords the number of hours that were rejected during the approval process, requiring adjustment or resubmission.
startdateDateFalseNoSpecifies the first date covered by the timesheet, marking the beginning of the recorded work period.
submittedhoursStringFalseNoIndicates the total number of hours submitted for approval, providing insight into employee-reported work time.
subsidiaryStringFalseNoLinks the timesheet to a specific subsidiary, ensuring proper financial reporting for multi-entity organizations.
templatestoredStringFalseNoSpecifies the stored template associated with the timesheet, facilitating reuse of predefined work hour structures.
totalhoursStringFalseNoCalculates the total number of hours recorded in the timesheet, including approved and pending hours.
trandateDateFalseNoRecords the transaction date for the timesheet, used for payroll and accounting purposes.
workcalendarhoursStringFalseNoDefines the standard number of hours according to the work calendar, serving as a reference for work schedule compliance.

Return to Top

TimeZone 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoStores the unique identifier for the time zone, ensuring proper reference and system-wide consistency.
timezoneStringFalseNoSpecifies the time zone name or code, used for date-time calculations, scheduling, and localization settings.

Return to Top

topic 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoStores the internal identifier for the topic, uniquely identifying it within the system. This ID is used for linking topics to related discussions, solutions, and documents.
descriptionStringFalseNoProvides a brief summary of the topic, offering an overview of its key details to help users quickly understand its purpose.
externalidStringFalseNoStores an external identifier for the topic, used for seamless integration with third-party knowledge bases, CRM systems, or other external data sources.
isinactiveBooleanFalseNoIndicates whether the topic is inactive. If the value is true, the topic is archived and cannot be used in active discussions or references, ensuring outdated topics are properly managed.
longdescriptionStringFalseNoContains a detailed description of the topic, providing comprehensive information, background context, and key insights for users seeking in-depth knowledge.
parenttopicStringFalseNoSpecifies the parent topic, establishing hierarchical relationships between topics for better categorization and organization in knowledge management systems.
solutionStringFalseNoLinks relevant solutions to the topic, allowing users to find documented resolutions, best practices, and troubleshooting steps associated with the topic.

Return to Top

topicPublish 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoStores the internal identifier for the published topic, uniquely linking it to knowledge base records and ensuring proper organization within the system.
kbStringFalseNoSpecifies the knowledge base location where the topic is published, helping users navigate to relevant articles, FAQs, or documentation resources for reference.

Return to Top

topicSolutionMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
solutionStringFalseNoLinks a solution to a specific topic, allowing users to easily access relevant resolutions, best practices, and troubleshooting steps within a knowledge management system.

Return to Top

TrackingNumber 

NameTypeReadOnlyReferencesFilterOnlyDescription
idIntegerFalseNoStores the unique identifier for a tracking number, ensuring accurate association with shipments, invoices, or logistics records for real-time tracking and auditing.

Return to Top

TrackingNumberMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
trackingnumberStringFalseNoStores the tracking number associated with a shipment, order, or return, enabling real-time status updates and logistics monitoring.

Return to Top

tranPromotion 

NameTypeReadOnlyReferencesFilterOnlyDescription
couponcodeStringFalseNoStores the unique coupon code applied to a transaction, providing discounts or special offers to customers.
promocodeStringFalseNoIdentifies the promotional campaign or discount program associated with the transaction, helping track marketing effectiveness.
promotiontypeStringFalseNoDefines the type of promotion applied, such as percentage discount, fixed amount off, or free shipping, ensuring correct application of incentives.

Return to Top

transaction 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoStores the internal identifier for the transaction, uniquely linking it within the financial system for tracking and reporting.
abbrevtypeStringFalseNoSpecifies the abbreviation type used for categorizing the transaction, simplifying identification.
accountbasednumberStringFalseNoIndicates the account-based numbering format applied to the transaction, ensuring consistency in financial records.
actionitemStringFalseNoRepresents a specific action item linked to the transaction, such as a follow-up task or workflow step.
actualproductionenddateDateFalseNoRecords the actual date when production was completed for the transaction-related item or process.
actualproductionstartdateDateFalseNoIndicates the actual start date of production, aiding in tracking manufacturing or service initiation timelines.
actualshipdateDateFalseNoSpecifies the actual date when goods were shipped, ensuring accurate fulfillment and delivery tracking.
altsalestotalDecimalFalseNoStores the alternative sales total, which may reflect adjusted figures for discounts, promotions, or currency conversion.
approvalstatusIntegerFalseNoIndicates the approval status of the transaction, tracking whether it is pending, approved, or rejected.
asofdateDateFalseNoSpecifies the cut-off date for financial reporting, ensuring transactions are recorded within the correct period.
autocalculatelagBooleanFalseNoDetermines whether the system should automatically calculate time lags in processes such as production or fulfillment.
balsegstatusIntegerFalseNoIndicates whether the transaction balances across financial segments, ensuring compliance with internal reporting structures.
billingaddressStringFalseNoStores the billing address associated with the transaction, critical for invoicing and taxation purposes.
billingstatusBooleanFalseNoIndicates the current billing status of the transaction. If the value is true, the billing process has been completed.
billofmaterialsIntegerFalseNoLinks the transaction to a specific bill of materials (BOM), tracking the components used in manufacturing.
billofmaterialsrevisionIntegerFalseNoIdentifies the revision of the BOM associated with the transaction, ensuring the correct version is referenced.
buyingreasonIntegerFalseNoSpecifies the reason for the purchase associated with the transaction, aiding in customer behavior analysis and reporting.
buyingtimeframeIntegerFalseNoIndicates the expected timeframe within which the purchase decision is made, useful for sales forecasting.
closedateDateFalseNoRecords the date when the transaction was officially closed, marking its completion in the system.
committedDoubleFalseNoRepresents the number of buildable items based on current inventory levels, ensuring accurate production planning.
createdbyIntegerFalseNoIdentifies the user or system that created the transaction, ensuring accountability and tracking changes.
createddateDateFalseNoRecords the date when the transaction was created, providing a historical reference for audits and reviews.
currencyIntegerFalseNoIndicates the currency in which the transaction is recorded, ensuring proper financial reconciliation and reporting.
custbody_cseg1IntegerFalseNoStores custom segment data associated with the transaction, enabling advanced categorization and reporting.
custbody_cseg2IntegerFalseNoRepresents another custom segment field for additional categorization, allowing flexible reporting structures.
custbody_cseg3IntegerFalseNoContains test segment data, typically used for development, QA, or system testing before live deployment.
custbody_cseg4IntegerFalseNoDefines the sub-channel through which the transaction was processed, aiding in sales and marketing analytics.
customformStringFalseNoSpecifies the custom form template used for entering or displaying the transaction, ensuring consistency in data entry.
daysopenDoubleFalseNoIndicates the number of days the transaction has remained open, helping track pending financial activities.
daysoverduesearchIntegerFalseNoCalculates the number of days a transaction is overdue, useful for credit control and overdue payment management.
duedateDateFalseNoSpecifies the due date for the transaction, indicating when payment or fulfillment is expected to be completed.
emailStringFalseNoStores the email address associated with the transaction, used for sending invoices, confirmations, or customer communications.
employeeIntegerFalseNoIdentifies the sales representative or employee linked to the transaction, ensuring accountability and tracking performance.
enddateDateFalseNoRecords the end date of the transaction cycle, marking the completion of the financial or business process.
entityIntegerFalseNoRepresents the entity associated with the transaction, such as a customer, vendor, or partner, ensuring accurate financial attribution.
entitystatusIntegerFalseNoIndicates the status of the entity involved in the transaction, such as active, pending, or closed, aiding in lifecycle management.
estgrossprofitDecimalFalseNoStores the estimated gross profit for the transaction, helping in financial forecasting and profitability analysis.
estgrossprofitpercentDoubleFalseNoRepresents the estimated gross profit percentage, calculated based on revenue and cost projections.
estimatedbudgetDecimalFalseNoSpecifies the estimated budget allocated for the transaction, ensuring proper financial planning and cost control.
exchangerateStringFalseNoRecords the exchange rate applied to the transaction, facilitating accurate conversion between different currencies.
expectedclosedateDateFalseNoIndicates the projected date for the transaction to be completed or closed, useful for pipeline and revenue tracking.
externalidStringFalseNoStores an external identifier for the transaction, enabling integration with third-party systems and cross-platform tracking.
faxStringFalseNoStores the fax number associated with the transaction, often used in traditional document exchanges or confirmations.
firmedBooleanFalseNoIndicates whether the transaction has been firmed, meaning it is finalized and locked from further changes.
forecasttypeIntegerFalseNoDefines the type of forecast associated with the transaction, helping in sales predictions and business planning.
foreignamountpaidDecimalFalseNoStores the total amount paid in the transaction’s original currency, ensuring accurate financial reconciliation.
foreignamountunpaidDecimalFalseNoIndicates the unpaid portion of the transaction in its original currency, aiding in outstanding balance management.
foreignpaymentamountunusedDecimalFalseNoRepresents the portion of a payment that remains unused, calculated in the original transaction currency.
foreignpaymentamountusedDecimalFalseNoTracks the portion of the payment that has been applied to the transaction, recorded in the foreign currency.
foreigntotalDecimalFalseNoStores the total transaction amount in the foreign currency, ensuring accurate reporting in international transactions.
fulfillmenttypeIntegerFalseNoSpecifies the fulfillment type of the transaction, such as standard, backorder, or drop shipment, guiding order processing.
incotermIntegerFalseNoDefines the Incoterms (International Commercial Terms) used in the transaction, specifying buyer and seller obligations in shipping.
isactualprodenddateenteredmanuallyBooleanFalseNoIndicates whether the actual production end date was manually entered. If the value is true, it was not system-generated.
isactualprodstartdateenteredmanuallyBooleanFalseNoIndicates whether the actual production start date was manually entered. If the value is true, it was user-defined.
isbookspecificBooleanFalseNoSpecifies whether the transaction applies to a specific financial book, ensuring correct ledger alignment in multi-book accounting.
isbudgetapprovedBooleanFalseNoIndicates whether the transaction’s budget has been approved. If the value is true, spending is authorized.
isfinchrgBooleanFalseNoSpecifies whether the transaction is subject to finance charges, used in overdue payment calculations.
isreversalBooleanFalseNoIndicates whether the transaction is a reversal entry. If the value is true, it negates a previous financial entry.
iswipBooleanFalseNoDetermines whether the transaction is part of work-in-progress (WIP) tracking, helping in production cost monitoring.
journaltypeStringFalseNoSpecifies the type of journal entry associated with the transaction, such as general, adjustment, or closing entry.
lastmodifiedbyIntegerFalseNoIdentifies the user who last modified the transaction, ensuring accountability and tracking updates.
lastmodifieddateDatetimeFalseNoRecords the date and time when the transaction was last updated, useful for audit trails and version control.
leadsourceIntegerFalseNoSpecifies the lead source associated with the transaction, helping track the origin of sales opportunities.
linkedpoStringFalseNoIndicates the purchase order (PO) linked to the transaction, ensuring accurate procurement tracking.
manufacturingroutingIntegerFalseNoIdentifies the manufacturing routing used for production, tracking the process workflow for the transaction.
memdocIntegerFalseNoRepresents a memorized transaction template, allowing repetitive transactions to be automatically processed.
memoStringFalseNoStores additional notes or details related to the transaction, useful for internal documentation and context.
messageStringFalseNoContains messages or comments associated with the transaction, typically used for customer or vendor communication.
nextapproverIntegerFalseNoIdentifies the next approver in the workflow, ensuring proper authorization before transaction completion.
nextbilldateDateFalseNoSpecifies the next billing date for recurring transactions, helping in payment scheduling and automation.
nexusIntegerFalseNoDefines the tax jurisdiction (nexus) relevant to the transaction, ensuring proper tax calculation and compliance.
numberDoubleFalseNoStores the document number assigned to the transaction, ensuring unique identification for financial records.
opportunityIntegerFalseNoLinks the transaction to a sales opportunity, tracking potential revenue and sales pipeline progression.
ordpickedBooleanFalseNoIndicates whether the order has been picked from inventory. If the value is true, the order is in the fulfillment process.
ordreceivedBooleanFalseNoSpecifies whether the order has been received. If the value is true, the goods have been confirmed as delivered.
otherrefnumStringFalseNoStores a reference number such as a PO or check number, allowing cross-referencing with external systems.
partnerIntegerFalseNoIdentifies the partner associated with the transaction, ensuring proper attribution for partner programs or commissions.
paymentholdBooleanFalseNoIndicates whether payment is on hold. If the value is true, the payment is temporarily restricted from processing.
paymentmethodIntegerFalseNoDefines the payment method used for the transaction, such as credit card, wire transfer, or check.
paymentoptionIntegerFalseNoSpecifies the payment option chosen for the transaction, allowing flexibility in payment processing.
postingBooleanFalseNoIndicates whether the transaction is posted to the general ledger. If the value is true, it has been recorded in the books.
postingperiodIntegerFalseNoDefines the financial period in which the transaction is posted, ensuring accurate reporting and accounting compliance.
printedpickingticketBooleanFalseNoSpecifies whether a picking ticket has been printed for the order, aiding in warehouse operations.
probabilityDoubleFalseNoStores the probability percentage of the transaction closing successfully, used for sales forecasting and risk assessment.
projectedtotalDecimalFalseNoIndicates the projected total value of the transaction, considering estimates and adjustments.
rangehighDecimalFalseNoSpecifies the upper limit of an estimated range, used in budget or forecast calculations.
rangelowDecimalFalseNoDefines the lower limit of an estimated range, ensuring a realistic financial estimate for projections.
recordtypeStringFalseNoIndicates the type of record associated with the transaction, such as invoice, quote, or order.
reversalIntegerFalseNoIdentifies the document associated with the reversal of a transaction, ensuring correct financial adjustments.
reversaldateDateFalseNoRecords the date on which a transaction reversal occurred, ensuring accurate financial tracking.
salesreadinessIntegerFalseNoIndicates the sales readiness level of the transaction, helping sales teams prioritize leads and opportunities.
schedulingmethodStringFalseNoSpecifies the scheduling method used for the transaction, such as fixed, manual, or dynamic scheduling.
shipcompleteBooleanFalseNoIndicates whether the order should be shipped only when all items are available. If the value is true, partial shipments are not allowed.
shipdateDateFalseNoSpecifies the planned or actual shipping date for the transaction, ensuring accurate order fulfillment tracking.
shippingaddressStringFalseNoStores the shipping address for the transaction, ensuring proper delivery and logistics coordination.
sourceStringFalseNoIndicates the source of the transaction, such as online, in-store, or through a partner channel, aiding in sales analytics.
sourcetransactionIntegerFalseNoLinks the transaction to its originating transaction, ensuring clear audit trails and order dependencies.
startdateDateFalseNoSpecifies the start date for the transaction, marking the beginning of the financial or business process.
statusStringFalseNoRepresents the current status of the transaction, such as pending, approved, completed, or canceled.
termsIntegerFalseNoDefines the payment terms associated with the transaction, specifying due dates and conditions for settlement.
titleStringFalseNoStores the title or label associated with the transaction, providing a quick reference for users.
tosubsidiaryIntegerFalseNoIdentifies the subsidiary to which the transaction is related, ensuring proper financial reporting in multi-entity businesses.
totalcostestimateDecimalFalseNoRepresents the estimated total cost of the transaction, used for financial planning and cost tracking.
trandateDateFalseNoRecords the date on which the transaction occurred, ensuring chronological order in financial records.
trandisplaynameStringFalseNoDisplays the formatted name of the transaction, used for easy identification in reports and searches.
tranidStringFalseNoStores the unique document number or ID assigned to the transaction, ensuring easy reference and retrieval.
transactionnumberStringFalseNoRepresents the system-generated transaction number, used for tracking and reconciliation.
transferlocationIntegerFalseNoSpecifies the destination location for a transfer transaction, ensuring correct inventory movement tracking.
typeStringFalseNoDefines the type of transaction, such as sales order, invoice, payment, or transfer, ensuring proper classification.
typebaseddocumentnumberStringFalseNoStores a document number based on the transaction type, ensuring consistency across different financial records.
useitemcostastransfercostBooleanFalseNoIndicates whether the item’s cost should be used as the transfer cost. If the value is true, item-level costing applies.
userevenuearrangementBooleanFalseNoSpecifies whether the transaction generates a revenue arrangement, ensuring compliance with revenue recognition policies.
visibletocustomerBooleanFalseNoIndicates whether the transaction details are visible in the customer center. If the value is true, customers can view related records.
voidBooleanFalseNoSpecifies whether the transaction has been voided. If the value is true, the transaction is canceled but remains in records for audit purposes.
voidedBooleanFalseNoIndicates whether the transaction has been marked as void, ensuring accurate financial reporting.
websiteIntegerFalseNoIdentifies the website associated with the transaction, tracking sales channels and e-commerce activity.
weightedtotalDecimalFalseNoCalculates the weighted total value of the transaction, considering factors such as probability and estimated revenue.
winlossreasonIntegerFalseNoStores the reason why a transaction was won or lost, helping sales teams analyze performance and improve strategies.

Return to Top

TransactionAccountingLine 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoSpecifies the general ledger account associated with the transaction accounting line, ensuring accurate financial reporting.
accountingbookStringFalseNoIndicates the accounting book in which this transaction is recorded, supporting multi-book accounting compliance.
amountDecimalFalseNoRepresents the total monetary value recorded for this transaction line, used for financial calculations and reporting.
amountpaidDecimalFalseNoIndicates the portion of the transaction that has been paid, ensuring accurate tracking of settled amounts.
amountunpaidDecimalFalseNoSpecifies the remaining unpaid amount of the transaction, helping in outstanding balance tracking and collections.
creditDecimalFalseNoRecords the credit amount applied to the transaction, ensuring accurate double-entry bookkeeping.
debitDecimalFalseNoRepresents the debit amount recorded in the transaction, used in financial accounting to balance journal entries.
exchangerateDecimalFalseNoStores the exchange rate used for currency conversion, ensuring correct valuation of foreign transactions.
netamountDecimalFalseNoCalculates the net amount of the transaction after applicable credits, debits, and adjustments.
overheadparentitemStringFalseNoIdentifies the parent item associated with material overhead costs, ensuring proper cost allocation in manufacturing.
paymentamountunusedDecimalFalseNoSpecifies the portion of the payment that remains unused, which can be applied to future transactions.
paymentamountusedDecimalFalseNoIndicates the amount of payment that has been applied to the transaction, ensuring accurate financial reconciliation.
postingBooleanFalseNoDetermines whether this accounting line has been posted to the general ledger. If the value is true, the entry is finalized.
transactionStringFalseNoLinks the accounting line to the related transaction, enabling detailed financial tracking and auditing.

Return to Top

TransactionAccountingLineCostComponent 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountingbookStringFalseNoIndicates the accounting book in which this cost component is recorded, supporting multi-book accounting and financial reporting.
amountDecimalFalseNoRepresents the total monetary value of the cost component recorded for the transaction, ensuring accurate cost calculations.
componentitemStringFalseNoIdentifies the specific component item associated with the cost component, helping track material or service costs.
costcategoryStringFalseNoDefines the cost category assigned to the component, such as labor, materials, or overhead, ensuring detailed cost classification.
standardcostDecimalFalseNoStores the standard cost value assigned to the component, used for cost accounting and variance analysis.
standardcostquantityDoubleFalseNoSpecifies the quantity used in the standard cost calculation, ensuring accurate cost estimations and financial planning.
transactionStringFalseNoLinks the cost component to the related transaction, allowing for detailed financial tracking and auditing.
transactionaccountinglineStringFalseNoAssociates the cost component with a specific transaction accounting line, ensuring precise financial record-keeping.

Return to Top

transactionAddressbook 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoStores the internal identifier for the address book entry, uniquely identifying it within the transaction system.
defaultbillingBooleanFalseNoIndicates whether this address is set as the default billing address for the transaction. If the value is true, it is automatically used for invoices.
defaultshippingBooleanFalseNoSpecifies whether this address is the default shipping address for the transaction. If the value is true, it is preselected for order fulfillment.
labelStringFalseNoStores a custom label or description for the address book entry, helping users easily identify different addresses within a transaction.

Return to Top

transactionAddressMapping 

NameTypeReadOnlyReferencesFilterOnlyDescription
addressStringFalseNoStores the full address associated with the transaction, ensuring accurate location details for billing and shipping.
addresstypeStringFalseNoIndicates whether the address is a billing or shipping address, helping differentiate between financial and delivery locations.
createdbyStringFalseNoIdentifies the user or system that created the address mapping entry, ensuring accountability and tracking changes.
createddateDateFalseNoRecords the date when the address mapping entry was created, providing a historical reference for audits and tracking updates.

Return to Top

transactionAddressMappingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoRepresents a unique key associated with the address entry, ensuring proper linkage within transaction records.
addr1StringFalseNoStores the primary street address for the location, providing essential details for billing and shipping.
addr2StringFalseNoContains additional address details such as apartment number, suite, or floor to ensure precise location identification.
addr3StringFalseNoStores further address information when additional location details are required, often used for large complexes or buildings.
addresseeStringFalseNoSpecifies the name of the recipient or business associated with the address, ensuring proper delivery and invoicing.
attentionStringFalseNoIncludes the name of a specific person or department to whom the package or correspondence should be directed.
cityStringFalseNoRecords the city where the address is located, essential for geographical identification and logistics.
countryStringFalseNoIndicates the country associated with the address, ensuring compliance with international shipping and tax regulations.
dropdownstateStringFalseNoRepresents the state selection from a dropdown field, used for consistency in regional categorization.
overrideBooleanFalseNoIndicates whether the system allows overriding standard address validation rules. If the value is true, users can modify the address manually.
stateStringFalseNoStores the state or province associated with the address, critical for regional taxation and shipping classification.

Return to Top

transactionBilling 

NameTypeReadOnlyReferencesFilterOnlyDescription
billnetamountforeignDoubleFalseNoRepresents the net billed amount in a foreign currency, ensuring accurate international financial reporting.
paymenttermsIntegerFalseNoSpecifies the payment terms associated with the billing transaction, defining due dates and payment conditions.
transactionlineIntegerFalseNoIdentifies the specific transaction line associated with the billing entry, ensuring detailed financial tracking.
billnetamountDoubleFalseNoStores the net billed amount after discounts and adjustments, used for accurate financial calculations.
revrecstartdateDateFalseNoIndicates the start date for revenue recognition, ensuring compliance with financial reporting standards.
billcountDoubleFalseNoRecords the number of bills generated for the transaction, used for tracking installment or recurring billing scenarios.
revrecenddateDateFalseNoSpecifies the end date for revenue recognition, ensuring revenue is recognized over the appropriate period.
billamountDoubleFalseNoRepresents the total billed amount before any deductions or adjustments, ensuring accurate invoice calculations.
billdateDateFalseNoStores the date on which the bill was issued, essential for payment tracking and aging analysis.
transactionIntegerFalseNoLinks the billing entry to the associated transaction, enabling comprehensive financial reporting.
billamountforeignIntegerFalseNoIndicates the total billed amount in a foreign currency, ensuring correct conversion and reconciliation for international transactions.

Return to Top

transactionBillingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoRepresents a unique key associated with the billing address entry, ensuring proper linkage within transaction records.
addr1StringFalseNoStores the primary street address for billing purposes, ensuring accurate invoicing and financial documentation.
addr2StringFalseNoContains additional address details such as apartment number, suite, or floor, ensuring precise billing location identification.
addr3StringFalseNoStores further address information when additional details are needed for complex billing addresses.
addresseeStringFalseNoSpecifies the name of the recipient or business responsible for the billing transaction, ensuring proper invoicing.
attentionStringFalseNoIncludes the name of a specific person or department that should receive the invoice or billing communication.
cityStringFalseNoRecords the city associated with the billing address, ensuring proper regional tax calculation and compliance.
countryStringFalseNoIndicates the country of the billing address, ensuring compliance with international taxation and invoicing rules.
dropdownstateStringFalseNoRepresents the state selection from a dropdown field, used for consistency in address validation.
overrideBooleanFalseNoIndicates whether the system allows manual overriding of standard billing address validation rules. If the value is true, users can modify the address manually.
stateStringFalseNoStores the state or province associated with the billing address, ensuring proper tax and regulatory classification.

Return to Top

transactionBillingAddressbook 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoStores the internal identifier for the billing address book entry, uniquely identifying it within the system.
addressbookaddressStringFalseNoContains the billing address details stored in the address book, enabling quick selection and modification.
defaultbillingBooleanFalseNoIndicates whether this address is the default billing address for the transaction. If the value is true, it is automatically used for invoicing.
defaultshippingBooleanFalseNoSpecifies whether this address is the default shipping address for the transaction. If the value is true, it is preselected for order fulfillment.
labelStringFalseNoStores a custom label or identifier for the billing address book entry, helping users distinguish between multiple addresses.

Return to Top

transactionBillingAddressbookEntityAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoRepresents a unique key associated with the entity’s billing address entry, ensuring proper linkage within transaction records.
addr1StringFalseNoStores the primary street address for the entity’s billing location, ensuring accurate invoicing and financial documentation.
addr2StringFalseNoContains additional address details such as apartment number, suite, or floor, ensuring precise billing location identification.
addr3StringFalseNoStores further address information when additional details are needed for complex billing addresses.
addresseeStringFalseNoSpecifies the name of the recipient or business responsible for the billing transaction, ensuring proper invoicing.
attentionStringFalseNoIncludes the name of a specific person or department that should receive the invoice or billing communication.
cityStringFalseNoRecords the city associated with the entity’s billing address, ensuring proper regional tax calculation and compliance.
countryStringFalseNoIndicates the country of the entity’s billing address, ensuring compliance with international taxation and invoicing rules.
dropdownstateStringFalseNoRepresents the state selection from a dropdown field, used for consistency in address validation.
overrideBooleanFalseNoIndicates whether the system allows manual overriding of standard billing address validation rules. If the value is true, users can modify the address manually.
stateStringFalseNoStores the state or province associated with the entity’s billing address, ensuring proper tax and regulatory classification.

Return to Top

transactionCompetitor 

NameTypeReadOnlyReferencesFilterOnlyDescription
competitorStringFalseNoIdentifies the competitor associated with the transaction, aiding in competitive analysis and market positioning.
notesStringFalseNoStores additional notes or comments regarding the competitor, providing insights for sales strategy and decision-making.
opportunityStringFalseNoLinks the transaction to a specific sales opportunity, helping track competitive dynamics and deal progress.

Return to Top

transactionLine 

NameTypeReadOnlyReferencesFilterOnlyDescription
uniquekey [KEY]IntegerFalseNoStores the unique key assigned to the transaction line, ensuring accurate record identification and tracking.
id [KEY]IntegerFalseNoRepresents the internal identifier of the transaction line, uniquely distinguishing it from other entries.
actualshipdateDateFalseNoRecords the actual date when the item was shipped, received, or picked up, ensuring accurate logistics tracking.
accountinglinetypeDateFalseNoIndicates the end date of the amortization schedule, ensuring proper revenue and expense recognition.
amortizationresidualStringFalseNoStores the remaining residual value after amortization calculations, aiding in financial forecasting.
amortizationschedStringFalseNoLinks the transaction line to the amortization schedule, ensuring structured cost allocation over time.
amortizstartdateDateFalseNoRecords the start date of the amortization period, defining when financial adjustments begin.
amountlinkedDecimalFalseNoIndicates the amount linked to this transaction line from related financial records, supporting reconciliations.
assemblycomponentBooleanFalseNoDetermines whether the transaction line represents an assembly component. If the value is true, it is part of a bill of materials.
billeddateDateFalseNoSpecifies the date when the transaction line was billed, ensuring accurate financial reporting and invoicing.
billingscheduleStringFalseNoDefines the billing schedule applied to this transaction line, managing installment or recurring billing scenarios.
billvariancestatusStringFalseNoTracks whether there is a variance in the billed amount compared to expected values, ensuring financial accuracy.
blandedcostBooleanFalseNoIndicates whether the transaction line includes landed costs. If the value is true, additional cost elements are considered in calculations.
bomquantityDecimalFalseNoStores the quantity of components required per the bill of materials (BOM), used in manufacturing and cost tracking.
buildvarianceDoubleFalseNoRepresents the variance between planned and actual production quantities, ensuring accurate cost and inventory management.
categoryStringFalseNoSpecifies the expense category associated with the transaction line, enabling accurate financial classification.
chargetypeStringFalseNoDefines the type of charge applied to the transaction, such as freight, service fees, or handling charges.
classStringFalseNoIndicates the classification of the transaction line, often used for reporting and financial segmentation.
clearedBooleanFalseNoSpecifies whether the transaction line has been cleared for financial settlement. If the value is true, the transaction is reconciled.
cleareddateDateFalseNoRecords the date when the transaction line was cleared, ensuring accurate reconciliation in financial reporting.
commitinventoryStringFalseNoSpecifies how inventory commitment is handled for the transaction line, ensuring stock availability tracking.
commitmentfirmBooleanFalseNoIndicates whether the commitment is firm and cannot be altered. If the value is true, the inventory is allocated permanently.
componentyieldDoubleFalseNoRecords the expected yield percentage of components in production, used for inventory and cost management.
costestimateDecimalFalseNoStores the estimated cost of the transaction line, aiding in budgeting and financial planning.
costestimaterateStringFalseNoRepresents the estimated cost rate applied to the transaction line, ensuring pricing consistency.
costestimatetypeStringFalseNoDefines the method used to estimate costs for the transaction line, supporting financial projections.
createdfromStringFalseNoIndicates the source from which this transaction line was generated, ensuring traceability in financial records.
createdpoStringFalseNoSpecifies whether the transaction line is linked to a special purchase order, used for tracking procurement processes.
creditforeignamountDecimalFalseNoRecords the credited amount in the transaction’s foreign currency, ensuring accurate financial reconciliation for international transactions.
debitforeignamountDecimalFalseNoRecords the debited amount in the transaction’s foreign currency, ensuring accurate international financial reporting.
departmentStringFalseNoSpecifies the department associated with the transaction line, supporting cost allocation and departmental tracking.
documentnumberStringFalseNoStores the document number assigned to the transaction, ensuring unique identification and reference.
donotdisplaylineBooleanFalseNoIndicates whether the transaction line should be hidden from standard views. If the value is true, it is a technical entry.
dropshipBooleanFalseNoDetermines whether the item in the transaction is a drop-ship item. If the value is true, the item is shipped directly from the supplier.
duetofromsubsidiaryIntegerFalseNoLinks the transaction line to an intercompany transaction between subsidiaries, ensuring proper accounting reconciliation.
entityStringFalseNoIdentifies the entity (such as a customer, vendor, or employee) associated with the transaction line, supporting financial tracking.
estgrossprofitDecimalFalseNoStores the estimated gross profit for the transaction line, helping assess profitability at an item level.
estgrossprofitpercentDoubleFalseNoCalculates the estimated gross profit percentage for the transaction line, ensuring accurate profitability analysis.
estimatedamountDecimalFalseNoRepresents the estimated amount for the transaction line, often used in budgeting and forecasting scenarios.
expectedreceiptdateDateFalseNoSpecifies the expected date for receiving the items in the transaction, supporting inventory and logistics planning.
expectedshipdateDateFalseNoIndicates the expected shipping date for the items in the transaction, helping in order fulfillment tracking.
expenseaccountStringFalseNoDefines the expense account associated with the transaction line, ensuring correct financial postings in the general ledger.
foreignamountDecimalFalseNoStores the transaction amount in a foreign currency, ensuring proper exchange rate calculations and financial reporting.
foreignamountpaidDecimalFalseNoIndicates the amount that has been paid in the foreign currency of the transaction, ensuring accurate payment tracking.
foreignamountunpaidDecimalFalseNoSpecifies the remaining unpaid amount in the transaction’s foreign currency, useful for outstanding balances.
foreignpaymentamountunusedDecimalFalseNoRecords the portion of a payment that remains unused in the transaction’s foreign currency.
foreignpaymentamountusedDecimalFalseNoIndicates the amount of payment applied to the transaction in the foreign currency, ensuring accurate reconciliation.
fulfillableBooleanFalseNoDetermines whether the transaction line contains items that need to be fulfilled. If the value is true, fulfillment is required.
fxamountlinkedDecimalFalseNoSpecifies the amount linked to another transaction in the foreign currency, ensuring correct inter-transaction tracking.
hasfulfillableitemsBooleanFalseNoIndicates whether the transaction includes fulfillable items. If the value is true, at least one item requires fulfillment.
inventorylocationStringFalseNoDefines the inventory location where the items in the transaction are stored, ensuring proper stock tracking.
inventoryreportinglocationStringFalseNoSpecifies the reporting location for inventory in multi-location warehouses, supporting inventory management.
inventorysubsidiaryStringFalseNoLinks the transaction line to the subsidiary that owns the inventory, ensuring proper financial consolidation.
isbillableBooleanFalseNoDetermines whether the transaction line is billable. If the value is true, the amount can be invoiced to the customer.
isclosedBooleanFalseNoIndicates whether the transaction line has been closed. If the value is true, no further modifications or processing is allowed.
iscogsBooleanFalseNoDetermines whether the transaction line represents a cost of goods sold (COGS) entry, ensuring accurate expense tracking.
isfullyshippedBooleanFalseNoSpecifies whether the items in the transaction have been fully shipped, received, or picked up. If the value is true, fulfillment is complete.
isfxvarianceBooleanFalseNoIndicates whether the transaction line has a foreign exchange variance. If the value is true, currency conversion differences exist.
isinventoryaffectingBooleanFalseNoIndicates whether the transaction line affects inventory levels. If the value is true, stock adjustments occur.
isrevrectransactionBooleanFalseNoDetermines if the transaction line is part of amortization or revenue recognition processes.
isscrapBooleanFalseNoSpecifies whether the item in this transaction line is classified as scrap. If the value is true, it is not part of inventory valuation.
itemStringFalseNoRepresents the item associated with the transaction line, ensuring proper product or service identification.
itemtypeStringFalseNoDefines the type of item recorded in the transaction line, such as inventory, service, or non-inventory.
kitcomponentBooleanFalseNoIndicates whether the transaction line is part of a kit or bundle. If the value is true, it is a kit component.
kitmemberofIntegerFalseNoIdentifies the parent transaction line that this component belongs to within a kit or bundle.
landedcostcategoryStringFalseNoDefines the landed cost category associated with the transaction line, such as shipping, duties, or handling fees.
landedcostperlineBooleanFalseNoDetermines whether landed costs are applied per line item. If the value is true, costs are allocated at a detailed level.
linelastmodifieddateDatetimeFalseNoRecords the date and time when the transaction line was last modified, ensuring accurate audit tracking.
linesequencenumberIntegerFalseNoStores the sequence number of the transaction line, ensuring proper order in multi-line transactions.
locationStringFalseNoSpecifies the physical or logical location associated with the transaction line, often used for inventory tracking.
mainlineBooleanFalseNoIndicates whether the transaction line represents the main transaction entry. If the value is true, it is the primary record.
matchbilltoreceiptBooleanFalseNoSpecifies whether the transaction line is matched to a receipt for verification. If the value is true, it ensures billing accuracy.
memoStringFalseNoStores additional information or comments related to the transaction line, helping in documentation and reporting.
netamountDecimalFalseNoRepresents the net amount of the transaction line after discounts and adjustments, recorded in the transaction currency.
oldcommitmentfirmBooleanFalseNoIndicates whether the previous inventory commitment was firm. If the value is true, changes were restricted.
orderpriorityDoubleFalseNoSpecifies the priority level assigned to the transaction line, helping in order fulfillment sequencing.
paymentmethodStringFalseNoDefines the payment method associated with the transaction line, such as credit card, wire transfer, or cash.
priceStringFalseNoSpecifies the price level applied to the transaction line, ensuring correct pricing based on customer agreements or tiers.
processedbyrevcommitBooleanFalseNoDetermines whether the transaction line was processed by the revenue commitment module for financial recognition.
quantityDoubleFalseNoStores the quantity of items or units associated with the transaction line, ensuring proper inventory and billing tracking.
quantitybackorderedDoubleFalseNoIndicates the quantity of items that were backordered due to stock unavailability.
quantitybilledDoubleFalseNoRecords the quantity of items that have been billed to the customer, ensuring correct invoicing.
quantitycommittedDoubleFalseNoRepresents the quantity of items allocated to an order, ensuring stock is reserved for fulfillment.
quantityonshipmentsDoubleFalseNoSpecifies the quantity of items currently assigned to outgoing shipments, ensuring accurate logistics tracking.
quantitypickedDoubleFalseNoIndicates the number of items that have been picked for order fulfillment but not yet shipped.
quantityrejectedDoubleFalseNoRecords the quantity of items that were rejected due to quality issues or discrepancies in the transaction.
quantityshiprecvDoubleFalseNoRepresents the quantity of items that have been shipped, received, or picked up, ensuring accurate inventory tracking.
rateDecimalFalseNoStores the rate applied to the transaction line, ensuring accurate pricing and financial calculations.
requestdateDateFalseNoIndicates the date when the item or service was requested, supporting scheduling and demand planning.
requestnoteStringFalseNoStores additional notes related to the request, providing further details for internal processing.
shipmethodStringFalseNoDefines the shipping method used for this transaction line, ensuring proper logistics coordination.
specialorderBooleanFalseNoDetermines whether the transaction line item is classified as a special order. If the value is true, it requires unique handling.
subsidiaryStringFalseNoIdentifies the subsidiary responsible for the transaction, ensuring accurate financial consolidation in multi-entity businesses.
taxlineBooleanFalseNoIndicates whether the transaction line represents a tax entry. If the value is true, it is used for tax calculations.
transactionStringFalseNoLinks the transaction line to the main transaction record, ensuring accurate financial tracking and auditing.
transactiondiscountBooleanFalseNoSpecifies whether the transaction line is subject to a discount. If the value is true, discounts apply to this line item.
transactionlinetypeStringFalseNoDefines the type of transaction line, such as sales, purchase, or journal entry, ensuring correct financial classification.
transferorderitemlineidIntegerFalseNoStores the unique identifier for the item line in a transfer order, ensuring proper tracking of stock movements.
unitsStringFalseNoDefines the measurement units associated with the transaction line, such as pieces, kilograms, or hours.
vsoeisestimateBooleanFalseNoDetermines whether the transaction line is an estimated value under Vendor-Specific Objective Evidence (VSOE) guidelines.

Return to Top

transactionLineAddressMapping 

NameTypeReadOnlyReferencesFilterOnlyDescription
addressStringFalseNoStores the full address associated with the transaction line, ensuring accurate location details for billing and shipping.
addresstypeStringFalseNoIndicates whether the address is used for billing or shipping, helping differentiate between financial and delivery locations.
createdbyStringFalseNoIdentifies the user or system that created the address mapping entry, ensuring accountability and change tracking.
createddateDateFalseNoRecords the date when the address mapping entry was created, providing a historical reference for audits and updates.
transactionStringFalseNoLinks the address mapping entry to the related transaction, enabling clear tracking of addresses used in orders and financial records.

Return to Top

transactionLineAddressMappingLineAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoRepresents a unique key associated with the line address entry, ensuring proper linkage within transaction records.
addr1StringFalseNoStores the primary street address for the transaction line, ensuring accurate location details for shipping and billing.
addr2StringFalseNoContains additional address details such as apartment number, suite, or floor, ensuring precise location identification.
addr3StringFalseNoStores further address information when additional details are needed for complex addresses.
addresseeStringFalseNoSpecifies the name of the recipient or business associated with the address, ensuring proper invoicing and delivery.
attentionStringFalseNoIncludes the name of a specific person or department to whom the package or correspondence should be directed.
cityStringFalseNoRecords the city associated with the line address, ensuring proper geographical identification and logistics.
countryStringFalseNoIndicates the country of the line address, ensuring compliance with international shipping and tax regulations.
dropdownstateStringFalseNoRepresents the state selection from a dropdown field, used for consistency in regional categorization.
overrideBooleanFalseNoIndicates whether the system allows overriding standard address validation rules. If the value is true, users can manually modify the address.
stateStringFalseNoStores the state or province associated with the line address, ensuring proper tax and regulatory classification.

Return to Top

TransactionNumberingAuditLog 

NameTypeReadOnlyReferencesFilterOnlyDescription
authorStringFalseNoStores the identifier of the user or system that created the transaction number, ensuring accountability.
authornameStringFalseNoRecords the name of the user or system that assigned the transaction number, providing clarity in audit logs.
dateallocatedDateFalseNoIndicates the date when the transaction number was assigned, ensuring chronological tracking of allocations.
datedeletedDateFalseNoStores the date when the transaction number was removed, enabling auditing of deleted records.
deletedbyStringFalseNoRecords the identifier of the user or system that deleted the transaction number, ensuring accountability in audit logs.
deletedbynameStringFalseNoStores the name of the user who deleted the transaction number, providing transparency in auditing.
locationStringFalseNoSpecifies the location associated with the transaction number, ensuring accurate geographical tracking of transactions.
locationusedBooleanFalseNoIndicates whether the transaction number assignment was location-based. If the value is true, location-specific numbering applies.
messageStringFalseNoStores any relevant messages or system-generated logs related to the transaction number allocation or deletion.
overrideallowedBooleanFalseNoDetermines whether the assigned transaction number can be overridden. If the value is true, manual modification is permitted.
subsidiaryStringFalseNoLinks the transaction number to a specific subsidiary, ensuring proper financial and operational segregation.
subsidiaryusedBooleanFalseNoIndicates whether the transaction number was assigned at the subsidiary level. If the value is true, numbering follows a subsidiary-specific scheme.
trannumberStringFalseNoStores the unique transaction number assigned to a record, ensuring traceability and proper sequencing in financial records.
transactionStringFalseNoLinks the audit log entry to the transaction it pertains to, enabling easy reference and reconciliation.

Return to Top

transactionPartner 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoIndicates the percentage contribution of the partner to the transaction, ensuring proper revenue and commission tracking.
isprimaryBooleanFalseNoDetermines whether the partner is designated as the primary partner for this transaction. If the value is true, they are the main partner.
partnerStringFalseNoStores the identifier of the partner associated with the transaction, ensuring proper linkage for commission or revenue sharing.
partnerroleStringFalseNoDefines the role of the partner in the transaction, such as reseller, referral, or affiliate, supporting business relationship tracking.

Return to Top

transactionPayeeAddressbook 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoStores the internal identifier for the payee address book entry, uniquely identifying it within the system.
addressbookaddressStringFalseNoContains the payee’s address details stored in the address book, enabling quick selection and modification for financial transactions.
defaultbillingBooleanFalseNoIndicates whether this address is the default billing address for the payee. If the value is true, it is automatically used for payments and invoices.
defaultshippingBooleanFalseNoSpecifies whether this address is the default shipping address for the payee. If the value is true, it is preselected for deliveries or shipments.
labelStringFalseNoStores a custom label or identifier for the payee’s address book entry, helping users distinguish between multiple addresses.

Return to Top

transactionPayeeAddressbookEntityAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoRepresents a unique key associated with the entity’s payee address entry, ensuring proper linkage within transaction records.
addr1StringFalseNoStores the primary street address for the payee’s location, ensuring accurate invoicing and financial documentation.
addr2StringFalseNoContains additional address details such as apartment number, suite, or floor, ensuring precise payee location identification.
addr3StringFalseNoStores further address information when additional details are required for complex payee addresses.
addresseeStringFalseNoSpecifies the name of the recipient or business responsible for the payee transaction, ensuring proper invoicing.
attentionStringFalseNoIncludes the name of a specific person or department that should receive the invoice or financial communication.
cityStringFalseNoRecords the city associated with the payee’s address, ensuring proper regional tax calculation and compliance.
countryStringFalseNoIndicates the country of the payee’s address, ensuring compliance with international taxation and payment regulations.
dropdownstateStringFalseNoRepresents the state selection from a dropdown field, used for consistency in address validation.
overrideBooleanFalseNoIndicates whether the system allows overriding standard payee address validation rules. If the value is true, users can manually modify the address.
stateStringFalseNoStores the state or province associated with the payee’s address, ensuring proper tax and regulatory classification.

Return to Top

transactionReturnAddressbook 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoStores the internal identifier for the return address book entry, uniquely identifying it within the system.
addressbookaddressStringFalseNoContains the return address details stored in the address book, enabling quick selection and modification for return transactions.
defaultbillingBooleanFalseNoIndicates whether this address is the default billing address for the return transaction. If the value is true, it is automatically used for refunds or adjustments.
defaultshippingBooleanFalseNoSpecifies whether this address is the default shipping address for returned items. If the value is true, it is preselected for return shipments.
labelStringFalseNoStores a custom label or identifier for the return address book entry, helping users distinguish between multiple return addresses.

Return to Top

transactionReturnAddressbookEntityAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoRepresents a unique key associated with the entity’s return address entry, ensuring proper linkage within transaction records.
addr1StringFalseNoStores the primary street address for the return location, ensuring accurate processing of returned shipments or refunds.
addr2StringFalseNoContains additional address details such as apartment number, suite, or floor, ensuring precise identification of the return location.
addr3StringFalseNoStores further address information when additional details are required for complex return addresses.
addresseeStringFalseNoSpecifies the name of the recipient or business responsible for handling the return transaction, ensuring proper documentation.
attentionStringFalseNoIncludes the name of a specific person or department responsible for processing returns, ensuring correct handling.
cityStringFalseNoRecords the city associated with the return address, ensuring accurate geographical identification for return shipments.
countryStringFalseNoIndicates the country of the return address, ensuring compliance with international shipping and tax regulations.
dropdownstateStringFalseNoRepresents the state selection from a dropdown field, used for consistency in address validation.
overrideBooleanFalseNoIndicates whether the system allows overriding standard return address validation rules. If the value is true, users can manually modify the address.
stateStringFalseNoStores the state or province associated with the return address, ensuring proper tax and regulatory classification.

Return to Top

transactionSalesTeam 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoIndicates the percentage contribution of the sales team member to the transaction, supporting commission and revenue tracking.
employeeStringFalseNoStores the identifier of the sales team employee associated with the transaction, ensuring proper attribution and tracking.
isprimaryBooleanFalseNoDetermines whether the employee is designated as the primary sales representative for the transaction. If the value is true, they are the main contact.
salesroleStringFalseNoDefines the role of the sales team member in the transaction, such as account manager or sales executive, ensuring structured team responsibilities.

Return to Top

TransactionShipment 

NameTypeReadOnlyReferencesFilterOnlyDescription
destinationaddressStringFalseNoStores the shipping destination address for the transaction, ensuring accurate delivery information.
docStringFalseNoLinks the shipment to its parent transaction, such as a sales order or invoice, ensuring traceability in fulfillment processes.
handlingrateDecimalFalseNoRepresents the handling fee applied to the shipment, ensuring accurate cost calculation.
isfulfilledtransactionBooleanFalseNoIndicates whether the shipment has been fulfilled. If the value is true, the order has been shipped or delivered.
shippingmethodStringFalseNoSpecifies the shipping method used for the transaction, such as standard, expedited, or freight, ensuring proper logistics handling.
shippingrateDecimalFalseNoStores the cost of shipping associated with the transaction, ensuring accurate financial reporting.
sourceaddressStringFalseNoRecords the origin address from which the shipment is sent, ensuring clear documentation of shipping locations.
uniquekeyIntegerFalseNoRepresents a unique identifier for the shipment transaction, ensuring proper record tracking and reference.

Return to Top

transactionShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoRepresents a unique key associated with the shipping address entry, ensuring proper linkage within transaction records.
addr1StringFalseNoStores the primary street address for the shipping location, ensuring accurate delivery details.
addr2StringFalseNoContains additional address details such as apartment number, suite, or floor, ensuring precise shipping location identification.
addr3StringFalseNoStores further address information when additional details are required for complex shipping addresses.
addresseeStringFalseNoSpecifies the name of the recipient or business receiving the shipment, ensuring accurate delivery processing.
attentionStringFalseNoIncludes the name of a specific person or department responsible for receiving the shipment, ensuring proper handling.
cityStringFalseNoRecords the city associated with the shipping address, ensuring proper geographical identification for logistics and taxation.
countryStringFalseNoIndicates the country of the shipping address, ensuring compliance with international shipping regulations.
dropdownstateStringFalseNoRepresents the state selection from a dropdown field, ensuring standardized regional categorization.
overrideBooleanFalseNoIndicates whether the system allows overriding standard shipping address validation rules. If the value is true, users can manually modify the address.
stateStringFalseNoStores the state or province associated with the shipping address, ensuring accurate tax calculations and regulatory compliance.

Return to Top

transactionShippingAddressbook 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoStores the internal identifier for the shipping address book entry, uniquely identifying it within the system.
addressbookaddressStringFalseNoContains the shipping address details stored in the address book, enabling quick selection and modification for shipments.
defaultbillingBooleanFalseNoIndicates whether this address is the default billing address for shipments. If the value is true, it is automatically used for invoices.
defaultshippingBooleanFalseNoSpecifies whether this address is the default shipping address for shipments. If the value is true, it is preselected for deliveries.
labelStringFalseNoStores a custom label or identifier for the shipping address book entry, helping users distinguish between multiple saved addresses.

Return to Top

transactionShippingAddressbookEntityAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoRepresents a unique key associated with the shipping address entry, ensuring proper linkage within transaction records.
addr1StringFalseNoStores the primary street address for the shipping destination, ensuring accurate logistics and fulfillment.
addr2StringFalseNoContains additional address details such as apartment number, suite, or floor, ensuring precise delivery location identification.
addr3StringFalseNoStores further address information when additional details are needed for complex shipping addresses.
addresseeStringFalseNoSpecifies the name of the recipient or business receiving the shipment, ensuring correct and efficient delivery.
attentionStringFalseNoIncludes the name of a specific person or department that should receive the shipment, helping with delivery accuracy.
cityStringFalseNoRecords the city associated with the shipping address, ensuring accurate geographical identification for logistics and taxation.
countryStringFalseNoIndicates the country of the shipping address, ensuring compliance with international shipping and tax regulations.
dropdownstateStringFalseNoRepresents the state selection from a dropdown field, used for consistency in address standardization.
overrideBooleanFalseNoIndicates whether the system allows overriding standard shipping address validation rules. If the value is true, users can manually modify the address.
stateStringFalseNoStores the state or province associated with the shipping address, ensuring accurate tax calculations and regulatory compliance.

Return to Top

transactionStatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
idStringFalseNoRepresents the unique identifier assigned to the transaction status, ensuring proper categorization and tracking.
trancustomtypeIntegerFalseNoIndicates a custom transaction type associated with this status, used for distinguishing different types of transactions.
fullnameStringFalseNoStores the full descriptive name of the transaction status, providing clarity in reporting and user interfaces.
nameStringFalseNoStores the short name of the transaction status, used for quick identification in records and reports.
trantypeStringFalseNoDefines the type of transaction associated with this status, such as sales order, invoice, or return, ensuring proper classification.

Return to Top

transferorder 

NameTypeReadOnlyReferencesFilterOnlyDescription
althandlingcostDecimalFalseNoStores an alternative handling cost applied to the transfer order, ensuring flexibility in cost adjustments.
altshippingcostDecimalFalseNoRecords an alternative shipping cost associated with the transfer order, allowing for cost variations.
classStringFalseNoDefines the classification or category associated with the transfer order, supporting internal reporting and tracking.
createddateDatetimeFalseNoIndicates the date and time when the transfer order was created, ensuring chronological tracking.
createdfromStringFalseNoSpecifies the source transaction from which this transfer order was generated, enabling clear document linkage.
currencyStringFalseNoIdentifies the currency used for the transfer order, ensuring accurate financial calculations and reporting.
currencynameStringFalseNoStores the full name of the currency applied to the transaction, ensuring clarity in financial records.
currencysymbolStringFalseNoRecords the symbol associated with the currency used in the transaction, ensuring proper financial display.
customformStringFalseNoSpecifies the custom form template used for this transfer order, supporting business-specific document formats.
departmentStringFalseNoLinks the transfer order to a specific department, ensuring proper expense allocation and tracking.
employeeStringFalseNoIdentifies the employee responsible for processing or managing the transfer order, ensuring accountability.
entitynexusStringFalseNoStores the nexus entity related to the transfer order, ensuring compliance with tax jurisdictions and regulations.
exchangerateDecimalFalseNoRepresents the exchange rate applied to the transfer order if multiple currencies are involved, ensuring accurate conversions.
externalidStringFalseNoStores an external identifier for the transfer order, used for integration with third-party systems or references.
firmedBooleanFalseNoIndicates whether the transfer order is firmed. If the value is true, modifications to the order are restricted.
fobStringFalseNoDefines the Free On Board (FOB) terms applied to the shipment in the transfer order, specifying responsibility for costs and risks.
handlingcostDecimalFalseNoRecords the cost associated with handling the transferred goods, ensuring proper expense tracking.
incotermStringFalseNoSpecifies the international commercial terms (Incoterms) applied to the transfer order, ensuring proper logistics and responsibilities.
isbasecurrencyBooleanFalseNoDetermines whether the transaction is recorded in the base currency of the company. If the value is true, no conversion is required.
lastmodifieddateDatetimeFalseNoIndicates the date and time when the transfer order was last modified, ensuring an audit trail of changes.
linkedtrackingnumbersStringFalseNoStores the tracking numbers associated with shipments linked to the transfer order, ensuring shipment traceability.
locationStringFalseNoIdentifies the location from which the items are being transferred, ensuring proper inventory management.
memoStringFalseNoStores additional notes or comments related to the transfer order, providing extra context for users.
nexusStringFalseNoDefines the tax jurisdiction associated with the transfer order, ensuring compliance with regional tax regulations.
orderstatusStringFalseNoIndicates the current status of the transfer order, such as pending approval or shipped, ensuring clear process tracking.
ordertypeStringFalseNoSpecifies the type of order, distinguishing between different kinds of transfer orders for operational clarity.
returntrackingnumbersStringFalseNoRecords the tracking numbers for returned items related to this transfer order, ensuring efficient return handling.
shipaddressStringFalseNoStores the shipping address to which the transferred items are being sent, ensuring accurate logistics planning.
shipaddresslistStringFalseNoContains a predefined list of shipping addresses that can be selected for the transfer order, facilitating standardized address selection.
shipcompleteBooleanFalseNoIndicates whether the transfer order must be shipped in full. If the value is true, partial shipments are not allowed.
shipdateDateFalseNoRecords the date when the transfer order is scheduled for shipment, ensuring proper logistics planning.
shipisresidentialStringFalseNoIndicates whether the shipping address is a residential location, affecting shipping rates and delivery policies.
shipmethodStringFalseNoSpecifies the shipping method chosen for the transfer order, ensuring proper selection of carriers and transit times.
shipoverrideStringFalseNoDetermines if the shipping method or details can be manually overridden. If the value is true, modifications are permitted.
shippingaddressStringFalseNoStores the full shipping address for the transfer order, ensuring accurate delivery of transferred goods.
shippingcostDecimalFalseNoRecords the total cost of shipping associated with the transfer order, ensuring accurate financial tracking.
shippingcostoverriddenStringFalseNoIndicates whether the default shipping cost has been manually overridden, allowing for cost adjustments.
sourceStringFalseNoIdentifies the origin or source of the transfer order, ensuring clear traceability of the order’s creation.
statusStringFalseNoDisplays the current status of the transfer order, such as pending, shipped, or received, ensuring visibility in the fulfillment process.
statusRefStringFalseNoStores an internal reference to the status of the transfer order, used for system-based tracking.
subsidiaryStringFalseNoLinks the transfer order to a specific subsidiary, ensuring proper financial and operational tracking across business entities.
subtotalDecimalFalseNoRepresents the total amount of the transfer order before shipping, handling, and taxes, ensuring financial clarity.
totalDecimalFalseNoRecords the total cost of the transfer order, including all applicable charges, ensuring accurate accounting.
trackingnumbersStringFalseNoStores the tracking numbers associated with shipments related to the transfer order, ensuring shipment traceability.
trandateDateFalseNoIndicates the official date of the transfer order transaction, ensuring chronological accuracy in records.
tranidStringFalseNoStores the unique identifier assigned to the transfer order, ensuring proper referencing in records and reports.
transferlocationStringFalseNoSpecifies the destination location where the transferred items will be received, ensuring inventory accuracy.
useitemcostastransfercostBooleanFalseNoDetermines whether the cost of transferred items is used as the transfer cost. If the value is true, item cost is applied.

Return to Top

transferOrderLinkedTrackingNumberMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
trackingnumberStringFalseNoStores the tracking number linked to the transfer order, ensuring proper shipment tracking and delivery confirmation.

Return to Top

transferOrderShippingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoRepresents a unique key associated with the shipping address entry, ensuring proper linkage within transfer orders.
addr1StringFalseNoStores the primary street address for the shipping destination, ensuring accurate logistics and fulfillment.
addr2StringFalseNoContains additional address details such as apartment number, suite, or floor, ensuring precise delivery location identification.
addr3StringFalseNoStores further address information when additional details are needed for complex shipping addresses.
addresseeStringFalseNoSpecifies the name of the recipient or business receiving the transferred items, ensuring correct and efficient delivery.
attentionStringFalseNoIncludes the name of a specific person or department that should receive the shipment, helping with delivery accuracy.
cityStringFalseNoRecords the city associated with the shipping address, ensuring accurate geographical identification for logistics and taxation.
countryStringFalseNoIndicates the country of the shipping address, ensuring compliance with international shipping and tax regulations.
dropdownstateStringFalseNoRepresents the state selection from a dropdown field, ensuring standardized regional categorization.
overrideBooleanFalseNoIndicates whether the system allows overriding standard shipping address validation rules. If the value is true, users can manually modify the address.
stateStringFalseNoStores the state or province associated with the shipping address, ensuring accurate tax calculations and regulatory compliance.

Return to Top

transferOrderTrackingNumberMap 

NameTypeReadOnlyReferencesFilterOnlyDescription
trackingnumberStringFalseNoStores the tracking number associated with the transfer order, ensuring accurate shipment tracking and delivery confirmation.

Return to Top

UnbilledReceivableGrouping 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoRepresents a unique key used for grouping unbilled receivables, ensuring proper financial categorization and tracking.

Return to Top

undeliveredEmail 

NameTypeReadOnlyReferencesFilterOnlyDescription
complianceverifiedBooleanFalseNoIndicates whether the undelivered email was checked for compliance with email sending policies. If the value is true, verification was completed.
keyIntegerFalseNoRepresents the unique internal identifier for the undelivered email record, ensuring traceability within the system.
logdateDateFalseNoRecords the date when the undelivered email entry was logged, providing a timeline of failed email attempts.
messageidStringFalseNoStores the unique identifier of the email message, ensuring accurate tracking and debugging of undelivered emails.
reasonStringFalseNoContains the reason why the email was undelivered, such as invalid recipient address, spam filtering, or server rejection.
sentdateDateFalseNoRecords the original date when the email was sent, helping determine the delay between sending and failure notification.

Return to Top

unitstype 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoRepresents the unique internal identifier for the unit type, ensuring proper reference and classification within the system.
externalidStringFalseNoStores an external identifier for the unit type, used for integrations with external systems or custom references.
isinactiveBooleanFalseNoIndicates whether the unit type is inactive. If the value is true, the unit type is not available for transactions.

Return to Top

unitsTypeUom 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoRepresents the unique internal identifier for the UOM, ensuring proper reference within the system.
abbreviationStringFalseNoStores the abbreviated form of the UOM, used for quick identification in reports and transactions.
baseunitBooleanFalseNoIndicates whether this UOM is the base unit in the unit type. If the value is 'true', it is the primary unit.
conversionrateDoubleFalseNoRepresents the conversion rate of this unit relative to the base unit, ensuring accurate unit calculations in transactions.
pluralabbreviationStringFalseNoStores the pluralized version of the unit abbreviation, ensuring proper display in quantity-based reports and UI elements.
unitnameStringFalseNoContains the full name of the UOM, ensuring clarity in usage across records and reports.
unitstypeStringFalseNoLinks the UOM to a specific unit type, ensuring structured classification of measurement units.

Return to Top

unlockedtimeperiod 

NameTypeReadOnlyReferencesFilterOnlyDescription
enddateDateFalseNoIndicates the final date of the unlocked time period, ensuring proper tracking of open financial periods.
entityStringFalseNoSpecifies the entity associated with the unlocked time period, ensuring accurate record linkage.
externalidStringFalseNoStores an external identifier for the unlocked time period, used for integration with external systems.
idIntegerFalseNoRepresents a unique identifier for the unlocked time period, ensuring proper categorization in financial records.
internalidIntegerFalseNoStores the internal identifier for the unlocked time period, ensuring unique reference within the system.
isinactiveBooleanFalseNoIndicates whether the unlocked time period is inactive. If the value is true, the time period is not available for transactions.
startdateDateFalseNoRecords the beginning date of the unlocked time period, ensuring accurate tracking of open accounting periods.
validuntilDateFalseNoDefines the date until which the unlocked time period remains valid, ensuring proper financial control and compliance.

Return to Top

upsellItem 

NameTypeReadOnlyReferencesFilterOnlyDescription
corrrelationfldDoubleFalseNoStores the correlation factor indicating how strongly the upsell item is related or recommended based on purchase patterns.
countfldIntegerFalseNoRecords the number of times this item has been associated or suggested as an upsell, providing data for sales analysis.
customerStringFalseNoIdentifies the customer associated with the upsell recommendation, enabling targeted sales efforts.
itemStringFalseNoSpecifies the item recommended as an upsell to customers, supporting effective product cross-selling and upselling strategies.

Return to Top

usage 

NameTypeReadOnlyReferencesFilterOnlyDescription
customerStringFalseNoIdentifies the customer associated with the usage record, ensuring proper tracking of usage-based transactions.
customformStringFalseNoSpecifies the custom form used for recording the usage entry, allowing businesses to apply customized formats.
itemStringFalseNoRepresents the item being tracked for usage, ensuring proper accounting of consumed goods or services.
memoStringFalseNoStores additional notes or comments related to the usage entry, providing extra context for users.
statusStringFalseNoIndicates the current status of the usage record, such as pending, approved, or processed, ensuring visibility in usage tracking.
subscriptionplanStringFalseNoLinks the usage record to a specific subscription plan, ensuring accurate billing and tracking of subscription-based services.
usagedateDateFalseNoRecords the date when the usage occurred, ensuring accurate chronological tracking for billing and reporting.
usagequantityStringFalseNoStores the quantity of the item or service consumed, ensuring proper billing calculations for usage-based services.
usagesubscriptionStringFalseNoAssociates the usage record with a specific subscription, ensuring accurate allocation of consumed resources.
usagesubscriptionlineStringFalseNoLinks the usage record to a specific line item in the subscription, ensuring detailed tracking of consumed services.

Return to Top

UserAuthorizationConsent 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoRepresents the unique internal identifier for the user authorization consent entry, ensuring proper reference and tracking.
appStringFalseNoStores the name of the application for which the user granted authorization, ensuring clarity in access permissions.
given_atDateFalseNoRecords the date when the user granted authorization consent, ensuring accurate tracking of access permissions.
revoked_atDateFalseNoIndicates the date when the user authorization consent was revoked, ensuring historical tracking of access changes.
revoked_byStringFalseNoStores the identifier of the user or system that revoked the authorization, ensuring accountability and security.
role_nameStringFalseNoDefines the role associated with the authorization consent, determining the level of access granted to the user.

Return to Top

usereventscript 

NameTypeReadOnlyReferencesFilterOnlyDescription
aftersubmitfunctionStringFalseNoDefines the function executed after the user submits a record, allowing for post-processing tasks.
beforeloadfunctionStringFalseNoSpecifies the function that runs before the record is loaded, enabling customization of record behavior and UI.
beforesubmitfunctionStringFalseNoDetermines the function executed before submitting a record, ensuring validation and data transformation before processing.
descriptionStringFalseNoStores a brief description of the user event script, providing context about its functionality and purpose.
externalidStringFalseNoContains an external identifier for the script, allowing for integration with external systems or references.
isinactiveBooleanFalseNoIndicates whether the script is inactive. If the value is true, the script is not executed.
nameStringFalseNoStores the name of the user event script, ensuring easy identification and management within the system.
notifyadminsBooleanFalseNoIndicates whether administrators should receive notifications related to this script. If the value is true, notifications are sent.
notifyemailsStringFalseNoLists the email addresses that receive notifications triggered by the script, ensuring proper communication of script events.
notifygroupStringFalseNoSpecifies the user group that receives notifications related to the script execution, enabling controlled alert distribution.
notifyownerBooleanFalseNoDetermines whether the script owner should receive notifications about script execution. If the value is true, notifications are sent.
notifyuserBooleanFalseNoIndicates whether the user who triggered the event should be notified about script execution. If the value is true, notifications are sent.
ownerStringFalseNoStores the owner of the script, ensuring proper accountability and management of script changes.
scriptfileStringFalseNoIdentifies the script file associated with this user event script, enabling traceability of the source code.
scriptidStringFalseNoRepresents the unique identifier assigned to the script, ensuring proper referencing in system configurations.
scripttypeStringFalseNoDefines the type of script, categorizing it for execution and system compatibility.

Return to Top

UserOAuthToken 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoRepresents the unique internal identifier for the OAuth token entry, ensuring proper reference and tracking.
binactiveBooleanFalseNoIndicates whether the OAuth token is inactive. If the value is true, the token is no longer valid for authentication.
role_nameStringFalseNoDefines the role associated with the OAuth token, determining the level of access granted through authentication.
tba_app_nameStringFalseNoStores the name of the application that requested the OAuth token, ensuring clear identification of token usage.
tba_token_nameStringFalseNoSpecifies the name of the OAuth token, allowing for easy management and identification of authentication credentials.

Return to Top

usrsavedsearch 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoRepresents the unique internal identifier for the saved search, ensuring accurate tracking within the system.
datecreatedDateFalseNoRecords the date when the saved search was created, ensuring chronological tracking of search definitions.
dateexecutedDateFalseNoStores the last execution date of the saved search, providing insights into search activity and usage.
datemodifiedDateFalseNoIndicates the last date the saved search was modified, ensuring visibility into search version updates.
definitionentityStringFalseNoContains the definition or structure of the saved search, specifying criteria, filters, and result columns.
descriptionStringFalseNoStores a brief description of the saved search, helping users understand its purpose and function.
issharedBooleanFalseNoIndicates whether the saved search is shared with other users. If the value is true, it is accessible to others.
nameStringFalseNoStores the name of the saved search, ensuring easy identification and reference within the system.
ownerStringFalseNoIdentifies the user who created or owns the saved search, ensuring accountability and management of saved searches.
roleStringFalseNoSpecifies the role associated with the saved search, determining access permissions and visibility.
scriptidStringFalseNoStores the unique script identifier associated with the saved search, allowing for automation and system integration.

Return to Top

usrsavedsearchexec 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]StringFalseNoRepresents the unique internal identifier for the saved search execution, ensuring accurate logging within the system.
dateexecutedDateFalseNoRecords the date when the saved search was executed, providing insights into search activity and usage history.
executedentityidIntegerFalseNoIdentifies the user or entity that executed the saved search, ensuring accountability and tracking of search usage.

Return to Top

validatePostbackStatus 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier used to validate the postback status request.

Return to Top

vendor 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for the vendor record.
accountnumberStringFalseNoVendor's assigned account number for tracking and reference.
altemailStringFalseNoAlternative email address for vendor correspondence.
altnameStringFalseNoDisplay name of the vendor, commonly used in reports and searches.
balanceDecimalFalseNoTotal outstanding balance owed to the vendor in the base currency.
balanceprimaryDecimalFalseNoTotal outstanding balance owed to the vendor in the vendor's currency.
billpayBooleanFalseNoIndicates whether online bill payments are enabled for the vendor.
categoryStringFalseNoClassification or grouping assigned to the vendor, such as supplier type.
commentsStringFalseNoAdditional notes or remarks related to the vendor.
companynameStringFalseNoRegistered name of the vendor's business or organization.
contactStringFalseNoPrimary contact person associated with the vendor.
contactlistStringFalseNoList of all contacts linked to the vendor.
creditlimitDecimalFalseNoMaximum allowable credit amount assigned to the vendor.
currencyStringFalseNoDefault currency used for transactions with the vendor.
datecreatedDateFalseNoDate when the vendor record was created.
defaultbankaccountStringFalseNoPrimary bank account associated with the vendor for payments.
defaultbillingaddressStringFalseNoPredefined billing address for vendor transactions.
defaultshippingaddressStringFalseNoPredefined shipping address for vendor-related shipments.
duplicateBooleanFalseNoFlag indicating if this vendor record is marked as a duplicate.
emailStringFalseNoPrimary email address used for vendor communications.
emailpreferenceStringFalseNoVendor's preferred method for receiving email communications.
emailtransactionsBooleanFalseNoIndicates whether transaction-related emails should be sent to the vendor.
entityidStringFalseNoUnique identifier or reference number assigned to the vendor.
entitynumberIntegerFalseNoSystem-generated number representing the vendor entity.
entitytitleStringFalseNoUnique vendor identification used internally.
expenseaccountStringFalseNoDefault expense account assigned for transactions with this vendor.
externalidStringFalseNoCustom external identifier assigned to the vendor for integrations.
faxtransactionsBooleanFalseNoIndicates whether transaction-related faxes should be sent to the vendor.
firstnameStringFalseNoFirst name of the vendor's primary contact for individual vendors.
giveaccessBooleanFalseNoSpecifies whether the vendor has login access to a portal or system.
globalsubscriptionstatusStringFalseNoStatus of the vendor's global subscription for email marketing.
incotermStringFalseNoInternational Commercial Terms (Incoterms) applicable to the vendor.
isinactiveBooleanFalseNoIndicates whether the vendor record is inactive.
isjobresourcevendBooleanFalseNoSpecifies whether the vendor is a job resource for project-based work.
ispersonBooleanFalseNoIndicates whether the vendor is an individual rather than a business entity.
laborcostDecimalFalseNoTotal labor cost associated with the vendor.
lastmodifieddateDateFalseNoDate when the vendor record was last updated.
lastnameStringFalseNoLast name of the vendor's primary contact for individual vendors.
legalnameStringFalseNoVendor's registered legal name as per official records.
middlenameStringFalseNoMiddle name of the vendor's primary contact.
payablesaccountStringFalseNoDefault accounts payable account linked to the vendor.
phoneticnameStringFalseNoPhonetic representation of the vendor's name used for localization.
predconfidenceDoubleFalseNoConfidence level of the predicted risk assessment for the vendor.
predicteddaysIntegerFalseNoEstimated number of days the vendor is likely to pay early or late.
printoncheckasStringFalseNoVendor name format for printing on checks.
printtransactionsBooleanFalseNoIndicates whether transaction details should be printed for the vendor.
purchaseorderamountDoubleFalseNoTolerance percentage for differences in purchase order amounts on vendor bills.
purchaseorderquantityDoubleFalseNoTolerance percentage for discrepancies in purchase order quantities on vendor bills.
purchaseorderquantitydiffDoubleFalseNoAllowed difference in purchase order quantity before triggering alerts.
receiptamountDoubleFalseNoTolerance percentage for discrepancies in item receipt amounts on vendor bills.
receiptquantityDoubleFalseNoTolerance percentage for discrepancies in item receipt quantities on vendor bills.
receiptquantitydiffDoubleFalseNoAllowed difference in item receipt quantity before triggering alerts.
rolesforsearchStringFalseNoUser roles that can access or search for this vendor.
salutationStringFalseNoVendor's formal salutation, such as Mr., Ms., Dr., etc.
subsidiaryeditionStringFalseNoEdition of the NetSuite subsidiary the vendor is associated with.
termsStringFalseNoDefault payment terms agreed upon with the vendor.
timeapproverStringFalseNoPerson responsible for approving time-related transactions for this vendor.
titleStringFalseNoJob title of the vendor's primary contact.
unbilledordersDecimalFalseNoTotal value of purchase orders not yet billed by the vendor in the base currency.
unbilledordersprimaryDecimalFalseNoTotal value of purchase orders not yet billed by the vendor in the vendor's currency.

Return to Top

vendorAchAcct 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique identifier for the vendor's Automated Clearing House (ACH) account, serving as a primary key for tracking specific account details.
accountnumberStringFalseNoRepresents the bank account number linked to a vendor's ACH payment information, essential for accurate electronic fund transfers and ensuring correct payment deposits.
addendaStringFalseNoInformation on payments related to ACH transactions, useful for transmitting structured or unstructured remittance details or notes included with the payment.
banknameStringFalseNoSpecifies the name of the financial institution linked to a vendor's ACH account, which is crucial for processing electronic payments to vendors.
banknumberStringFalseNoThe bank's transit number identifies the institution, essential for processing electronic payments and routing transactions correctly.
idnumberStringFalseNoThe vendor's identification number assigned by the bank, which is used for electronic payments and direct deposits.
includetransactionBooleanFalseNoIndicates whether transactions related to a specific vendor ACH account should be included in payment processing and reporting workflow.
isinactiveBooleanFalseNoIndicates whether this vendor ACH account is active or inactive, typically used for account management.
issavingsBooleanFalseNoSpecifies whether the account is a savings account 'true' or a checking account 'false', distinguishing between different types of vendor bank accounts used for ACH transactions.
limitDecimalFalseNoThe maximum allowable amount that can be processed for a single ACH transaction or over a specified period, such as daily, weekly, or monthly limits for a given vendor.
routingnumberStringFalseNoThe routing number associated with the vendor's bank account, ensuring payments are sent to the correct financial institution.
sendaddendaBooleanFalseNoSpecifies whether addenda records should be included when processing ACH payments for a vendor's bank account.

Return to Top

vendorAddressbook 

NameTypeReadOnlyReferencesFilterOnlyDescription
internalid [KEY]IntegerFalseNoServes as a unique identifier assigned to each address book entry associated with a vendor record, which is automatically generated by NetSuite when a new address book entry is created.
addressbookaddressStringFalseNoThe full address details associated with the vendor, including street, city, state, and ZIP Code.
defaultbillingBooleanFalseNoIndicates whether this address is the primary billing address for the vendor. A value of 'true' means it is the default billing address.
defaultshippingBooleanFalseNoIndicates whether this address is the primary shipping address for the vendor. A value of 'true' means it is the default shipping address.
entityStringFalseNoTypically refers to the vendor or entity associated with the address book entry, which plays a crucial role in linking the address book record to a specific vendor.

Return to Top

vendorAddressbookEntityAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique identifier for the vendor's address entry, used to link address records to the appropriate vendor in the system.
addr1StringFalseNoThe primary street address for the vendor, typically including the house number and street name.
addr2StringFalseNoAn additional address line for extra location details, such as suite number, building name, or apartment number.
addr3StringFalseNoA third address line for extended location details, often used for international addresses or specific delivery instructions.
addresseeStringFalseNoThe name of the recipient or entity associated with this address entry, which can be a company, department, or individual.
attentionStringFalseNoA specific person or department that should receive correspondence or deliveries at this address.
cityStringFalseNoThe city or municipality where the vendor is located, used for mailing and geographical identification.
countryStringFalseNoThe country where the vendor's address is registered, necessary for international transactions and compliance.
dropdownstateStringFalseNoA state or region selection value derived from a predefined list, ensuring consistency in state/province names.
overrideBooleanFalseNoA flag indicating whether the standard address validation should be bypassed, allowing manual entry when necessary.
stateStringFalseNoThe state, province, or regional subdivision where the vendor is located, used for address validation and geographical categorization.

Return to Top

vendorbill 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account associated with this vendor bill, used for expense tracking and financial reporting.
approvalstatusStringFalseNoThe current approval status of the vendor bill, indicating whether it is pending, approved, or rejected.
availablevendorcreditDecimalFalseNoThe remaining vendor credit available for application to this bill, reducing the outstanding amount due.
balanceStringFalseNoThe outstanding balance on this vendor bill, reflecting the amount still payable to the vendor.
billaddresslistStringFalseNoA reference to the predefined billing address associated with this transaction, used for record-keeping and correspondence.
billingaddressStringFalseNoThe detailed billing address of the vendor for this bill, used for invoice processing and tax reporting.
classStringFalseNoThe classification category assigned to this vendor bill, typically used for tracking expenses across business segments.
createddateDatetimeFalseNoThe date and time when this vendor bill was initially recorded in the system.
creditlimitDecimalFalseNoThe maximum credit amount allowed for this vendor, helping manage financial exposure.
currencyStringFalseNoThe currency in which the vendor bill is denominated, determining the exchange rate applied.
currencynameStringFalseNoThe full name of the currency associated with this vendor bill, such as 'United States Dollar' or 'Euro.'
currencysymbolStringFalseNoThe symbol of the currency associated with this vendor bill, such as '$' or '€'.
customformStringFalseNoThe specific custom form template used for this vendor bill, allowing for tailored data entry and presentation.
departmentStringFalseNoThe internal department responsible for this vendor bill, used for expense allocation and reporting.
discountamountDecimalFalseNoThe total discount applied to this bill, typically based on early payment terms or vendor agreements.
discountdateDateFalseNoThe deadline for an early payment discount, if applicable, beyond which the full amount is due.
documentstatusStringFalseNoThe overall status of this vendor bill, such as 'Pending Submission,' 'Open,' or 'Paid.'
duedateDateFalseNoThe date by which payment must be made to avoid late fees or penalties.
entityStringFalseNoThe vendor associated with this bill, representing the supplier providing the goods or services.
entitynexusStringFalseNoThe tax jurisdiction applicable to this vendor based on the nexus rules, affecting tax calculations.
entitytaxregnumStringFalseNoThe tax registration number of the vendor, required for compliance and reporting purposes.
exchangerateDecimalFalseNoThe conversion rate applied if the bill is in a different currency than the company’s base currency.
externalidStringFalseNoA unique identifier for this vendor bill assigned by an external system for integration purposes.
isbasecurrencyBooleanFalseNoIndicates whether the currency of this bill matches the company’s base currency.
landedcostperlineBooleanFalseNoSpecifies whether landed costs are allocated on a per-line basis, useful for inventory cost tracking.
lastmodifieddateDatetimeFalseNoThe date and time when this vendor bill was last modified, providing an audit trail of changes.
locationStringFalseNoThe business location associated with this vendor bill, useful for regional financial reporting.
memoStringFalseNoA free-text field for additional notes or details about this vendor bill.
nextapproverStringFalseNoThe designated approver responsible for reviewing and approving this vendor bill.
nexusStringFalseNoThe tax nexus applicable to this bill, affecting how sales and use taxes are calculated.
overrideinstallmentsBooleanFalseNoIndicates whether the installment payment schedule for this bill is manually overridden.
paymentholdBooleanFalseNoA flag indicating whether payment for this vendor bill is currently on hold.
postingperiodStringFalseNoThe accounting period in which this vendor bill is posted, used for financial reporting.
receivedStringFalseNoIndicates whether the goods or services associated with this bill have been received.
statusStringFalseNoThe current lifecycle status of this bill, such as 'Open,' 'Pending Approval,' or 'Paid.'
statusrefStringFalseNoA system reference code indicating the status of this vendor bill.
subsidiaryStringFalseNoThe subsidiary company associated with this bill, used in multi-entity accounting structures.
subsidiarytaxregnumStringFalseNoThe tax registration number of the subsidiary handling this vendor bill, ensuring tax compliance.
taxdetailsoverrideBooleanFalseNoIndicates whether tax details on this bill have been manually overridden.
taxpointdateDateFalseNoThe date used to determine tax liability, typically based on invoice or delivery date.
taxpointdateoverrideBooleanFalseNoSpecifies whether the tax point date has been manually adjusted.
taxregoverrideBooleanFalseNoIndicates whether tax registration details have been manually modified for this bill.
termsStringFalseNoThe payment terms agreed upon with the vendor, such as 'Net 30' or 'Due on Receipt.'
tobeprintedBooleanFalseNoIndicates whether this bill is marked for printing, typically used in scenarios where businesses manage their accounts payable processes.
totalDecimalFalseNoThe total amount due on this vendor bill, including taxes and discounts.
trandateDateFalseNoThe transaction date of this bill, representing when it was recorded in the system.
tranidStringFalseNoA unique system-generated transaction identifier for each vendor bill, enabling effective tracking and management of bills.
transactionnumberStringFalseNoA sequential number assigned to this transaction for tracking and reference.
unbilledordersStringFalseNoRepresents the total amount of outstanding purchase orders that have been received but not yet billed by the vendor.

usertotal,column,The total amount entered by the user | | usertotal | Decimal | False | | No | Usertotal |

Return to Top

vendorBillBillingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoUnique identifier for the billing address entry, used internally by NetSuite.
addr1StringFalseNoPrimary street address line for the vendor's billing location.
addr2StringFalseNoSecondary street address line for additional address details.
addr3StringFalseNoTertiary street address line, used when more address information is required.
addresseeStringFalseNoFull name or entity associated with the billing address, typically the vendor's business name.
attentionStringFalseNoSpecific person or department at the vendor's location to receive correspondence.
cityStringFalseNoCity associated with the vendor's billing address.
countryStringFalseNoCountry associated with the vendor's billing address, typically represented as a country code.
dropdownstateStringFalseNoState or province for the billing address, used for dropdown selection in NetSuite.
overrideBooleanFalseNoIndicates whether the default address should be overridden for this transaction.
stateStringFalseNoState or province associated with the vendor's billing address.

Return to Top

vendorBillExpenseMachine 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account associated with this expense line item.
amortizationenddateDateFalseNoThe date when the amortization schedule for this expense line item ends.
amortizationresidualStringFalseNoThe remaining balance of the expense after amortization has been applied.
amortizationschedStringFalseNoThe predefined amortization schedule that dictates how the expense is allocated over time.
amortizstartdateDateFalseNoThe date when the amortization of this expense line item begins.
categoryStringFalseNoThe expense category assigned to this transaction for reporting and classification.
classStringFalseNoThe classification used for tracking and segmenting financial data within the organization.
customerStringFalseNoThe customer associated with this expense, used for tracking billable transactions.
departmentStringFalseNoThe department responsible for or affected by this expense transaction.
expenseitemIntegerFalseNoThe unique identifier of the expense item being recorded in this entry.
grossamtDecimalFalseNoThe total gross amount of this expense before any deductions or adjustments.
isbillableBooleanFalseNoIndicates whether this expense can be billed to a customer. Possible values are 'true' for yes and 'false' for no.
lineIntegerFalseNoThe line number of this specific expense entry within the transaction.
locationStringFalseNoThe physical or business location associated with this expense transaction.
memoStringFalseNoA free-text field for additional notes or details about this expense transaction.
orderdocStringFalseNoThe internal reference or document number for the related purchase order, if applicable.
orderlineStringFalseNoThe specific line item within the purchase order that corresponds to this expense.
vendorbillStringFalseNoThe vendor bill associated with this expense entry, linking it to the original invoice or billing document.

Return to Top

VendorBillInstallment 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier for each vendor bill installment, used for reference within the system.
amountDecimalFalseNoThe total installment amount that is due for this specific vendor bill.
amountdueDecimalFalseNoThe remaining balance that still needs to be paid for this installment.
duedateDateFalseNoThe scheduled due date by which this vendor bill installment should be paid.
seqnumIntegerFalseNoA sequential number indicating the order of this installment in relation to other installments for the same vendor bill.
nkeyIntegerFalseNoA system-generated key used for internal reference and linking related records.
vendorbillStringFalseNoThe identifier or reference to the associated vendor bill for this installment.
paymentsappliedBooleanFalseNoIndicates whether any payments have been applied to this vendor bill installment. A value of 'true' means payments have been made.
statusStringFalseNoThe current payment status of the installment, such as 'Paid,' 'Unpaid,' or 'Partially Paid.'

Return to Top

vendorBulkMerge 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoUnique identifier for the entity being merged. This typically refers to a vendor or related business entity involved in the bulk merge operation.
mergedateDateFalseNoThe date and time when the bulk merge process was executed. This helps track when the merge operation took place.
mergetypeStringFalseNoIndicates the type of merge being performed, such as a vendor consolidation or data deduplication process.
statusStringFalseNoCurrent status of the bulk merge operation, such as pending, in progress, completed, or failed.
subjectStringFalseNoDescriptive label or title associated with the bulk merge operation, providing context for the type of merge being executed.
templateStringFalseNoReference to the template used for the bulk merge, which can define formatting rules or predefined settings for the operation.
usernameStringFalseNoThe name of the user who initiated the bulk merge operation. This helps track user activity and accountability in the system.

Return to Top

vendorCampaigns 

NameTypeReadOnlyReferencesFilterOnlyDescription
campaignStringFalseNoThe unique identifier or name of the marketing campaign associated with this record. This helps track the effectiveness and reach of different campaigns.
campaigneventStringFalseNoThe specific event or activity within a campaign, such as an email blast, webinar, or promotional offer, that is being tracked.
categoryStringFalseNoThe classification or type of campaign, such as 'Email Marketing,' 'Social Media,' or 'Direct Mail,' used for reporting and segmentation.
contactStringFalseNoThe individual or business entity that received or interacted with the campaign. This can refer to a customer, lead, or prospect.
datesentDateFalseNoThe date when the campaign or campaign event was sent to recipients. This helps in tracking the timeline of engagement.
entityStringFalseNoThe business entity, customer, or prospect associated with this campaign event. This field is useful for mapping campaign interactions to specific accounts.
responseStringFalseNoDetailed information about the recipient's response to the campaign, such as whether they opened an email, clicked a link, or unsubscribed.
responsedateDateFalseNoThe date when the recipient responded to the campaign, allowing for analysis of response timing and engagement patterns.

Return to Top

vendorcategory 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier assigned to each vendor category in NetSuite. This ID is system-generated and cannot be changed.
externalidStringFalseNoAn optional external identifier used to reference the vendor category from an external system. This can be helpful for integrations with third-party applications.
isinactiveBooleanFalseNoIndicates whether the vendor category is currently active in NetSuite. A value of 'true' means the category is inactive and not available for selection.
istaxagencyBooleanFalseNoSpecifies whether the vendor category represents a tax agency. This is important for tax reporting and compliance within NetSuite.

Return to Top

vendorCompanyContact 

NameTypeReadOnlyReferencesFilterOnlyDescription
contactStringFalseNoThe name or identifier of the vendor's primary contact person associated with a vendor company.

Return to Top

vendorcredit 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account associated with this vendor credit, specifying where the transaction is recorded.
appliedDecimalFalseNoThe total amount from this vendor credit that has been applied to outstanding vendor bills.
autoapplyBooleanFalseNoIndicates whether the system automatically applies this vendor credit to open vendor bills.
billaddresslistStringFalseNoA reference to the predefined billing address list associated with this vendor credit.
billingaddressStringFalseNoThe detailed billing address where the vendor credit is associated, typically based on the vendor's record.
classStringFalseNoThe classification assigned to this vendor credit, which can be used for reporting and segmentation.
createddateDatetimeFalseNoThe date and time when this vendor credit was initially created in the system.
createdfromStringFalseNoThe originating transaction, such as a vendor bill from which this vendor credit was generated, if applicable.
currencyStringFalseNoThe currency in which this vendor credit is recorded.
currencynameStringFalseNoThe full name of the currency used in this vendor credit, such as 'US Dollar' or 'Euro'.
currencysymbolStringFalseNoThe currency symbol associated with this vendor credit, which can include symbols like '$' for US dollars or '€' for Euros.
customformStringFalseNoThe custom form template applied to this vendor credit, affecting how it is displayed and processed.
departmentStringFalseNoThe department linked to this vendor credit, used for financial tracking and reporting.
duedateDateFalseNoThe due date for the vendor credit, usually indicating when it should be applied or when related actions need to be taken.
entityStringFalseNoThe vendor associated with this vendor credit, identifying who issued the credit.
entitynexusStringFalseNoThe tax nexus related to the vendor entity, used for tax calculations and compliance.
entitytaxregnumStringFalseNoThe tax registration number of the vendor, which is relevant for tax reporting and compliance.
exchangerateDecimalFalseNoThe exchange rate used to convert the vendor credit amount into the base currency of the company.
externalidStringFalseNoAn optional unique identifier assigned externally for integration or reference purposes.
isbasecurrencyBooleanFalseNoIndicates whether the currency of this vendor credit matches the company's base currency.
lastmodifieddateDatetimeFalseNoThe date and time when this vendor credit was last modified.
locationStringFalseNoThe specific location or subsidiary to which this vendor credit is assigned, used for reporting and accounting.
memoStringFalseNoA free-text field allowing users to enter additional notes or details about this vendor credit.
nexusStringFalseNoThe tax jurisdiction related to this vendor credit, used for tax determination and reporting.
postingperiodStringFalseNoThe accounting period in which this vendor credit is recorded, used for financial reporting and closing purposes.
subsidiaryStringFalseNoThe subsidiary within the organization to which this vendor credit belongs.
subsidiarytaxregnumStringFalseNoThe tax registration number of the subsidiary associated with this vendor credit, relevant for tax compliance.
taxdetailsoverrideBooleanFalseNoIndicates whether tax details on this vendor credit have been manually overridden.
taxpointdateDateFalseNoThe date used to determine tax liability for this vendor credit, often based on when the transaction occurred.
taxpointdateoverrideBooleanFalseNoIndicates whether the tax point date has been manually overridden from its default calculation.
taxregoverrideBooleanFalseNoSpecifies whether the tax registration details have been manually overridden for this vendor credit.
tobeprintedBooleanFalseNoIndicates whether this vendor credit is marked for printing.
totalDecimalFalseNoThe total amount of this vendor credit, reflecting all adjustments and calculations.
trandateDateFalseNoThe transaction date of this vendor credit, representing when it was officially recorded.
tranidStringFalseNoThe system-generated transaction ID for this vendor credit, providing a unique reference for identification.
transactionnumberStringFalseNoA sequential transaction number assigned to this vendor credit for tracking and auditing.
unappliedDecimalFalseNoThe portion of the vendor credit that remains unapplied and is available for future use.
usertotalDecimalFalseNoThe total amount entered by the user before any system-calculated adjustments or conversions.

Return to Top

vendorCreditBillingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique identifier for the billing address record. This key is used internally by NetSuite to reference the address entry.
addr1StringFalseNoThe first line of the billing address, typically containing the street address or PO Box.
addr2StringFalseNoThe second line of the billing address, used for additional location details such as an apartment, suite, or building number.
addr3StringFalseNoThe third line of the billing address, which can contain supplementary address details when required.
addresseeStringFalseNoThe name of the individual or company associated with this billing address, as it should appear on invoices or other documents.
attentionStringFalseNoA specific contact person at the billing address, used when directing correspondence or invoices to a particular individual.
cityStringFalseNoThe city in which the billing address is located. This field is used for mailing and tax calculations.
countryStringFalseNoThe country associated with the billing address. NetSuite stores country values using standard country codes.
dropdownstateStringFalseNoThe state or province of the billing address, selected from a predefined list of regions specific to the designated country.
overrideBooleanFalseNoIndicates whether the default billing address is overridden for this vendor. A value of 'true' means the override is active.
stateStringFalseNoThe full name or abbreviation of the state or province associated with the billing address, used for regulatory and tax purposes.

Return to Top

vendorCreditExpenseMachine 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account associated with this expense. This determines how the expense is categorized in financial reports.
amortizationenddateDateFalseNoThe date when the amortization process for this expense concludes, indicating the final period in which the expense is recognized.
amortizationresidualStringFalseNoThe remaining balance of an amortized expense that has not yet been fully recognized over its scheduled periods.
amortizationschedStringFalseNoThe predefined amortization schedule that dictates how and when this expense is recognized over time.
amortizstartdateDateFalseNoThe date when the amortization process for this expense begins, marking the start of its scheduled recognition.
categoryStringFalseNoThe classification of the expense, used for reporting and tracking purposes in financial management.
classStringFalseNoAn internal tracking category that helps with financial segmentation, reporting, and analysis across different business units or functions.
customerStringFalseNoThe associated customer related to this expense, if applicable. This can be used for tracking billable expenses or project-based costing.
departmentStringFalseNoThe department responsible for this expense, used for cost allocation and financial reporting.
expenseitemIntegerFalseNoThe unique identifier for the expense item, linking it to a specific cost category or item in the system.
grossamtDecimalFalseNoThe total amount of the expense before any discounts, tax adjustments, or deductions are applied.
isbillableBooleanFalseNoIndicates whether this expense is billable to a customer. If true, it can be passed on to the customer for reimbursement.
lineIntegerFalseNoThe line number in the transaction, representing the sequential placement of this expense entry within the vendor credit record.
locationStringFalseNoThe physical or business location where this expense was incurred, used for regional tracking and financial reporting.
memoStringFalseNoA freeform text field allowing additional notes or explanations related to this specific expense entry.
orderdocStringFalseNoThe associated order document reference, if applicable, linking this expense to a purchase order or similar document.
orderlineStringFalseNoThe specific line item within an order document that corresponds to this expense, providing a link between transactions.
vendorcreditStringFalseNoThe reference to the vendor credit transaction that includes this expense, helping track credits issued by suppliers or vendors.

Return to Top

vendorCurrencyBalance 

NameTypeReadOnlyReferencesFilterOnlyDescription
balanceDecimalFalseNoThe total monetary amount available for the vendor in this specific currency, reflecting the sum of all relevant transactions, including payments and credits.
currencyStringFalseNoThe three-letter ISO currency code representing the currency in which the balance is maintained, such as USD for US dollars or EUR for euros.
unbilledordersDecimalFalseNoThe total value of goods or services ordered from the vendor that have not yet been billed, providing insight into pending financial commitments.

Return to Top

vendorpayment 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account from which the vendor payment is made. This typically represents a cash or bank account used for outgoing payments.
apacctStringFalseNoThe accounts payable account associated with the vendor payment. This represents the liability account where payables are recorded.
approvalstatusStringFalseNoThe current approval status of the vendor payment. This indicates whether the payment is pending, approved, or rejected.
availablebalanceDecimalFalseNoThe available balance in the account from which the payment is made. This balance reflects funds that are not committed elsewhere.
balanceDecimalFalseNoThe total outstanding balance for the selected account, including all transactions that affect the balance.
billpayBooleanFalseNoIndicates whether the payment is designated for bill payments. If the value is 'true', the payment is linked to outstanding vendor bills.
classStringFalseNoThe classification associated with the vendor payment, often used for tracking purposes such as department, project, or cost center.
clearedBooleanFalseNoIndicates whether the payment has been cleared from the bank. If the value is 'true', the payment has been successfully processed.
cleareddateDateFalseNoThe date when the payment was marked as cleared. This is typically the date the bank confirms the transaction.
createddateDatetimeFalseNoThe date and time when the vendor payment record was created in the system.
currencyStringFalseNoThe currency in which the vendor payment is made. This ensures correct exchange rate application for foreign transactions.
currencynameStringFalseNoThe full name of the currency used for the payment, such as 'United States Dollar' or 'Euro'.
currencysymbolStringFalseNoThe symbol of the currency used in the payment, such as '$' for USD or '€' for EUR.
customformStringFalseNoThe custom form associated with the vendor payment, allowing customization of payment processing and reporting.
departmentStringFalseNoThe department associated with the payment, used for categorization and financial reporting.
entityStringFalseNoThe vendor receiving the payment. This references the vendor record in the system.
entitynexusStringFalseNoThe tax nexus associated with the vendor, defining the tax jurisdiction applicable to the transaction.
exchangerateDecimalFalseNoThe exchange rate used for converting the transaction amount if the payment is made in a foreign currency.
externalidStringFalseNoAn external identifier used to reference the vendor payment in external systems or integrations.
isbasecurrencyBooleanFalseNoIndicates whether the transaction is in the base currency of the company. If the value is 'true', no currency conversion is needed.
isintransitpaymentBooleanFalseNoIndicates whether the payment is in transit, meaning it has been issued but not yet cleared by the bank.
lastmodifieddateDatetimeFalseNoThe date and time when the vendor payment record was last modified in the system.
locationStringFalseNoThe location associated with the payment, often used for tracking transactions by branch, store, or warehouse.
memoStringFalseNoA note or description included with the payment, typically used for reference or additional details.
nextapproverStringFalseNoThe next approver required in the approval workflow for the payment.
nexusStringFalseNoThe tax jurisdiction associated with the payment, used for regulatory compliance and tax reporting.
payeeaddressStringFalseNoThe mailing address of the payee receiving the payment, typically used for check payments.
payeeaddresslistStringFalseNoA list of addresses associated with the payee, allowing selection of the appropriate payment destination.
postingperiodStringFalseNoThe financial period in which the payment is recorded. This affects financial reporting and period-end reconciliation.
printvoucherBooleanFalseNoIndicates whether a payment voucher should be printed for this transaction.
statusStringFalseNoThe current status of the vendor payment, such as pending, paid, or voided.
statusrefStringFalseNoA reference value indicating the internal status code for the payment status.
subsidiaryStringFalseNoThe subsidiary associated with the payment, relevant for multi-entity financial management.
toachBooleanFalseNoIndicates whether the payment is set up for Automated Clearing House (ACH) processing.
tobeemailedBooleanFalseNoIndicates whether the payment details should be sent via email to the vendor.
tobeprintedBooleanFalseNoIndicates whether a check or other payment document should be printed for this transaction.
totalDecimalFalseNoThe total amount of the vendor payment, including all applied invoices and adjustments.
trandateDateFalseNoThe date of the vendor payment transaction, typically representing the payment issuance date.
tranidStringFalseNoThe unique transaction identifier assigned to the vendor payment. This is used for tracking and reconciliation.
transactionnumberStringFalseNoThe system-generated number assigned to the vendor payment transaction for reference.
unappliedDecimalFalseNoThe portion of the payment amount that has not yet been applied to vendor bills or other charges.

Return to Top

vendorPaymentPayeeAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique identifier for the payee's address record, used for internal reference within NetSuite.
addr1StringFalseNoThe primary street address of the payee. This is typically the building number and street name.
addr2StringFalseNoAdditional address information such as an apartment, suite, or unit number, if applicable.
addr3StringFalseNoA secondary address line for any further details that do not fit in the two previous fields.
addresseeStringFalseNoThe name of the recipient associated with the payment address, typically the vendor or business entity name.
attentionStringFalseNoA specific contact person or department within the recipient's organization for payment-related correspondence.
cityStringFalseNoThe city where the payee is located, used for mailing and payment processing.
countryStringFalseNoThe country of the payee's address, formatted according to NetSuite's country codes.
dropdownstateStringFalseNoA selectable state or province field, often used in UI dropdowns for standardized state selection.
overrideBooleanFalseNoIndicates whether the default address is manually overridden with a custom entry.
stateStringFalseNoThe state or province of the payee’s address, which can be required for tax and regulatory compliance.

Return to Top

vendorprepayment 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account associated with the vendor prepayment transaction.
balanceDecimalFalseNoThe remaining balance of the vendor prepayment, reflecting any applied amounts.
classStringFalseNoThe classification associated with the vendor prepayment, used for categorization and reporting.
clearedBooleanFalseNoIndicates whether the vendor prepayment transaction has been cleared in the bank reconciliation process.
cleareddateDateFalseNoThe date on which the vendor prepayment transaction was cleared in the reconciliation process.
createddateDatetimeFalseNoThe date and time when the vendor prepayment transaction record was created in NetSuite.
currencyStringFalseNoThe currency in which the vendor prepayment transaction was made, essential for financial processing.
currencynameStringFalseNoThe full name of the currency used in the vendor prepayment transaction.
currencysymbolStringFalseNoThe symbol representing the currency used in the vendor prepayment transaction, such as '$' for U.S. dollars or '€' for Euros.

customform,column,The custom form used for recording this vendor prepayment | | customform | String | False | | No | Customform | | department | String | False | | No | The department associated with the vendor prepayment, used for organizational reporting and expense tracking. | | entity | String | False | | No | The vendor or payee associated with the prepayment transaction, which typically stores the unique identifier or name of the vendor to whom the prepayment is being made. | | exchangerate | Decimal | False | | No | The exchange rate applied to convert the vendor prepayment amount into the base currency of the company. | | externalid | String | False | | No | A unique identifier for the vendor prepayment transaction that can be used for external integrations or imports. | | isbasecurrency | Boolean | False | | No | Indicates whether the vendor prepayment transaction was recorded in the company's base currency. | | lastmodifieddate | Datetime | False | | No | The date and time when the vendor prepayment transaction record was last modified. | | location | String | False | | No | The physical location or business unit associated with the vendor prepayment transaction. | | memo | String | False | | No | A note or description entered by the user to provide additional details about the vendor prepayment. | | payment | String | False | | No | The payment method or reference associated with the vendor prepayment, such as check or bank transfer. | | postingperiod | String | False | | No | The accounting period in which the vendor prepayment transaction was posted. | | prepaymentaccount | String | False | | No | The designated general ledger account used to record the vendor prepayment. | | printvoucher | Boolean | False | | No | Indicates whether a voucher for this vendor prepayment transaction is marked for printing. | | purchaseorder | String | False | | No | The purchase order related to the vendor prepayment, if applicable. | | status | String | False | | No | The current status of the vendor prepayment transaction, such as Pending, Approved, or Applied. | | subsidiary | String | False | | No | The subsidiary entity under which the vendor prepayment transaction was recorded. | | tobeprinted | Boolean | False | | No | Indicates whether the vendor prepayment transaction is marked to be printed. | | trandate | Date | False | | No | The transaction date of the vendor prepayment, representing when it was recorded. | | tranid | String | False | | No | A system-generated transaction ID for the vendor prepayment, used for tracking and reference. | | transactionnumber | String | False | | No | The unique transaction number assigned to the vendor prepayment, used for auditing and reporting. |

Return to Top

vendorprepaymentapplication 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account associated with this vendor prepayment application. This account determines where the prepayment amount is recorded.
classStringFalseNoThe classification category assigned to this vendor prepayment application, often used for tracking and reporting purposes.
createddateDatetimeFalseNoThe date and time when this vendor prepayment application record was initially created in the system.
currencyStringFalseNoThe currency in which the vendor prepayment application is recorded. This determines the monetary unit for the transaction.
customformStringFalseNoThe specific custom form used for this vendor prepayment application, if any, to accommodate company-specific fields and layouts.
departmentStringFalseNoThe department associated with this vendor prepayment application, typically used for financial tracking and internal reporting.
entityStringFalseNoThe vendor to whom the prepayment is applied. This represents the business entity receiving the funds.
exchangerateDecimalFalseNoThe exchange rate applied at the time of the transaction, determining the conversion between the base currency and the transaction currency.
externalidStringFalseNoAn optional unique identifier for this vendor prepayment application, typically used for data integration with external systems.
isbasecurrencyBooleanFalseNoIndicates whether the currency used in this transaction is the base currency of the company. A value of true means it is the base currency.
lastmodifieddateDatetimeFalseNoThe most recent date and time when this vendor prepayment application record was updated in the system.
locationStringFalseNoThe physical or operational location associated with this vendor prepayment application, used for tracking and reporting purposes.
memoStringFalseNoA free-text field for adding additional notes or comments related to this vendor prepayment application.
postingperiodStringFalseNoThe accounting period in which this vendor prepayment application is posted. This determines when the transaction affects financial reports.
prepaymentaccountStringFalseNoThe designated general ledger account used to track prepayments made to vendors before goods or services are received.
prepaymentdateDateFalseNoThe date when the vendor prepayment was made, indicating when funds were issued to the vendor.
subsidiaryStringFalseNoThe subsidiary company associated with this vendor prepayment application, relevant in multi-subsidiary NetSuite accounts.
trandateDateFalseNoThe transaction date of the vendor prepayment application, indicating when it was recorded in the system.
tranidStringFalseNoA unique identifier assigned to this vendor prepayment application by NetSuite, often used for referencing the transaction.
transactionnumberStringFalseNoThe system-generated transaction number assigned to this vendor prepayment application, ensuring uniqueness within NetSuite.
vendorprepaymentStringFalseNoThe vendor prepayment record to which this application is linked, specifying the original prepayment transaction being applied.

Return to Top

vendorRate 

NameTypeReadOnlyReferencesFilterOnlyDescription
entitycurrencyStringFalseNoThe currency associated with the vendor entity. This value determines the monetary denomination used in transactions and rate calculations.
rateDecimalFalseNoThe hourly rate charged by the vendor for services rendered. This value is expressed in the currency specified by the 'entitycurrency' field.

Return to Top

vendorRequestForQuoteItemItemPricing 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]StringFalseNoThe unique internal identifier assigned to the vendor request for quote item pricing record.
calculatequantitydiscountsStringFalseNoIndicates whether quantity-based discounts should be applied to this vendor request for quote item pricing entry.
externalidStringFalseNoA user-defined identifier that can be used to reference this record externally, such as in integrations with other systems.
inputusingStringFalseNoSpecifies the method or source used to input data for this vendor request for quote item pricing record.
lineidIntegerFalseNoA system-generated identifier representing a specific line item within the vendor request for quote item pricing record.
transactionidIntegerFalseNoThe internal identifier of the related transaction associated with this vendor request for quote item pricing entry.
vendorIntegerFalseNoThe internal identifier of the vendor associated with this specific request for quote item pricing record.

Return to Top

vendorRequestForQuoteItemItemPricingDiscount 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique identifier for the pricing discount entry within the request for quote process. This ID is system-generated and used for internal reference.
fromquantityDoubleFalseNoThe minimum quantity required for the discount to be applicable. This defines the threshold at which the discount begins to apply.
itempricingIntegerFalseNoReference to the specific item pricing structure associated with this request for quote. Links to predefined pricing rules.
itempricingrecordStringFalseNoA unique identifier or record reference for the pricing configuration used in the request for quote process.
memoStringFalseNoAdditional notes or details about the discount or pricing adjustment applied to the request for quote. Used for internal tracking or communication.
percentDoubleFalseNoThe percentage discount applied when the specified quantity threshold is met. This defines the discount rate associated with bulk purchasing.
quantityorderedDoubleFalseNoThe total quantity of the item requested in the quote. This value helps determine pricing tiers and applicable discounts.

Return to Top

vendorreturnauthorization 

NameTypeReadOnlyReferencesFilterOnlyDescription
billaddresslistStringFalseNoA reference to the list of billing addresses associated with the vendor return authorization. This helps determine the correct billing address for the transaction.
billingaddressStringFalseNoThe full billing address associated with the vendor return authorization, including street, city, state, postal code, and country.
classStringFalseNoThe classification associated with the return authorization, which can be used for reporting and segmentation purposes.
createddateDatetimeFalseNoThe date and time when the vendor return authorization record was created in the system.
createdfromStringFalseNoThe source transaction from which this vendor return authorization was created, such as a purchase order or another return authorization.
currencyStringFalseNoThe currency used for this vendor return authorization, represented by its internal NetSuite ID.
currencynameStringFalseNoThe name of the currency used in the transaction, such as 'US Dollar' or 'Euro'.
currencysymbolStringFalseNoThe symbol representing the currency used in the transaction, such as '$' or '€'.
customformStringFalseNoThe custom form template used for this vendor return authorization, allowing for customized layouts and fields.
departmentStringFalseNoThe department associated with the vendor return authorization, often used for internal accounting and reporting.
entityStringFalseNoThe vendor associated with this return authorization, typically identified by their internal NetSuite ID.
entitynexusStringFalseNoThe tax nexus applicable to the vendor, determining which tax rules and rates apply to this transaction.
entitytaxregnumStringFalseNoThe tax registration number associated with the vendor, used for tax compliance and reporting.
exchangerateDecimalFalseNoThe exchange rate applied to convert amounts from the vendor's currency to the base currency of the company.
externalidStringFalseNoAn identifier for this record that originates from an external system, useful for integrations and data synchronization.
intercostatusStringFalseNoIndicates the intercompany status of this transaction, specifying whether it is pending, completed, or another status.
intercotransactionStringFalseNoA reference to the related intercompany transaction, if this return authorization involves multiple subsidiaries.
isbasecurrencyBooleanFalseNoIndicates whether the currency used in this transaction is the company's base currency 'true' or a foreign currency 'false'.
lastmodifieddateDatetimeFalseNoThe date and time when this vendor return authorization record was last modified.
locationStringFalseNoThe physical or operational location associated with this transaction, used for inventory and financial tracking.
memoStringFalseNoA free-text field that allows users to enter notes or additional details about this vendor return authorization.
nexusStringFalseNoThe tax jurisdiction associated with this transaction, which affects tax calculations and reporting.
orderstatusStringFalseNoThe current status of the vendor return authorization, such as 'Pending Approval', 'Approved', or 'Rejected'.
statusStringFalseNoThe overall status of the return authorization, reflecting its progress within the approval and processing workflow.
statusrefStringFalseNoAn internal reference code representing the status of this transaction, used for system-level identification.
subsidiaryStringFalseNoThe subsidiary associated with this vendor return authorization, indicating which entity within the company structure is responsible for the transaction.
subsidiarytaxregnumStringFalseNoThe tax registration number of the subsidiary involved in this return authorization, used for tax reporting and compliance.
taxdetailsoverrideBooleanFalseNoIndicates whether tax details have been manually overridden for this transaction.
taxpointdateDateFalseNoThe date on which the tax liability for this transaction is recognized, typically based on tax rules and invoice dates.
taxpointdateoverrideBooleanFalseNoIndicates whether the tax point date has been manually overridden from its default value.
taxregoverrideBooleanFalseNoIndicates whether the tax registration number has been manually overridden for this transaction.
totalDecimalFalseNoThe total monetary amount of this vendor return authorization, including all line items, taxes, and adjustments.
trandateDateFalseNoThe transaction date of this vendor return authorization, typically reflecting when the return was initiated.
tranidStringFalseNoThe unique transaction ID assigned to this vendor return authorization by NetSuite.
usertotalDecimalFalseNoThe total amount entered by the user for this transaction before any system-calculated adjustments.

Return to Top

vendorReturnAuthorizationBillingAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoA unique identifier for the billing address record, used internally by NetSuite.
addr1StringFalseNoThe first line of the billing address, typically containing the street address or P.O. Box.
addr2StringFalseNoThe second line of the billing address, often used for apartment numbers, suite numbers, or additional location details.
addr3StringFalseNoThe third line of the billing address, used for extended address information if necessary.
addresseeStringFalseNoThe name of the person or entity associated with the billing address, such as a company or individual.
attentionStringFalseNoThe specific person or department within the company to whom invoices or communications should be directed.
cityStringFalseNoThe name of the city in which the billing address is located.
countryStringFalseNoThe country corresponding to the billing address, typically represented by a standardized country name or code.
dropdownstateStringFalseNoA state or province selection value that corresponds to the billing address, often used for dropdown menus in the UI.
overrideBooleanFalseNoIndicates whether the billing address is manually overridden in NetSuite, allowing for customization beyond default values.
stateStringFalseNoThe state or province of the billing address, used for taxation and regional processing.

Return to Top

vendorReturnAuthorizationExpenseMachine 

NameTypeReadOnlyReferencesFilterOnlyDescription
accountStringFalseNoThe general ledger account associated with this expense entry, used for financial reporting and classification.
amortizationenddateDateFalseNoThe date on which the amortization schedule for this expense concludes, marking the final expense allocation.
amortizationresidualStringFalseNoThe remaining unamortized balance after scheduled amortization expenses have been recorded.
amortizationschedStringFalseNoThe designated amortization schedule applied to this expense, determining how costs are expensed over time.
amortizstartdateDateFalseNoThe date on which the amortization schedule for this expense begins, indicating when expense recognition starts.
categoryStringFalseNoThe category or type of expense, used for tracking and financial reporting purposes.
classStringFalseNoThe NetSuite classification associated with this expense, often used for segmenting transactions by business unit or function.
customerStringFalseNoThe customer associated with this expense, if applicable. This can be used for tracking expenses linked to specific clients.
departmentStringFalseNoThe department responsible for this expense, aiding in financial segmentation and internal budgeting.
expenseitemIntegerFalseNoThe specific expense item recorded in this transaction, referencing predefined expense categories in the system.
grossamtDecimalFalseNoThe total gross amount of this expense before any deductions, discounts, or adjustments.
isbillableBooleanFalseNoIndicates whether this expense is billable to a customer. If true, the cost can be passed on through invoicing.
lineIntegerFalseNoThe line number of this expense entry within the vendor return authorization transaction, maintaining sequence order.
locationStringFalseNoThe physical or business location associated with this expense, often used for multi-location financial tracking.
memoStringFalseNoA free-text field allowing additional details or notes about this expense for reference or clarification.
orderdocStringFalseNoA reference to the related purchase order or document associated with this expense, aiding in transaction linking.
orderlineStringFalseNoThe specific line from the related order document corresponding to this expense, ensuring accurate reconciliation.
vendorreturnauthorizationStringFalseNoThe unique identifier for the vendor return authorization related to this expense, linking it to the parent transaction.

Return to Top

vendorRolesForSearch 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoA unique identifier that corresponds to a vendor, supplier, or another business entity within the NetSuite system.

Return to Top

vendorSubscriptionMessageHistory 

NameTypeReadOnlyReferencesFilterOnlyDescription
emailStringFalseNoThe email address of the recipient who received the subscription message. This field stores the email contact information used for communication.
memoStringFalseNoA note or comment associated with the subscription message. This field can store additional details about the message content or purpose.
recipientStringFalseNoThe name or identifier of the recipient who was sent the subscription message. This field helps track the intended recipient within the system.
senddateDateFalseNoThe date when the subscription message was sent to the recipient. This timestamp helps track communication history and message delivery timing.
senderStringFalseNoThe name or identifier of the sender who initiated the subscription message. This field records the user or system that dispatched the message.

Return to Top

vendorSubscriptions 

NameTypeReadOnlyReferencesFilterOnlyDescription
entityStringFalseNoThe unique identifier for the entity associated with the subscription. This typically refers to a vendor, customer, or other business entity in NetSuite.
lastmodifieddateDateFalseNoThe date and time when the subscription record was last updated. This helps track changes and maintain audit logs for subscription modifications.
subscriptionStringFalseNoThe specific campaign subscription associated with the entity. This indicates the type of marketing campaign or communication preference the entity is subscribed to.

Return to Top

vendorsubsidiaryrelationship 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoUnique internal identifier assigned to each vendor-subsidiary relationship. This ID is auto-generated by the system and cannot be modified.
balanceDecimalFalseNoThe current outstanding balance for the vendor within the specified subsidiary. This includes unpaid invoices and pending transactions.
balancebaseDecimalFalseNoThe outstanding balance for the vendor within the subsidiary, converted to the base currency of the NetSuite account for standardization.
basecurrencyStringFalseNoThe default currency assigned to the subsidiary. This is used for reporting and financial transactions within the entity.
creditlimitDecimalFalseNoThe maximum amount of credit that has been extended to the vendor by the subsidiary. Transactions exceeding this limit can require approval.
externalidStringFalseNoAn optional external identifier that can be used to reference the vendor-subsidiary relationship in external systems or integrations.
isprimarysubBooleanFalseNoIndicates whether this subsidiary is the vendor's primary subsidiary. A value of 'true' means this is the main subsidiary for transactions.
nameStringFalseNoThe name of the vendor-subsidiary relationship. This field can be auto-generated and is often used internally for identification.
primarycurrencyStringFalseNoThe primary currency used for transactions with the vendor within this subsidiary. This can differ from the base currency.
subsidiaryStringFalseNoThe subsidiary associated with the vendor in this relationship. This defines the financial and operational entity responsible for managing transactions with the vendor.
unbilledordersDecimalFalseNoThe total value of unbilled purchase orders and other pending vendor commitments within the subsidiary.
unbilledordersbaseDecimalFalseNoThe value of unbilled purchase orders and vendor commitments, converted into the base currency of the NetSuite account for consistency in financial reporting.

Return to Top

verificationMatchCode 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoUnique identifier used to verify a match. This key serves as a reference point for comparison operations.

Return to Top

vsoeDeferralType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoUnique identifier for the Vendor-Specific Objective Evidence (VSOE) deferral type, used to track and reference specific deferral methods within NetSuite.

Return to Top

vsoeDiscountType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier for the Vendor-Specific Objective Evidence (VSOE) discount type. This key is used as a primary reference to distinguish between different discount types in the system.
nameStringFalseNoThe name of the VSOE discount type. This represents a descriptive label that categorizes different types of VSOE discounts applied to transactions.

Return to Top

vsoeSopGroupType 

NameTypeReadOnlyReferencesFilterOnlyDescription
keyStringFalseNoA unique identifier for the Vendor-Specific Objective Evidence (VSOE) Standard Operating Procedure (SOP) Group Type. This key is used to distinguish records and ensure data integrity within the system.
nameStringFalseNoThe descriptive name of the VSOE SOP Group Type. This name helps categorize and organize different VSOE SOP Group Types for reporting and operational purposes.

Return to Top

wave 

NameTypeReadOnlyReferencesFilterOnlyDescription
completeddateDateFalseNoThe date when the wave process was completed. This marks the finalization of picking and allocation tasks associated with the wave.
createdbyStringFalseNoThe identifier of the user or system that created the wave. This helps track who initiated the wave processing.
createddateDatetimeFalseNoThe timestamp indicating when the wave was created. This is useful for auditing and tracking wave lifecycle stages.
externalidStringFalseNoA unique external identifier used for integration with third-party systems. This can help cross-reference waves with external records.
locationStringFalseNoThe warehouse or fulfillment center where this wave is being processed. This determines where picking and shipping activities take place.
nameStringFalseNoThe name or reference code assigned to this wave. This can be used for tracking and reporting on wave processing.
newwavestatusStringFalseNoThe current status of the wave in the system. This status indicates whether the wave is in progress, completed, or awaiting processing.
picktypeStringFalseNoThe method or strategy used for picking items in the wave, such as batch picking, zone picking, or discrete picking.
priorityStringFalseNoThe priority level assigned to the wave, which determines its processing urgency relative to other waves.
releaseddateDateFalseNoThe date when the wave was officially released for picking. Once released, warehouse staff can begin executing tasks associated with this wave.
searchtemplateidStringFalseNoThe identifier for the search template used to generate the wave. This template helps define criteria for selecting orders and inventory.
statusStringFalseNoThe overall status of the wave, indicating whether it is pending, in progress, completed, or canceled.
subsidiaryStringFalseNoThe business entity or subsidiary associated with this wave. This is relevant for companies operating in multiple regions or divisions.
totalassignedIntegerFalseNoThe total number of order lines assigned to pickers within this wave. This reflects the workload distribution among pickers.
totalorderlinesIntegerFalseNoThe total number of order lines included in this wave. This helps in assessing the size and complexity of the wave.
totalorderlinesfailedIntegerFalseNoThe number of order lines that failed to process within this wave. Failures could be due to inventory shortages or system errors.
totalorderlinesreleasedIntegerFalseNoThe number of order lines successfully released for picking within this wave. This reflects progress in the fulfillment process.
totalpicktasksIntegerFalseNoThe total number of pick tasks generated by this wave. Each task represents an individual picking action required for order fulfillment.
totalunassignedIntegerFalseNoThe number of order lines that have not yet been assigned to pickers. This can indicate pending work that needs distribution.
waveorderlimitStringFalseNoThe maximum number of orders that can be included in this wave. This limit is typically defined based on operational constraints.
wavetypeStringFalseNoThe category of wave, such as regular, priority, or replenishment. This classification helps optimize warehouse operations.

Return to Top

wbs 

NameTypeReadOnlyReferencesFilterOnlyDescription
createdbyStringFalseNoThe user or entity that initially created this Work Breakdown Structure (WBS) entry.
createddateDatetimeFalseNoThe timestamp indicating when this WBS entry was first created.
customformStringFalseNoThe identifier for the custom form used when creating or modifying this WBS entry.
descriptionStringFalseNoA detailed text field providing additional context or summary information about the WBS entry.
enddateDateFalseNoThe planned or actual end date for the WBS entry, defining the completion timeline for the associated work.
externalidStringFalseNoA unique identifier assigned to this WBS entry by an external system, useful for integrations and data synchronization.
idIntegerFalseNoA unique identifier for each WBS record being imported or updated in the system, ensuring accurate data mapping, tracking, and management.
internalidIntegerFalseNoThe internal NetSuite identifier for this WBS entry, used for referencing within the system.
isinactiveBooleanFalseNoIndicates whether this WBS entry is inactive. A value of 'true' means the entry is not currently in use.
lastmodifiedbyStringFalseNoThe user or entity that last modified this WBS entry.
lastmodifieddateDatetimeFalseNoThe timestamp indicating the most recent modification to this WBS entry.
margintargetStringFalseNoThe expected profit margin target associated with this WBS entry, typically expressed as a percentage or numerical value.
projectStringFalseNoThe project to which this WBS entry belongs, linking the task structure to the overall project framework.
startdateDateFalseNoThe planned or actual start date for the WBS entry, marking the beginning of the associated work.
templatestoredBooleanFalseNoIndicates whether this WBS entry is stored as a template for reuse in future projects.
timelinetypeStringFalseNoDefines the type of timeline used for this WBS entry, which can influence scheduling and dependency management.

Return to Top

WbsAmount 

NameTypeReadOnlyReferencesFilterOnlyDescription
adateDateFalseNoThe date associated with the financial record, typically representing when the transaction or forecast was recorded.
eacDecimalFalseNoThe estimated amount at completion (EAC), representing the projected total cost or value of the work package based on current data.
keyIntegerFalseNoA unique identifier for each record, used as a primary key to ensure data integrity and enable efficient lookups.
typeStringFalseNoThe type of financial amount being recorded, such as budgeted, actual, or forecasted values, to categorize different cost types.

Return to Top

WbsLine 

NameTypeReadOnlyReferencesFilterOnlyDescription
costcalculationtypeStringFalseNoIndicates the type of cost calculation applied to this Work Breakdown Structure (WBS) line, such as fixed cost, time-based, or material-based costing.
keyIntegerFalseNoA unique identifier for the WBS line within the system, used for internal tracking and reference.
nameStringFalseNoThe name assigned to this WBS line, typically representing a specific task, phase, or component of the project.
parentStringFalseNoThe identifier of the parent WBS line, establishing a hierarchical relationship between tasks or project elements.
projecttaskStringFalseNoThe associated project task that this WBS line corresponds to, linking it to the broader project structure.
resourceentityStringFalseNoThe entity, such as an employee, contractor, or vendor, responsible for executing or contributing to this WBS line.
resourceitemStringFalseNoThe specific item or material allocated to this WBS line, used for tracking resources in project cost calculations.
seqnumIntegerFalseNoThe sequence number assigned to this WBS line, defining its order within the project structure for scheduling and reporting.
skeyStringFalseNoA system-generated unique identifier for the WBS line, used for database referencing and data integrity.

Return to Top

website 

NameTypeReadOnlyReferencesFilterOnlyDescription
analyticsclickattributesStringFalseNoStores attributes related to user clicks for analytics tracking, helping to understand user interactions and improve website performance.
analyticssubmitattributesStringFalseNoCaptures attributes associated with form submissions for analytics, used to track user engagement and conversion rates.
autodownloadmediaBooleanFalseNoIndicates whether media files, such as images or videos, are automatically downloaded when accessed, improving user experience.
cartdisplayorderStringFalseNoDefines the display order of items within the shopping cart, allowing customization of item arrangement based on business preferences.
cartupsellitemsStringFalseNoLists items that are recommended as upsell opportunities in the shopping cart, helping to increase sales by suggesting complementary products.
categorylistlayoutStringFalseNoSpecifies the layout format for displaying product categories on the website, controlling how category pages appear to users.
ccformtemplateStringFalseNoDefines the template used for credit card payment forms, ensuring a consistent and user-friendly checkout experience.
ccrequireauthBooleanFalseNoIndicates whether credit card transactions require authentication, enhancing security by enforcing additional verification steps.
checkoutdomainStringFalseNoSpecifies the domain where the checkout process takes place, allowing businesses to manage transactions on a separate domain if necessary.
colorsetStringFalseNoDetermines the set of colors used in the website’s theme, affecting the overall visual design and branding.
confpagetrackinghtmlStringFalseNoContains custom HTML code for tracking conversions on the confirmation page, often used for analytics and marketing purposes.
cookiepolicyStringFalseNoDefines the website’s cookie policy, detailing how cookies are used and obtaining user consent where required.
createcustomersascompaniesBooleanFalseNoDetermines whether new customer accounts are created as company profiles rather than individual users, useful for B2B sales.
custromeregistrationtypeStringFalseNoSpecifies the type of customer registration process used on the website, such as guest checkout or account creation.
defaultcustomercategoryStringFalseNoSets the default customer category assigned to new users, which can be used for segmentation and personalized marketing.
defaulthostingrootStringFalseNoDefines the default root directory for website hosting, determining where website files and assets are stored.
defaultshippingcountryStringFalseNoSpecifies the default country selected for shipping during checkout, streamlining the user experience based on business location.
defaultshippingmethodStringFalseNoDetermines the default shipping method offered to customers at checkout, ensuring a consistent delivery option.
descriptionfontsizeStringFalseNoControls the font size used for product descriptions, affecting readability and visual presentation.
displaycompanyfieldBooleanFalseNoIndicates whether the company name field is displayed in registration and checkout forms, typically used in B2B transactions.
displaynameStringFalseNoStores the publicly displayed name of the website, which is visible to users and used in branding.
displayunsubscribeBooleanFalseNoDetermines whether an unsubscribe option is displayed in marketing communications, ensuring compliance with email regulations.
doctypehtmlStringFalseNoSpecifies the HTML document type declaration, affecting how the web browser renders the page.
emailfooterStringFalseNoDefines the footer content for emails sent from the website, typically used for branding and legal disclaimers.
emailheaderStringFalseNoSets the header content for outgoing emails, often including the company logo or branding information.
enablegaintegrationBooleanFalseNoIndicates whether Google Analytics integration is enabled, allowing tracking of website traffic and user behavior.
externalidStringFalseNoStores a unique external identifier for the website, which can be used for integrations with third-party systems.
fontStringFalseNoDefines the primary font used across the website, affecting typography and overall design aesthetics.
gconotificationurlStringFalseNoSpecifies the URL for Google Checkout notifications, enabling integration with Google’s payment processing service.
giftcerteaffectsminamountBooleanFalseNoDetermines whether gift certificates impact the minimum purchase amount required for an order.
hidepaymentpagewhennobalanceBooleanFalseNoIndicates whether the payment page is hidden when the order balance is zero, streamlining the checkout process for fully paid orders.
igniteeditionStringFalseNoStores the edition of the Ignite eCommerce platform being used, which can impact available features and capabilities.
includeuncategorizeditemsBooleanFalseNoSpecifies whether items without an assigned category should be displayed in product listings.
includevatwithpricesBooleanFalseNoIndicates whether value-added tax (VAT) is included in displayed product prices, ensuring compliance with tax regulations.
internalnameStringFalseNoStores the internal system name of the website, used for administrative and configuration purposes.
invoiceformtemplateStringFalseNoDefines the template used for generating invoices, ensuring consistency in billing documents.
isscriptablecartandcheckoutBooleanFalseNoIndicates whether the shopping cart and checkout process can be customized using scripts, allowing for advanced functionality.
iswebstoreofflineBooleanFalseNoDetermines whether the web store is currently offline, allowing administrators to disable the storefront when necessary.
iswsdkBooleanFalseNoSpecifies whether the web store is using the Web Store Development Kit (WSDK), which provides additional customization capabilities.
itemlistlayoutStringFalseNoDefines the layout style for product listing pages, determining how products are displayed to users.
itemtemplateaccountingtitemStringFalseNoSpecifies the template used for accounting-related item details, ensuring consistency in financial reporting.
itemtemplateinformationitemStringFalseNoDefines the template used for displaying product information, controlling the presentation of item details.
legacycategorydescriptionsBooleanFalseNoIndicates whether older category description formats are supported, allowing backward compatibility with previous website versions.
legacydenselistsupportBooleanFalseNoDetermines whether legacy support for dense item lists is enabled, maintaining compatibility with older site structures.
legacyimageattributetagsBooleanFalseNoSpecifies whether older image attribute tags are still used, preserving compatibility with legacy content.
legacynavigationlinksBooleanFalseNoIndicates whether older navigation link formats are retained, allowing a smoother transition during website updates.
legacywelcomepageBooleanFalseNoDetermines whether the older welcome page format is used, providing continuity for returning users.
nameorigStringFalseNoStores the original name of the website before any modifications, used for reference and historical tracking.
noactivatetabonhostedpagesBooleanFalseNoIndicates whether activation tabs are disabled on hosted pages, ensuring a streamlined user experience.
onlinepricelevelStringFalseNoDefines the price level used for displaying product prices online. This determines how pricing tiers are shown to customers based on their roles or other criteria.
outofstockitemsStringFalseNoSpecifies how out-of-stock items are handled on the website. Possible values can include hiding items, displaying a backorder message, or allowing pre-orders.
outputlinebreaksasbrBooleanFalseNoDetermines whether line breaks in text fields should be converted into
HTML tags for proper formatting in online displays.
pagealignStringFalseNoControls the alignment of the website content. Options can include left, center, or right alignment, affecting how the layout appears across different devices.
pagewidthStringFalseNoDefines the width of the webpage in pixels or percentage. This setting affects the responsiveness and overall structure of the site.
pagezoomStringFalseNoSets the default zoom level of the website. This can influence readability and the scale at which content is displayed.
passpromocodetocheckoutBooleanFalseNoIndicates whether promotional codes entered on the website should automatically be passed to the checkout process for discounts or special offers.
relateditemsdescriptionStringFalseNoStores the description used for the related items section, providing context or promotional text to guide customers to additional purchases.
relateditemslayoutStringFalseNoDefines the layout format for related items on product pages. This setting affects how related products are presented to customers.
requestshippingaddressfirstBooleanFalseNoDetermines whether customers must provide a shipping address before proceeding with checkout. Useful for calculating shipping costs in advance.
requirecompanyfieldBooleanFalseNoSpecifies whether the company name field is required during customer registration or checkout. This is useful for B2B transactions.
requireloginforpricingBooleanFalseNoIndicates whether users must be logged in to view product pricing. Common in B2B settings where different customers can have different pricing levels.
requireshippinginformationBooleanFalseNoControls whether shipping details must be provided before completing an order. This ensures customers enter a valid shipping address before proceeding.
requiretermsandconditionsBooleanFalseNoRequires customers to agree to terms and conditions before completing a purchase, ensuring compliance with company policies.
salesordertypeStringFalseNoDefines the type of sales order used for online transactions. This could specify standard, drop-ship, or other types of orders.
savecreditinfoBooleanFalseNoIndicates whether customers can save their credit card information for future purchases, improving checkout convenience.
scripttemplatecreditcardStringFalseNoSpecifies the script template used for processing credit card transactions on the website. This can include security and validation parameters.
scripttemplateinvoiceStringFalseNoDefines the script template used for generating invoices for online orders. This template controls the formatting and content of invoices.
searchcategorylistlayoutStringFalseNoDetermines the layout style used when displaying search results for product categories. This setting affects user navigation experience.
searchforcategoriesBooleanFalseNoIndicates whether category searches are enabled. If 'true', customers can search for entire product categories instead of just individual products.
searchforinformationitemsBooleanFalseNoSpecifies whether non-product information items, such as articles or frequently asked questions (FAQs) can be included in search results.
searchformitemlistlayoutStringFalseNoDefines the layout format for the item list within the search form. This setting impacts how products appear when searching.
searchitemlistlayoutStringFalseNoDetermines how item lists are displayed in search results. Layouts can include grid, list, or detailed views.
searchlinkformStringFalseNoSpecifies the form used for search link functionality, controlling how search links are structured and processed.
searchportletdisplayStringFalseNoDefines the display format for the search portlet, which provides quick access to search functionality on the website.
searchportletformStringFalseNoSets the form template used within the search portlet, affecting the fields and layout of search-related UI components.
searchresultforinvalidurlsBooleanFalseNoDetermines whether an automatic search is performed when a user visits an invalid or non-existent URL, helping guide them to relevant content.
semailaddrforerrorStringFalseNoSpecifies the email address where error notifications related to website operations should be sent. Useful for debugging and issue resolution.
shipstoallcountriesBooleanFalseNoIndicates whether the website supports shipping to all countries. If the value is 'false', shipping is restricted to specific countries.
shipstocountriesStringFalseNoLists the countries the website ships to, formatted as a comma-separated list with a space after each comma.
showbillingaddressBooleanFalseNoControls whether the billing address is displayed during checkout. Useful for cases where billing and shipping addresses are separate.
showcartsummaryportletBooleanFalseNoDetermines whether a cart summary portlet is displayed, allowing customers to see an overview of their cart contents at all times.
showcookieconsentbannerBooleanFalseNoIndicates whether a cookie consent banner is shown to users, ensuring compliance with privacy regulations such as General Data Protection Regulation (GDPR).
showcurrencyportletBooleanFalseNoControls whether a currency selection portlet is displayed, allowing users to switch between different currencies.
showextendedcartBooleanFalseNoEnables an expanded cart view that displays additional details about items in the shopping cart, such as descriptions and applied discounts.
shownavigationportletBooleanFalseNoDetermines whether a navigation portlet is shown, allowing users to quickly browse categories and other sections of the website.
showordertrackinglinkBooleanFalseNoIndicates whether an order tracking link is provided to customers, allowing them to check the status of their orders.
showpofieldonpaymentBooleanFalseNoControls whether a purchase order (PO) field is available on the payment page, often used in B2B transactions.
showquantitypricinginlistsBooleanFalseNoDetermines whether quantity-based pricing tiers are displayed in product listings, allowing customers to see bulk discounts.
showsavecreditinfoBooleanFalseNoSpecifies whether an option to save credit card information is shown during checkout. This can enhance convenience for returning customers.
showsearchportletBooleanFalseNoIndicates whether a search portlet is available, allowing users to quickly initiate searches from any page.
showshippingestimatorBooleanFalseNoControls whether a shipping cost estimator is available before checkout, helping customers estimate total costs in advance.
showtellafriendlinkBooleanFalseNoDetermines whether a 'Tell a Friend' link is displayed, enabling users to share product pages via email or social media.
siteloginrequiredBooleanFalseNoIndicates whether customers must log in before accessing the site. This is often used for private or B2B websites.
siteportletstyleStringFalseNoDefines the styling for portlets across the site, affecting visual appearance and user experience.
sitetabalignmentStringFalseNoSpecifies the alignment of site navigation tabs, impacting how menu items are positioned.
sitetabstyleStringFalseNoDefines the styling for site navigation tabs, controlling visual aspects like color, font, and size.
siteusescarttagsBooleanFalseNoIndicates whether cart-related tags are used in the site's template system, affecting cart functionality and display.
siteusesdropshadowsBooleanFalseNoDetermines whether drop shadows are applied to elements across the site, impacting visual depth and design aesthetics.
sstoreemailaddrforcopyStringFalseNoSpecifies the email address used for receiving copies of system-generated store emails, such as order confirmations and notifications.
sstoreemailaddrforgiftconfcopyStringFalseNoStores the email address where gift confirmation copies are sent. This is used for sending purchase confirmations to gift recipients or designated contacts.
sstoreemailaddrforgiftcopyStringFalseNoStores the email address where gift order copies are sent. This is typically used to notify store administrators or designated recipients of gift-related purchases.
storealiasStringFalseNoThe alias or short identifier for the store, often used in URLs or internal references for branding and navigation purposes.
storeemailStringFalseNoThe primary email address for the store, used for customer communication, order notifications, and support inquiries.
termsandconditionshtmlStringFalseNoThe HTML-formatted terms and conditions displayed on the website. This content is often included in checkout processes, legal disclaimers, and customer agreements.
textgroupStringFalseNoA grouping identifier for textual content within the website, enabling easier management of localized or categorized text elements.
titlefontsizeStringFalseNoDefines the font size of page titles displayed on the website, ensuring consistency in typography and branding.
upselldescriptionStringFalseNoA detailed description of upsell recommendations displayed to customers. This can include marketing text that explains why the recommended products are relevant.
upsellitemsStringFalseNoA list of product identifiers or Stock Keeping Units (SKUs) associated with upsell recommendations. These items are displayed to encourage additional purchases based on customer browsing or purchasing behavior.
upsellitemslayoutStringFalseNoSpecifies the layout format used to display upsell items, determining how recommended products appear in the user interface.
upsellminimumcorrelationStringFalseNoDefines the minimum correlation threshold for upsell recommendations, ensuring that suggested products are relevant based on customer behavior data.
upsellminimumcountIntegerFalseNoThe minimum number of upsell products required before displaying upsell recommendations to the customer.
upsellminimumliftStringFalseNoDefines the minimum sales lift percentage required for an upsell recommendation to be shown. This ensures that only statistically significant recommendations are presented.
urlformatStringFalseNoDefines the URL structure used for web pages, such as product pages or category pages, ensuring consistency in search engine-friendly URLs.
useurlfileextensionBooleanFalseNoIndicates whether URLs should include a file extension, such as hypertext markup language (.html) or hypertext preprocessor (.php) when generating web page links.
websitehomepageStringFalseNoThe URL or identifier of the homepage for the website, determining the default landing page for visitors.
websitehomepagetypeStringFalseNoSpecifies the type of homepage used for the website, such as a static page, dynamic content, or a category-based homepage.
websitelogoStringFalseNoThe file path or URL of the website logo, displayed on the site’s header and branding sections.
websitelogoalignStringFalseNoSpecifies the alignment of the website logo, determining whether it appears left, center, or right in the header.
websitelogolinkurlStringFalseNoDefines the URL linked to the website logo, typically redirecting users to the homepage when clicked.
websitescopeStringFalseNoIndicates the scope of the website, defining whether it applies globally, regionally, or to a specific storefront.
websitethemeStringFalseNoThe name or identifier of the website theme, determining the visual styling and layout applied to the site.
webstoreadditembehaviorStringFalseNoDefines the behavior when customers add items to their shopping cart, such as redirecting to the cart page or displaying a confirmation message.
webstoremetatagsStringFalseNoContains metadata tags for the website, including descriptions and keywords, used for search engine optimization (SEO).
wsdkcancelcarturlStringFalseNoThe URL where users are redirected if they cancel the cart process before completing a purchase.
wsdkcancelcheckouturlStringFalseNoThe URL where users are redirected if they cancel the checkout process before completing an order.
wsdkcancelloginurlStringFalseNoThe URL where users are redirected if they cancel the login process before authentication is completed.
wsdkcompletecheckouturlStringFalseNoThe URL where users are redirected after successfully completing a checkout process.
wsdkcompleteloginurlStringFalseNoThe URL where users are redirected after successfully logging in, often directing them to their account dashboard or homepage.

Return to Top

webSiteFieldsetRecordType 

NameTypeReadOnlyReferencesFilterOnlyDescription
nameStringFalseNoThe name of the website fieldset record type, which serves as a unique identifier.

Return to Top

winlossreason 

NameTypeReadOnlyReferencesFilterOnlyDescription
externalidStringFalseNoA unique identifier assigned to the win/loss reason by an external system. This ID is used to reference the record when integrating with external applications.
isinactiveBooleanFalseNoIndicates whether the win/loss reason is currently active. A value of 'true' means the reason is inactive and no longer in use, while 'false' means it is available for selection.
nameStringFalseNoThe name of the win/loss reason, describing the factor influencing the outcome of a sales opportunity. This name is used in reporting and analysis to categorize sales performance.

Return to Top

workCalendar 

NameTypeReadOnlyReferencesFilterOnlyDescription
id [KEY]IntegerFalseNoThe unique internal identifier for the work calendar. This value is automatically assigned by NetSuite and cannot be changed.
commentsStringFalseNoAdditional notes or remarks about this work calendar. This can be used to store details about usage, exceptions, or scheduling rules.
fridayBooleanFalseNoIndicates whether Friday is considered a working day in this calendar. A value of 'true' means Friday is included as a workday.
isdefaultBooleanFalseNoSpecifies whether this work calendar is the default calendar for the system. If set to 'true,' this calendar is automatically applied unless another is specified.
mondayBooleanFalseNoIndicates whether Monday is considered a working day in this calendar. A value of 'true' means Monday is included as a workday.
nameStringFalseNoThe name assigned to this work calendar. This should be a unique and descriptive name that reflects its intended usage.
saturdayBooleanFalseNoIndicates whether Saturday is considered a working day in this calendar. A value of 'true' means Saturday is included as a workday.
starthourStringFalseNoThe time at which the workday starts for this calendar. Typically formatted as HH in a 24-hour or AM/PM format depending on system settings.
sundayBooleanFalseNoIndicates whether Sunday is considered a working day in this calendar. A value of 'true' means Sunday is included as a workday.
thursdayBooleanFalseNoIndicates whether Thursday is considered a working day in this calendar. A value of 'true' means Thursday is included as a workday.
tuesdayBooleanFalseNoIndicates whether Tuesday is considered a working day in this calendar. A value of 'true' means Tuesday is included as a workday.
workhoursperdayDoubleFalseNoDefines the total number of working hours in a standard workday for this calendar. This value is used for scheduling and capacity planning.

Return to Top

workCalendarHoliday 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoA detailed description of the holiday or exception day, providing context for its observance, such as national holidays, company breaks, or special occasions.
exceptiondateDateFalseNoThe specific date that is designated as a holiday or exception date in the work calendar that affects scheduling, payroll, time tracking, or resource planning.

Return to Top

workflowactionscript 

NameTypeReadOnlyReferencesFilterOnlyDescription
defaultfunctionStringFalseNoSpecifies the default function that this workflow action script will execute when triggered. This function typically contains the primary business logic for the script.
descriptionStringFalseNoA detailed explanation of the purpose of this workflow action script. This can include information about what processes it automates or how it integrates with other scripts.
externalidStringFalseNoA unique identifier for this workflow action script that can be used to reference it externally, such as through integrations or API calls.
isinactiveBooleanFalseNoIndicates whether this workflow action script is currently inactive. If the value is 'true', the script will not execute as part of the workflow.
nameStringFalseNoThe name assigned to this workflow action script. This name is used to identify the script within the NetSuite environment.
notifyadminsBooleanFalseNoDetermines whether administrators should receive notifications when this workflow action script is executed. Useful for tracking script activity and errors.
notifyemailsStringFalseNoA list of email addresses that should receive notifications when this workflow action script runs. Multiple addresses are separated by commas.
notifygroupStringFalseNoThe identifier of a NetSuite user group that should receive notifications regarding the execution of this workflow action script.
notifyownerBooleanFalseNoIndicates whether the owner of the workflow action script should be notified when the script executes. Helps script owners stay informed about script activity.
notifyuserBooleanFalseNoSpecifies whether the user who initiated the workflow action should receive notifications about the script's execution. Useful for providing execution feedback.
ownerStringFalseNoThe owner of this workflow action script, typically a NetSuite user responsible for maintaining and updating the script.
returnrecordtypeStringFalseNoDefines the type of record that this workflow action script returns. Helps determine how the script interacts with NetSuite records.
returntypeStringFalseNoSpecifies the expected data type of the value returned by this workflow action script. Ensures compatibility with calling scripts or processes.
scriptfileStringFalseNoThe file associated with this workflow action script, containing the script's source code. This file is stored in the NetSuite file cabinet.
scriptidStringFalseNoA unique internal identifier for this workflow action script, used for referencing the script programmatically within NetSuite.
scripttypeStringFalseNoIndicates the type of script this workflow action script represents, such as a user event script, client script, or scheduled script.

Return to Top

workorder 

NameTypeReadOnlyReferencesFilterOnlyDescription
actualproductionenddateDateFalseNoThe actual date when the production process for this work order was completed.
actualproductionstartdateDateFalseNoThe actual date when the production process for this work order began.
assemblyitemStringFalseNoThe assembly item associated with this work order, specifying the finished product being manufactured.
autocalculatelagBooleanFalseNoIndicates whether the system should automatically calculate lag time between dependent work order operations.
billofmaterialsStringFalseNoThe Bill of Materials (BOM) that defines the list of raw materials, components, and sub-assemblies required for production.
billofmaterialsrevisionStringFalseNoThe specific revision of the BOM used in this work order, reflecting changes in materials or processes.
classStringFalseNoThe classification category assigned to this work order for tracking and reporting purposes.
createddateDatetimeFalseNoThe date and time when this work order was initially created in the system.
createdfromStringFalseNoThe originating transaction or record that this work order was created from, such as a sales order or another work order.
currencyStringFalseNoThe currency in which this work order's costs and transactions are recorded.
customformStringFalseNoThe custom form template used to enter and display data for this work order.
departmentStringFalseNoThe department responsible for executing or managing this work order, useful for financial tracking and reporting.
enddateDateFalseNoThe scheduled or planned completion date for this work order.
entityStringFalseNoThe entity, such as a customer or vendor, associated with this work order.
entitynexusStringFalseNoThe tax nexus linked to the entity for tax compliance and jurisdictional reporting.
exchangerateStringFalseNoThe exchange rate applied if this work order involves a foreign currency.
expandassemblyBooleanFalseNoIndicates whether the assembly item components should be expanded and displayed in detail.
externalidStringFalseNoA unique identifier for this work order from an external system or integration.
firmedBooleanFalseNoIndicates whether this work order is firmed, meaning that it is locked from automatic rescheduling.
jobStringFalseNoThe job or project associated with this work order, used for job costing and tracking.
lastmodifieddateDatetimeFalseNoThe date and time when this work order was last modified.
locationStringFalseNoThe physical or virtual location where this work order's production or assembly takes place.
memoStringFalseNoA free-text field for entering additional notes or comments regarding this work order.
nexusStringFalseNoThe tax jurisdiction that applies to this work order for compliance purposes.
orderstatusStringFalseNoThe current status of this work order, such as pending, in progress, or completed.
quantityStringFalseNoThe number of units to be produced or processed under this work order.
requesteddateDateFalseNoThe date requested for this work order to be completed.
revisionStringFalseNoThe version or revision of the work order, typically used for tracking changes over time.
revisionmemoStringFalseNoA note explaining changes made in a specific revision of this work order.
salesgroupStringFalseNoThe sales group responsible for the transaction that led to this work order, if applicable.
salesrepStringFalseNoThe sales representative associated with this work order, typically from the originating transaction.
schedulingmethodStringFalseNoThe method used to schedule this work order, such as forward scheduling or backward scheduling.
sourceStringFalseNoThe source of this work order, indicating whether it was created manually, from a sales order, or another transaction.
startdateDateFalseNoThe planned or scheduled start date for this work order.
statusStringFalseNoThe current processing status of this work order, such as open, closed, or in production.
statusRefStringFalseNoA reference code for the status of this work order, often used internally for system processing.
subsidiaryStringFalseNoThe subsidiary within the organization that owns and manages this work order.
syncpartnerteamsBooleanFalseNoIndicates whether partner teams should be synchronized with this work order for collaboration.
syncsalesteamsBooleanFalseNoIndicates whether sales teams should be synchronized with this work order for reporting and tracking.
trandateDateFalseNoThe transaction date recorded for this work order, often used for financial and reporting purposes.
tranidStringFalseNoThe unique transaction ID assigned to this work order by the system.
unitsStringFalseNoThe unit of measure applicable to the quantity specified in this work order.

Return to Top

workorderclose 

NameTypeReadOnlyReferencesFilterOnlyDescription
classStringFalseNoRepresents the financial classification of the work order closure, typically used for tracking costs and reporting.
createddateDatetimeFalseNoThe timestamp when this work order closure record was created in the system.
customformStringFalseNoThe internal identifier for the custom form used when entering the work order closure.
departmentStringFalseNoThe department associated with this work order closure, used for categorization and financial tracking.
externalidStringFalseNoA user-defined unique identifier for this work order closure, often used for integrations with external systems.
itemStringFalseNoThe item associated with this work order closure, representing the finished good or component being processed.
lastmodifieddateDatetimeFalseNoThe timestamp of the most recent modification to this work order closure record.
locationStringFalseNoThe physical or logical location where the work order closure is being recorded, such as a warehouse or production site.
manufacturingroutingIntegerFalseNoThe unique identifier for the manufacturing routing that defines the sequence of operations required to complete the work order.
memoStringFalseNoA free-text field for additional notes or comments related to this work order closure.
orderquantityDoubleFalseNoThe total quantity of items initially planned for production in this work order.
postingperiodStringFalseNoThe accounting period in which this work order closure transaction is recorded.
quantityStringFalseNoThe actual quantity of items being closed in this work order, which can differ from the order quantity.
revisionStringFalseNoThe specific product revision or version associated with this work order closure, typically used in engineering and manufacturing processes.
revisionmemoStringFalseNoAdditional notes or comments related to the product revision used in this work order closure.
scrapquantityDoubleFalseNoThe quantity of items scrapped during the work order process due to defects, waste, or inefficiencies.
subsidiaryStringFalseNoThe subsidiary or business entity associated with this work order closure, relevant in multi-entity organizations.
taxperiodStringFalseNoThe tax reporting period in which this work order closure is recorded for compliance and reporting purposes.
totalDecimalFalseNoThe total cost or value associated with this work order closure transaction, including labor, materials, and overhead.
trandateDateFalseNoThe transaction date when this work order closure was officially recorded in the system.
tranidStringFalseNoThe unique transaction identifier assigned to this work order closure, used for tracking and referencing.

Return to Top

workordercompletion 

NameTypeReadOnlyReferencesFilterOnlyDescription
classStringFalseNoRepresents the classification associated with the work order completion, typically used for financial tracking and reporting within NetSuite.
completedquantityDoubleFalseNoThe total quantity of items that have been successfully completed in this work order process.
createddateDatetimeFalseNoThe timestamp indicating when the work order completion record was first created in the system.
customformStringFalseNoThe custom form template used to capture and display work order completion details, allowing customization of data entry and reporting.
departmentStringFalseNoThe department responsible for overseeing the work order completion, useful for cost allocation and departmental performance tracking.
endoperationStringFalseNoSpecifies the final operation in the manufacturing process that marks the completion of the work order.
externalidStringFalseNoA unique identifier assigned externally to link this work order completion with records in other systems or integrations.
inventorydetailStringFalseNoProvides specific inventory-related details, such as lot numbers, serial numbers, or bin assignments, associated with the completed items.
isbackflushBooleanFalseNoIndicates whether backflushing is applied, meaning components are automatically deducted from inventory upon work order completion.
itemStringFalseNoThe specific item or product associated with this work order completion, typically referencing an inventory item in NetSuite.
lastmodifieddateDatetimeFalseNoThe timestamp reflecting the most recent modification made to this work order completion record.
locationStringFalseNoThe physical site or warehouse where the work order completion took place, important for inventory tracking and logistics.
manufacturingroutingStringFalseNoThe predefined routing sequence used in the manufacturing process, defining the steps required to complete the work order.
memoStringFalseNoAn optional field for entering additional notes or remarks related to this work order completion, useful for internal documentation.
orderquantityDoubleFalseNoThe total quantity of items originally planned for production as specified in the work order.
postingperiodStringFalseNoThe financial posting period in which this work order completion is recorded, affecting accounting and financial reports.
quantityDoubleFalseNoThe actual quantity of items processed and completed in this work order execution.
revisionStringFalseNoIdentifies the version or engineering change level of the item being produced, ensuring the correct product design is followed.
revisionmemoStringFalseNoAdditional notes regarding the item revision, often used to document engineering changes or version-specific instructions.
scrapquantityDoubleFalseNoThe number of items scrapped or discarded during the production process due to defects, errors, or material loss.
startoperationStringFalseNoThe initial operation in the manufacturing workflow that begins the process of work order completion.
subsidiaryStringFalseNoThe specific subsidiary within the organization responsible for this work order completion, relevant in multi-entity setups.
taxperiodStringFalseNoThe designated tax period for this work order completion, used for tax reporting and compliance purposes.
totalDecimalFalseNoThe total cost or value associated with this work order completion, often used for cost accounting and financial tracking.
trandateDateFalseNoThe official transaction date when the work order completion was recorded in the system.
tranidStringFalseNoThe unique identifier assigned to this work order completion transaction within NetSuite for reference and tracking.
unitcostDoubleFalseNoThe cost per unit of the item completed in this work order, essential for cost analysis and financial reporting.
unitsStringFalseNoThe unit of measure (for example, pieces, kilograms, liters) associated with the completed quantity in this work order.

Return to Top

workorderissue 

NameTypeReadOnlyReferencesFilterOnlyDescription
classStringFalseNoThe classification category assigned to the work order issue, typically used for reporting and segmentation purposes.
createddateDatetimeFalseNoThe date and time when this work order issue record was initially created in NetSuite.
customformStringFalseNoThe unique identifier of the custom form used to capture this work order issue, allowing for customized data entry and display.
departmentStringFalseNoThe department responsible for the work order issue, helping to track costs and performance by business unit.
endoperationStringFalseNoThe final operation in the manufacturing process associated with this work order issue, marking the completion of production steps.
externalidStringFalseNoA unique identifier assigned by an external system to reference this work order issue in integration scenarios.
itemStringFalseNoThe inventory item associated with this work order issue, representing the material or product being used or consumed.
lastmodifieddateDatetimeFalseNoThe date and time when this work order issue record was last updated, indicating the most recent modification.
locationStringFalseNoThe physical or logical location where this work order issue is recorded, such as a warehouse, plant, or department.
manufacturingroutingStringFalseNoThe predefined sequence of operations used in the production process, associated with this work order issue.
memoStringFalseNoA free-text field for entering additional notes or comments related to this work order issue.
postingperiodStringFalseNoThe accounting period in which this work order issue is posted, ensuring proper financial reporting.
revisionStringFalseNoThe specific revision of the item associated with this work order issue, used for tracking design or production changes.
revisionmemoStringFalseNoAdditional notes or explanations related to the item revision, providing details on changes or updates made.
startoperationStringFalseNoThe initial operation in the manufacturing process for this work order issue, marking the beginning of production steps.
subsidiaryStringFalseNoThe subsidiary company associated with this work order issue, relevant in multi-entity NetSuite environments.
taxperiodStringFalseNoThe financial period used for tax reporting purposes in which this work order issue is recorded.
trandateDateFalseNoThe transaction date of the work order issue, representing when the issue was processed or recorded.
tranidStringFalseNoThe unique transaction ID assigned to this work order issue for tracking and referencing purposes within NetSuite.

Return to Top

workOrderPartner 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage contribution assigned to the partner for this work order, representing their share of responsibility or effort.
isprimaryBooleanFalseNoIndicates whether this partner is the primary partner for the work order. A value of 'true' means they are the main partner.
partnerStringFalseNoThe identifier or name of the partner associated with the work order, linking to the entity responsible for contributions.
partnerroleStringFalseNoThe role assigned to the partner in the context of the work order, defining their specific function or responsibility.

Return to Top

workOrderSalesTeam 

NameTypeReadOnlyReferencesFilterOnlyDescription
contributionDoubleFalseNoThe percentage of the total sale attributed to this sales team member's efforts. This value helps determine commission payouts and team performance evaluation.
employeeStringFalseNoThe identifier or name of the employee assigned to the sales team for this work order. This represents the individual responsible for sales activities related to the work order.
isprimaryBooleanFalseNoIndicates whether this sales team member is the primary representative for the work order. A value of 'true' means this individual is the main point of contact for sales-related tasks.
salesroleStringFalseNoThe specific role of the employee within the sales team for this work order. This could include titles such as 'Account Executive,' 'Sales Manager,' or other sales-related designations.

Return to Top

workplace 

NameTypeReadOnlyReferencesFilterOnlyDescription
externalidStringFalseNoA unique identifier assigned to each workplace record, typically used for integrations and external system references.
isinactiveBooleanFalseNoIndicates whether the workplace record is inactive. A value of 'true' means the workplace is deactivated and not in active use.
jurisdictioncountyStringFalseNoThe specific county jurisdiction that applies to this workplace for tax and regulatory purposes.
jurisdictionfederalStringFalseNoThe federal jurisdiction governing this workplace, which determines compliance with federal tax and labor laws.
jurisdictionlocalStringFalseNoThe local jurisdiction, such as a city or municipality, that oversees tax, licensing, and other regulations affecting this workplace.
jurisdictionschoolStringFalseNoThe school district jurisdiction assigned to this workplace, relevant for local tax assessments or compliance reporting.
jurisdictionstateStringFalseNoThe state jurisdiction under which this workplace operates, determining applicable state taxes and regulatory obligations.
mainaddressStringFalseNoThe primary address associated with this workplace, typically used for official documentation and correspondence.
nameStringFalseNoThe name of the workplace, often representing the physical location, office, or facility within the organization.
parentStringFalseNoThe parent workplace or entity to which this workplace is hierarchically related, if applicable.
subsidiaryStringFalseNoThe subsidiary or business unit to which this workplace belongs, used for financial and organizational structuring.

Return to Top

WorkplaceMainAddress 

NameTypeReadOnlyReferencesFilterOnlyDescription
nkey [KEY]StringFalseNoUnique identifier for the workplace main address record. This serves as the primary key for referencing this address within the system.
addr1StringFalseNoThe primary street address line, typically including the house number and street name for the workplace location.
addr2StringFalseNoAn additional address line for specifying suite, apartment, or building details, if applicable.
addr3StringFalseNoA tertiary address line for further details such as department or internal mail routing, if necessary.
addresseeStringFalseNoThe name of the business, organization, or entity associated with this workplace address.
attentionStringFalseNoThe name of the specific individual or department that should receive correspondence at this address.
cityStringFalseNoThe city or municipality in which the workplace is located.
countryStringFalseNoThe country where this workplace address is situated, typically represented by its official name.
dropdownstateStringFalseNoA system-generated state selection field used for standardized state or province input based on country selection.
overrideBooleanFalseNoA flag that indicates whether manual entry of state or province information is permitted when automatic selection is enabled.
stateStringFalseNoThe state or province of the workplace location, typically used for regional identification and mailing purposes.

Return to Top

zone 

NameTypeReadOnlyReferencesFilterOnlyDescription
descriptionStringFalseNoA brief text field providing additional details or notes related to this record. This can be used to store contextual information that helps users understand the purpose or contents of the record.
externalidStringFalseNoA unique identifier assigned externally to this record, typically used for integrating with other systems. This ID helps in synchronizing data between NetSuite and external applications.
isinactiveBooleanFalseNoIndicates whether this record is active or inactive. A value of 'true' means the record is inactive and no longer in use, while 'false' signifies that it is active and available for operations.
locationStringFalseNoThe physical or logical location associated with this record. This could represent a warehouse, office, or any other relevant site where the entity referenced by this record is situated.
nameStringFalseNoThe designated name of the record, providing a human-readable identifier. This is often used to distinguish different records within the same category or classification.

Return to Top