Queries

Company queries return the company of the current user as well as partner companies.

Available queries

`Company` - Returns the company of the current user

query {
  Company {
    id
    label
    currency {
      id
      label
    }
    address {
      city
    }
  }
}

`PartnerCompany` - Returns a single partner company based on the `id` provided

query {
  PartnerCompany (id: 100012) {
    id
    label
    partner_id
    status
  }
}

`PartnerCompanies` - Returns a list of partner companies based on the filters defined

query {
  PartnerCompanies {
    data {
      id
      label
      partner_id
      status
    }
  }
}

Available fields

id Int
Unique identifier of the company

label String
Name of the company

currency Currency
Currency of the company

user_profiles Array of UserProfile
User profiles associated with the company

address Address
Address of the company

logo File
Logo of the company

billing String
Billing information of the company

partner_id String
Unique identifier of the partner

phone String
Phone number of the company

vat_number String
VAT number of the company

status String
Current status of the company

created_at DateTime
Creation date of the company

global_message String
Global message displayed for the company

trial_days Int
Number of trial days of the company

trial_days_left Int
Number of trial days left for the company

active Boolean
If true, the company is active

frozen Boolean
If true, the company is frozen

discount_ends_at String
End date of the company discount

payment_method JSON
Payment method of the company

partner_clients Array of Company
Partner clients of the company

settings Array of Setting
Settings of the company

valuation Float
Computed total valuation of the company stock

last_12_months_valuation JSON
Valuation of the company over the last 12 months

onboarding Int
Onboarding step of the company

invoices JSON
Invoices of the company

available_plans JSON
Available subscription plans for the company

plan JSON
Current plan of the company

subscriptions JSON
List of the company subscriptions

subscription JSON
Last subscription of the company

customer JSON
Billing customer information of the company

default_location Location
Default location of the company

company_owner_id Int
ID of the owner of the company

company_owner UserProfile
Owner of the company

Filters

You can create filters based on following fields

id
Example: { "column" : "ID", "operator" : "EQ", "value" : 100012 }

label
Example: { "column" : "LABEL", "operator" : "LIKE", "value" : "%Company%" }

status
Example: { "column" : "STATUS", "operator" : "EQ", "value" : "active" }

Sorting

You can sort data based on following fields : id, label

query PartnerCompanies(
  $orderBy: [QueryPartnerCompaniesOrderByOrderByClause!],
  $first: Int = 50, 
  $page: Int
) {
  PartnerCompanies(
    orderBy: $orderBy
    first: $first
    page: $page
  ) {
    paginatorInfo {
      total
    }
    data {
      id
      label
      status
    }
  }
}

{
  "orderBy": [
    {
      "column": "LABEL",
      "order": "ASC"
    }
  ],
  "first": 50,
  "page": 1
}

Example of a query

query PartnerCompanies(
  $where: QueryPartnerCompaniesWhereWhereConditions, 
  $first: Int = 50, 
  $page: Int
) {
  PartnerCompanies(
    where: $where
    first: $first
    page: $page
  ) {
    paginatorInfo {
      total
      count
      currentPage
      perPage
    }
    data {
      id
      label
      status
    }
  }
}

{
  "first": 50,
  "page": 1,
  "where": {
    "AND": [
      {
        "AND": [
          {
            "column": "STATUS",
            "operator": "EQ",
            "value": "active"
          }
        ]
      }
    ]
  }
}

Example of data returned

{
  "data": {
    "PartnerCompanies": {
      "paginatorInfo": {
        "total": 1,
        "count": 1,
        "currentPage": 1,
        "perPage": 50
      },
      "data": [
        {
          "id": 100012,
          "label": "Partner Company",
          "status": "active"
        }
      ]
    }
  }
}

Data types

Setting data type

label String
Label of the setting

value JSON
Value of the setting