companyinforesponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/quickbooks/json-schema/quickbooks-companyinforesponse-schema.json",
  "title": "companyinforesponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/quickbooks-companyinfo-api-openapi.yml#/components/schemas/companyinforesponse",
  "type": "object",
  "properties": {
    "SyncToken": {
      "type": "string",
      "description": "Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online.",
      "x-intuit-required": "Required for update"
    },
    "LegalAddr": {
      "allOf": [
        {
          "$ref": "#/$defs/physicaladdress"
        }
      ],
      "description": "Legal Address given to the government for any government communication. \n If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created:Line1 and Line2 elements are populated with the customer name and company name.\nOriginal Line1 through Line 5 contents, City, SubDivisionCode, and PostalCode flow into Line3 through Line5as a free format strings.",
      "x-intuit-required": "Optional"
    },
    "SupportedLanguages": {
      "type": "string",
      "description": "Comma separated list of languages.",
      "x-intuit-required": "Optional"
    },
    "CompanyName": {
      "type": "string",
      "description": "The name of the company.",
      "x-intuit-required": "Required for update"
    },
    "Country": {
      "type": "string",
      "description": "Country name to which the company belongs for financial calculations.",
      "x-intuit-required": "Optional"
    },
    "CompanyAddr": {
      "allOf": [
        {
          "$ref": "#/$defs/physicaladdress"
        }
      ],
      "description": "Company Address as described in preference. \n If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created:Line1 and Line2 elements are populated with the customer name and company name.\nOriginal Line1 through Line 5 contents, City, SubDivisionCode, and PostalCode flow into Line3 through Line5as a free format strings.",
      "x-intuit-required": "Required for update"
    },
    "Email": {
      "allOf": [
        {
          "$ref": "#/$defs/emailaddress"
        }
      ],
      "description": "Default email address.",
      "x-intuit-required": "Optional"
    },
    "WebAddr": {
      "allOf": [
        {
          "$ref": "#/$defs/websiteaddress"
        }
      ],
      "description": "Website address.",
      "x-intuit-required": "Optional"
    },
    "NameValue": {
      "type": "array",
      "items": {
        "type": "object",
        "x-intuit-type": "NameValue pairs"
      },
      "description": "Any other preference not covered with the standard set of attributes. See Data Services Extensions, below, for special reserved name/value pairs.\nNameValue.Name--Name of the element.\nNameValue.Value--Value of the element.",
      "x-intuit-required": "Optional"
    },
    "FiscalYearStartMonth": {
      "type": "string",
      "description": "The start month of fiscal year.",
      "x-intuit-required": "Optional"
    },
    "CustomerCommunicationAddr": {
      "allOf": [
        {
          "$ref": "#/$defs/physicaladdress"
        }
      ],
      "description": "Address of the company as given to their customer, sometimes the address given to the customer mail address is different from Company address. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created:Line1 and Line2 elements are populated with the customer name and company name.\nOriginal Line1 through Line 5 contents, City, SubDivisionCode, and PostalCode flow into Line3 through Line5as a free format strings.",
      "x-intuit-required": "Optional"
    },
    "PrimaryPhone": {
      "allOf": [
        {
          "$ref": "#/$defs/telephonenumber"
        }
      ],
      "description": "Primary phone number.",
      "x-intuit-required": "Optional"
    },
    "LegalName": {
      "type": "string",
      "description": "The legal name of the company.",
      "x-intuit-required": "Optional"
    },
    "CompanyStartDate": {
      "type": "string",
      "format": "date-time",
      "description": "DateTime when company file was created. This field and\nMetadata.CreateTimecontain the same value."
    },
    "EmployerId": {
      "type": "string",
      "description": "If your QuickBooks company has defined an EIN in company settings, this value is returned.",
      "x-intuit-required": "Optional"
    },
    "Id": {
      "type": "string",
      "description": "Unique identifier for this object.",
      "x-intuit-filterable": true
    },
    "MetaData": {
      "allOf": [
        {
          "$ref": "#/$defs/modificationmetadata"
        }
      ],
      "description": "Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.",
      "x-intuit-required": "Optional"
    }
  },
  "$defs": {
    "emailaddress": {
      "type": "object",
      "title": "emailaddress",
      "properties": {
        "Address": {
          "type": "string",
          "description": "An email address. The address format must follow the RFC 822 standard.",
          "x-intuit-required": "Optional"
        }
      }
    },
    "modificationmetadata": {
      "type": "object",
      "title": "modificationmetadata",
      "properties": {
        "CreateTime": {
          "type": "string",
          "format": "date-time",
          "description": "Time the entity was created in the source domain.",
          "x-intuit-filterable": true,
          "x-intuit-sortable": true
        },
        "LastUpdatedTime": {
          "type": "string",
          "format": "date-time",
          "description": "Time the entity was last updated in the source domain.",
          "x-intuit-filterable": true,
          "x-intuit-sortable": true
        }
      }
    },
    "physicaladdress": {
      "type": "object",
      "title": "physicaladdress",
      "properties": {
        "City": {
          "type": "string",
          "description": "City name.",
          "x-intuit-required": "Optional"
        },
        "Country": {
          "type": "string",
          "description": "For international addresses, the request can be an ISO alpha-3 code or the full name of the country. The response for update and read operations returns ISO alpha-3 country codes only.",
          "x-intuit-required": "Optional"
        },
        "Line5": {
          "type": "string",
          "description": "Fifth line of the address.",
          "x-intuit-required": "Optional"
        },
        "Line4": {
          "type": "string",
          "description": "Fourth line of the address.",
          "x-intuit-required": "Optional"
        },
        "Line3": {
          "type": "string",
          "description": "Third line of the address.",
          "x-intuit-required": "Optional"
        },
        "Line2": {
          "type": "string",
          "description": "Second line of the address.",
          "x-intuit-required": "Optional"
        },
        "Line1": {
          "type": "string",
          "description": "First line of the address.",
          "x-intuit-required": "Optional"
        },
        "PostalCode": {
          "type": "string",
          "description": "Postal code. For example, zip code for USA and Canada",
          "x-intuit-required": "Optional"
        },
        "CountrySubDivisionCode": {
          "type": "string",
          "description": "Region within a country. For example, state name for USA, province name for Canada.",
          "x-intuit-required": "Optional"
        },
        "Id": {
          "type": "string",
          "description": "Unique identifier of the QuickBooks object for the address, autoincremented when the address is changed. This is an internal value included for backwards compatibility and can be ignored.",
          "x-intuit-required": "Required for update"
        }
      }
    },
    "telephonenumber": {
      "type": "object",
      "title": "telephonenumber",
      "properties": {
        "FreeFormNumber": {
          "type": "string",
          "description": "Specifies the telephone number in free form.",
          "x-intuit-required": "Optional"
        }
      }
    },
    "websiteaddress": {
      "type": "object",
      "title": "websiteaddress",
      "properties": {
        "URI": {
          "type": "string",
          "description": "Uniform Resource Identifier for the web site.",
          "x-intuit-required": "Optional"
        }
      }
    }
  }
}