For AI agents: visit https://erplain.readme.io/v2.0/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Query company settings, configuration, and subscription details.
Company — Returns the current company
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
}
}
PartnerCompany — Returns a partner company by id
Returns a partner company (related company for multi-company setups).
query GetPartnerCompany($id: ID) {
PartnerCompany(id: $id) {
id
label
status
}
}
PartnerCompanies — Returns a paginated list of partner companies
Lists the partner companies linked to the current company.
query PartnerCompanies(
$where: QueryPartnerCompaniesWhereWhereConditions,
$orderBy: [QueryPartnerCompaniesOrderByOrderByClause!],
$search: String,
$first: Int,
$page: Int
) {
PartnerCompanies(
where: $where,
orderBy: $orderBy,
search: $search,
first: $first,
page: $page
) {
paginatorInfo { total }
data {
id
label
status
}
}
}
Filters:id, label, status.
Settings — Returns the company settings
Returns the list of key-value settings for the current company.
query GetSettings {
Settings {
data {
id
label
value
}
}
}
These settings are created dynamically when the corresponding feature is used. Not all labels are present for every company.
Label
Description
VALUATION_METHOD
Inventory valuation method: MAC, FIFO, or LIFO. Always present.
ACCOUNTING_SETTINGS
Accounting configuration (nested JSON). Created when accounting is activated.
QUICKBOOKS_ENV
QuickBooks environment (PRODUCTION or SANDBOX). Created when QuickBooks is connected.
PENNYLANE_E_INVOICE
Pennylane e-invoicing config. Created when Pennylane is configured.
STRIPE_CONNECT_FEE
Stripe Connect fee config. Created when Stripe Connect is set up.
Capabilities
The capabilities field returns a flat JSON object of dotted capability names to booleans. Capabilities determine which features are available for the company.
