Query company settings, configuration, and subscription details.
GraphQL
query GetCompany {
Company {
id
label
currency { id label }
address { id city country }
phone
vat_number
status
active
settings {
data {
label
value
}
}
default_location { id label }
company_owner {
id
label
user { first_name last_name }
}
capabilities
}
}
Field Type Description idInt Company ID. labelString Company name. currencyCurrency Company currency. user_profiles[UserProfile] Company users. addressAddress Company address. logoFile Company logo. billingString Billing provider. partner_idString Partner ID. phoneString Company phone. vat_numberString VAT number. statusString Account status. created_atDateTime Creation time. global_messageString Global message for the company. trial_daysInt Trial period in days. trial_days_leftInt Days remaining in trial. activeBoolean Whether the company is active. frozenBoolean Whether the company is frozen. hide_from_company_switcherBoolean Hide company from the company switcher. discount_ends_atString Discount end date. payment_methodJSON Current payment method. shopify_billingJSON Shopify billing info. partner_clients[Company] Partner client companies. settings[Setting ] Company settings (paginated). valuationFloat Total inventory valuation (accepts date and location arguments). dated_on_handFloat Inventory on-hand at a given date (accepts date and location arguments). last_12_months_valuationJSON Valuation history for last 12 months. onboardingInt Onboarding progress. invoicesJSON Subscription invoices. available_plansJSON Available subscription plans. planJSON Current plan details. subscriptionsJSON Subscription history. subscriptionJSON Current subscription. customerJSON Billing customer info. default_locationLocation Default inventory location. company_owner_idInt Owner user profile ID. company_ownerUserProfile Company owner profile. capabilitiesJSON Company capabilities. See Capabilities .
The settings field returns key-value configuration pairs.
Field Type Description labelString Setting name/key. valueJSON Setting value.
These settings are created dynamically when the corresponding feature is used. Not all labels are present for every company.
Label Description VALUATION_METHODInventory valuation method: MAC, FIFO, or LIFO. Always present. ACCOUNTING_SETTINGSAccounting configuration (nested JSON). Created when accounting is activated. QUICKBOOKS_ENVQuickBooks environment (PRODUCTION or SANDBOX). Created when QuickBooks is connected. PENNYLANE_E_INVOICEPennylane e-invoicing config. Created when Pennylane is configured. STRIPE_CONNECT_FEEStripe Connect fee config. Created when Stripe Connect is set up.
The capabilities field returns a flat JSON object of dotted capability names to booleans. Capabilities determine which features are available for the company.
Capability Description platformBase platform access. platform.pdf_templatesPDF template customization. platform.email_templatesEmail template customization. platform.email_historiesEmail history tracking. platform.filesFile uploads. platform.notesNotes on entities. platform.activity_logsActivity log tracking. platform.full_settingsFull settings access. platform.erplain_goErplain Go mobile app. platform.erplain_revert_importRevert imported data. platform.alerts_entity_creationAlerts on entity creation. platform.alerts_sales_ordersAlerts on sales orders.
Capability Description catalog.productsProduct catalog. catalog.erplain_product_importsProduct imports (Erplain). catalog.variantsProduct variants. catalog.optionsVariant options. catalog.attributesVariant attributes. catalog.tagsProduct tags. catalog.brandsProduct brands. catalog.seasonsProduct seasons. catalog.service_productsService products. catalog.extended_product_managementExtended product fields. catalog.supplier_skusSupplier SKU tracking. catalog.variant_componentsVariant components (kits). catalog.searchProduct search.
Capability Description contacts.customersCustomer management. contacts.suppliersSupplier management. contacts.erplain_contact_importsContact imports (Erplain). contacts.addressesAddress management. contacts.customer_tagsCustomer tags. contacts.supplier_tagsSupplier tags. contacts.insee_searchINSEE company search (France). contacts.multiple_addressesMultiple addresses per contact. contacts.employeesEmployee management.
Capability Description documents.operationalOperational documents (estimates, orders). documents.ordersSales orders. documents.order_sourcesOrder source tracking. documents.shipping_ordersShipping orders. documents.product_returnsProduct returns. documents.purchasesPurchase orders. documents.purchase_receiptsPurchase receipts. documents.line_itemsLine item management. documents.relationsDocument relations (estimate → order → invoice). documents.numberingDocument numbering. documents.metadataDocument metadata. documents.sequencesNumbering sequences. documents.reserved_productsReserved products. documents.incoming_productsIncoming products.
Capability Description stock.levelsStock level tracking. stock.inventory_logsInventory log history. stock.batch_numbersBatch number tracking. stock.serial_numbersSerial number tracking. stock.valuationInventory valuation. stock.countsStock counts. stock.adjustmentsStock adjustments. stock.movements.entriesStock movements (entries). stock.movements.removalsStock movements (removals). stock.movements.transfersStock movements (transfers).
Capability Description accounting.estimatesAccounting for estimates. accounting.invoicesAccounting for invoices. accounting.credit_notesAccounting for credit notes. accounting.refundsAccounting for refunds. accounting.taxTax configuration. accounting.exportsAccounting exports (FEC, etc.). accounting.familiesAccounting families.
Capability Description payments.paymentsPayment tracking. payments.payment_methodsPayment method management. payments.payment_informationPayment information. payments.termsPayment terms.
Capability Description subscriptions.subscriptionsSubscription management. subscriptions.customerCustomer subscriptions.
Capability Description pricing.pricingPricing management. pricing.price_rulesPrice rules. pricing.price_levelsPrice levels. pricing.variant_pricesVariant-level pricing. pricing.discount_rulesDiscount rules. pricing.customer_pricingCustomer-specific pricing.
Capability Description workflow.validation_rulesDocument validation rules. workflow.approvalsDocument approval workflows.
Capability Description analytics.sales_intelligenceSales intelligence dashboard.
Capability Description integrations.quickbooks.sales_ordersQuickBooks — sales orders sync. integrations.quickbooks.purchasesQuickBooks — purchases sync. integrations.quickbooks.inventoryQuickBooks — inventory sync. integrations.quickbooks.accountingQuickBooks — accounting sync. integrations.quickbooks.paymentsQuickBooks — payments sync. integrations.pennylane.sales_ordersPennylane — sales orders sync. integrations.pennylane.purchasesPennylane — purchases sync. integrations.pennylane.accountingPennylane — accounting sync. integrations.pennylane.e_invoicePennylane — e-invoicing. integrations.sellsy.sales_ordersSellsy — sales orders sync. integrations.sellsy.returnsSellsy — returns sync. integrations.sellsy.accountingSellsy — accounting sync. integrations.shopify.catalogShopify — catalog sync. integrations.shopify.sales_ordersShopify — sales orders sync. integrations.shopify.returnsShopify — returns sync. integrations.shopify.inventoryShopify — inventory sync. integrations.stripe.paymentsStripe — payments.
Capability Description custom_fieldsCustom fields. b2b_storeB2B store. manufacturingManufacturing modules. novaNova interface.