Navigation: » No topics above this level «

LineItems: HubSpot Line Items

ListRead a page of line items. Control what is returned via the `properties` query param.

Catalog: CRMLineItems

Schema: Basic

Label: Line Items

This is a read-only table function. The HubSpot API may not support changing the data or the Invantive SQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function LineItems. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Data Type	Required	Default Value	Documentation
after	string	☐		The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
archived	boolean	☐		Whether to return only results that have been archived.

Columns of Table Function

The columns of the table function LineItems are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required
archived	boolean	Archived	☐
archivedAt	datetime	Archived at	☐
associations	string	Associations	☐
createdAt	datetime	Created at	☐
id	string	ID	☐
prop_amount	decimal	Amount	☐
prop_createdate	datetime	Created at	☐
prop_description	string	Description	☐
prop_discount	decimal	Discount	☐
prop_hs_acv	decimal	Annual Contract Value	☐
prop_hs_all_accessible_team_ids	string	All Accessible Team IDs	☐
prop_hs_all_assigned_business_unit_ids	string	All Assigned Business Unit IDs	☐
prop_hs_all_owner_ids	string	All Owner IDs	☐
prop_hs_all_team_ids	string	All Team IDs	☐
prop_hs_allow_buyer_selected_quantity	string	Allow Buyer Selected Quantity	☐
prop_hs_arr	decimal	Annual Recurring Revenues	☐
prop_hs_billing_start_delay_days	decimal	Billing Start Delay Days	☐
prop_hs_billing_start_delay_months	decimal	Billing Start Delay Months	☐
prop_hs_billing_start_delay_type	string	Billing Start Delay Type	☐
prop_hs_cost_of_goods_sold	decimal	Cost of Goods Sold	☐
prop_hs_created_by_user_id	decimal	Created by User ID	☐
prop_hs_createdate	datetime	Created at	☐
prop_hs_discount_percentage	decimal	Discount Percentage	☐
prop_hs_external_id	decimal	External ID	☐
prop_hs_images	string	Images	☐
prop_hs_lastmodifieddate	datetime	Last Modified Date	☐
prop_hs_line_item_currency_code	string	Line Item Currency Code	☐
prop_hs_margin_acv	decimal	Margin Annual Contract Value	☐
prop_hs_margin_arr	decimal	Margin Annual Recurring Revenues	☐
prop_hs_margin_mrr	decimal	Margin Monthly Recurring Revenues	☐
prop_hs_margin_tcv	decimal	Margin Total Contract Value	☐
prop_hs_margin	decimal	Margin	☐
prop_hs_merged_object_ids	string	Merged Object IDs	☐
prop_hs_mrr	decimal	Monthly Recurring Revenues	☐
prop_hs_object_id	decimal	Object ID	☐
prop_hs_object_source_id	string		☐
prop_hs_object_source_user_id	decimal		☐
prop_hs_object_source	string		☐
prop_hs_position_on_quote	decimal	Position on Quote	☐
prop_hs_pre_discount_amount	decimal	Pre-discount Amount	☐
prop_hs_product_id	decimal	Product ID	☐
prop_hs_product_type	string	Product Type	☐
prop_hs_read_only	boolean	Read-only	☐
prop_hs_recurring_billing_end_date	datetime	Recurring Billing End Date	☐
prop_hs_recurring_billing_number_of_payments	decimal	Recurring Billing Number of Payments	☐
prop_hs_recurring_billing_period	string	Recurring Billing Period	☐
prop_hs_recurring_billing_start_date	datetime	Recurring Billing Start Date	☐
prop_hs_recurring_billing_terms	string	Recurring Billing Terms	☐
prop_hs_sku	string	SKU	☐
prop_hs_sync_amount	decimal	Sync Amount	☐
prop_hs_tcv	decimal	Total Contract Value	☐
prop_hs_term_in_months	decimal	Term in Months	☐
prop_hs_total_discount	decimal	Total Discount	☐
prop_hs_unique_creation_key	string	Unique Creation Key	☐
prop_hs_updated_by_user_id	decimal	Updated by User ID	☐
prop_hs_url	string	URL	☐
prop_hs_user_ids_of_all_notification_followers	string	User IDs of All Notification Followers	☐
prop_hs_user_ids_of_all_notification_unfollowers	string	User IDs of All Notification Unfollowers	☐
prop_hs_user_ids_of_all_owners	string	User IDs of All Owners	☐
prop_hs_variant_id	decimal	Variant ID	☐
prop_hs_was_imported	boolean	Was Imported	☐
prop_hubspot_owner_assigneddate	datetime	Owner Assigned Date	☐
prop_hubspot_owner_id	string	Owner ID	☐
prop_hubspot_team_id	string	Team ID	☐
prop_name	string	Name	☐
prop_price	decimal	Price	☐
prop_quantity	decimal	Quantity	☐
prop_recurringbillingfrequency	string	Recurring Billing Frequency	☐
prop_tax	decimal	Tax	☐
updatedAt	datetime	Updated at	☐

17-08-2023 07:25 Version 22.1.262-BETA+4120

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

HubSpot API Data Model

LineItems: HubSpot Line Items

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information