Get an internal company by a set of criteria. Criteria will be added as needed, check documentation for the criteria object to see what is currently supported.

Arguments

criteria : SearchCriteriaInput!


            required

Criteria to identify the internal company.

Returns

InternalCompanyType

Represents an internal company.

Possible Errors

KT-CT-1113: Disabled GraphQL field requested.
KT-CT-14401: Unauthorized.
KT-CT-7899: An internal error occurred.

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can query internal companies

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Query

query InternalCompany($criteria: SearchCriteriaInput!) {
  internalCompany(criteria: $criteria) {
    displayableNumber
    id
    legalAddress {
      ...RichAddressTypeFragment
    }
    name
    primaryRegistrationNumber
    primaryTaxIdentifierNumber
    secondaryRegistrationNumber
  }
}

Variables

{
  "criteria": SearchCriteriaInput
}

Response

{
  "data": {
    "internalCompany": {
      "displayableNumber": "indicate-president-common-music-others",
      "id": "33622539",
      "legalAddress": RichAddressType,
      "name": "standard-age-country-common-truth",
      "primaryRegistrationNumber": "building-grow-production-produce-final",
      "primaryTaxIdentifierNumber": "others-describe-anything-do-instead",
      "secondaryRegistrationNumber": "doctor-center-above-level-man"
    }
  }
}