Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CompanyAPI

Company module

Hierarchy

  • default
    • CompanyAPI

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

config

config: ManageConfig

paginate

paginate: (apiMethod: Function, paginateArgs: PaginationOptions, ...methodArgs: Record<string, unknown>[]) => Promise<unknown[]>

Type declaration

    • (apiMethod: Function, paginateArgs: PaginationOptions, ...methodArgs: Record<string, unknown>[]): Promise<unknown[]>
    • example
       cwm.paginate(cwm.FinanceAPI.getFinanceAgreements, {startPage: 1, pageSize: 500}, {conditions: 'inactiveFlag = false'})

      Parameters

      • apiMethod: Function
      • paginateArgs: PaginationOptions
      • Rest ...methodArgs: Record<string, unknown>[]

      Returns Promise<unknown[]>

request

request: (args: RequestOptions) => Promise<any>

Type declaration

Methods

deleteCompanyAddressFormatsById

  • deleteCompanyAddressFormatsById(id: number): Promise<undefined>

deleteCompanyCommunicationTypesById

  • deleteCompanyCommunicationTypesById(id: number): Promise<undefined>

deleteCompanyCompaniesById

  • deleteCompanyCompaniesById(id: number): Promise<undefined>

deleteCompanyCompaniesByParentIdCustomStatusNotesById

  • deleteCompanyCompaniesByParentIdCustomStatusNotesById(id: number, parentId: number): Promise<undefined>

deleteCompanyCompaniesByParentIdGroupsById

  • deleteCompanyCompaniesByParentIdGroupsById(id: number, parentId: number): Promise<undefined>

deleteCompanyCompaniesByParentIdManagementReportNotificationsById

  • deleteCompanyCompaniesByParentIdManagementReportNotificationsById(id: number, parentId: number): Promise<undefined>

deleteCompanyCompaniesByParentIdManagementSummaryReportsById

  • deleteCompanyCompaniesByParentIdManagementSummaryReportsById(id: number, parentId: number): Promise<undefined>

deleteCompanyCompaniesByParentIdNotesById

  • deleteCompanyCompaniesByParentIdNotesById(id: number, parentId: number): Promise<undefined>

deleteCompanyCompaniesByParentIdSitesById

  • deleteCompanyCompaniesByParentIdSitesById(id: number, parentId: number): Promise<undefined>

deleteCompanyCompaniesByParentIdTeamsById

  • deleteCompanyCompaniesByParentIdTeamsById(id: number, parentId: number): Promise<undefined>

deleteCompanyCompaniesByParentIdTracksById

  • deleteCompanyCompaniesByParentIdTracksById(id: number, parentId: number): Promise<undefined>

deleteCompanyCompaniesByParentIdTypeAssociationsById

  • deleteCompanyCompaniesByParentIdTypeAssociationsById(id: number, parentId: number): Promise<undefined>

deleteCompanyCompaniesStatusesById

  • deleteCompanyCompaniesStatusesById(id: number): Promise<undefined>

deleteCompanyCompaniesTypesById

  • deleteCompanyCompaniesTypesById(id: number): Promise<undefined>

deleteCompanyCompanyPickerItemsById

  • deleteCompanyCompanyPickerItemsById(id: number): Promise<undefined>

deleteCompanyCompanyTypeAssociationsById

  • deleteCompanyCompanyTypeAssociationsById(id: number): Promise<undefined>

deleteCompanyConfigurationsBulk

  • deleteCompanyConfigurationsBulk(): Promise<{ _info?: {}; payload?: { data?: { id?: number }; error?: { code?: string; errors?: { code?: string; details?: string; field?: string; message?: string; resource?: string }[]; message?: string }; originalIndex?: number; statusCode?: number; success?: boolean }[] }>

  • Returns Promise<{ _info?: {}; payload?: { data?: { id?: number }; error?: { code?: string; errors?: { code?: string; details?: string; field?: string; message?: string; resource?: string }[]; message?: string }; originalIndex?: number; statusCode?: number; success?: boolean }[] }>

deleteCompanyConfigurationsById

  • deleteCompanyConfigurationsById(id: number): Promise<undefined>

deleteCompanyConfigurationsStatusesById

  • deleteCompanyConfigurationsStatusesById(id: number): Promise<undefined>

deleteCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesById

  • deleteCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesById(id: number, parentId: number, grandparentId: number): Promise<undefined>

deleteCompanyConfigurationsTypesById

  • deleteCompanyConfigurationsTypesById(id: number): Promise<undefined>

deleteCompanyConfigurationsTypesByParentIdQuestionsById

  • deleteCompanyConfigurationsTypesByParentIdQuestionsById(id: number, parentId: number): Promise<undefined>

deleteCompanyContactTypeAssociationsById

  • deleteCompanyContactTypeAssociationsById(id: number): Promise<undefined>

deleteCompanyContactsById

  • deleteCompanyContactsById(id: number, transferContactId: number): Promise<undefined>

deleteCompanyContactsByParentIdCommunicationsById

  • deleteCompanyContactsByParentIdCommunicationsById(id: number, parentId: number): Promise<undefined>

deleteCompanyContactsByParentIdGroupsById

  • deleteCompanyContactsByParentIdGroupsById(id: number, parentId: number): Promise<undefined>

deleteCompanyContactsByParentIdNotesById

  • deleteCompanyContactsByParentIdNotesById(id: number, parentId: number): Promise<undefined>

deleteCompanyContactsByParentIdTracksById

  • deleteCompanyContactsByParentIdTracksById(id: number, parentId: number): Promise<undefined>

deleteCompanyContactsByParentIdTypeAssociationsById

  • deleteCompanyContactsByParentIdTypeAssociationsById(id: number, parentId: number): Promise<undefined>

deleteCompanyContactsDepartmentsById

  • deleteCompanyContactsDepartmentsById(id: number): Promise<undefined>

deleteCompanyContactsRelationshipsById

  • deleteCompanyContactsRelationshipsById(id: number): Promise<undefined>

deleteCompanyContactsTypesById

  • deleteCompanyContactsTypesById(id: number): Promise<undefined>

deleteCompanyCountriesById

  • deleteCompanyCountriesById(id: number): Promise<undefined>

deleteCompanyManagedDevicesIntegrationsById

  • deleteCompanyManagedDevicesIntegrationsById(id: number): Promise<undefined>

deleteCompanyManagedDevicesIntegrationsByParentIdCrossReferencesById

  • deleteCompanyManagedDevicesIntegrationsByParentIdCrossReferencesById(id: number, parentId: number): Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; vendorLevel?: string; vendorType?: string }>

  • Parameters

    • id: number
    • parentId: number

    Returns Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; vendorLevel?: string; vendorType?: string }>

deleteCompanyManagedDevicesIntegrationsByParentIdLoginsById

  • deleteCompanyManagedDevicesIntegrationsByParentIdLoginsById(id: number, parentId: number): Promise<{ _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; password?: string; username: string }>

  • Parameters

    • id: number
    • parentId: number

    Returns Promise<{ _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; password?: string; username: string }>

deleteCompanyManagedDevicesIntegrationsByParentIdNotificationsById

  • deleteCompanyManagedDevicesIntegrationsByParentIdNotificationsById(id: number, parentId: number): Promise<{ _info?: {}; id?: number; logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • id: number
    • parentId: number

    Returns Promise<{ _info?: {}; id?: number; logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

deleteCompanyManagementBackupsById

  • deleteCompanyManagementBackupsById(id: number): Promise<undefined>

deleteCompanyManagementByParentIdManagementReportNotificationsById

  • deleteCompanyManagementByParentIdManagementReportNotificationsById(id: number, parentId: number): Promise<undefined>

deleteCompanyManagementItSolutionsById

  • deleteCompanyManagementItSolutionsById(id: number): Promise<undefined>

deleteCompanyManagementItSolutionsByParentIdManagementProductsById

  • deleteCompanyManagementItSolutionsByParentIdManagementProductsById(id: number, parentId: number): Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean } }>

  • Parameters

    • id: number
    • parentId: number

    Returns Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean } }>

deleteCompanyMarketDescriptionsById

  • deleteCompanyMarketDescriptionsById(id: number): Promise<undefined>

deleteCompanyNoteTypesById

  • deleteCompanyNoteTypesById(id: number): Promise<undefined>

deleteCompanyOwnershipTypesById

  • deleteCompanyOwnershipTypesById(id: number): Promise<undefined>

deleteCompanyPortalConfigurationsById

  • deleteCompanyPortalConfigurationsById(id: number): Promise<undefined>

deleteCompanyStatesById

  • deleteCompanyStatesById(id: number): Promise<undefined>

deleteCompanyTeamRolesById

  • deleteCompanyTeamRolesById(id: number): Promise<undefined>

deleteCompanyTracksById

  • deleteCompanyTracksById(id: number): Promise<undefined>

deleteCompanyTracksByParentIdActionsById

  • deleteCompanyTracksByParentIdActionsById(id: number, parentId: number): Promise<undefined>

getCompanyAddressFormats

  • getCompanyAddressFormats(params?: CommonParameters): Promise<{ _info?: {}; addAllCountries?: null | boolean; countryIds?: number[]; defaultFlag?: null | boolean; format: string; id?: number; name: string; removeAllCountries?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; addAllCountries?: null | boolean; countryIds?: number[]; defaultFlag?: null | boolean; format: string; id?: number; name: string; removeAllCountries?: null | boolean }[]>

getCompanyAddressFormatsById

  • getCompanyAddressFormatsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; addAllCountries?: null | boolean; countryIds?: number[]; defaultFlag?: null | boolean; format: string; id?: number; name: string; removeAllCountries?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; addAllCountries?: null | boolean; countryIds?: number[]; defaultFlag?: null | boolean; format: string; id?: number; name: string; removeAllCountries?: null | boolean }>

getCompanyAddressFormatsByIdInfo

  • getCompanyAddressFormatsByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name?: string }>

getCompanyAddressFormatsCount

  • getCompanyAddressFormatsCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyAddressFormatsInfo

  • getCompanyAddressFormatsInfo(params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name?: string }[]>

getCompanyAddressFormatsInfoCount

  • getCompanyAddressFormatsInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyBillingSetupsInfoCount

  • getCompanyBillingSetupsInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyCommunicationTypes

  • getCompanyCommunicationTypes(params?: CommonParameters): Promise<{ _info?: {}; androidXref: string; defaultFlag?: null | boolean; description: string; emailFlag?: null | boolean; exchangeXref?: string; faxFlag?: null | boolean; googleXref?: string; id?: number; iphoneXref: string; phoneFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; androidXref: string; defaultFlag?: null | boolean; description: string; emailFlag?: null | boolean; exchangeXref?: string; faxFlag?: null | boolean; googleXref?: string; id?: number; iphoneXref: string; phoneFlag?: null | boolean }[]>

getCompanyCommunicationTypesById

  • getCompanyCommunicationTypesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; androidXref: string; defaultFlag?: null | boolean; description: string; emailFlag?: null | boolean; exchangeXref?: string; faxFlag?: null | boolean; googleXref?: string; id?: number; iphoneXref: string; phoneFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; androidXref: string; defaultFlag?: null | boolean; description: string; emailFlag?: null | boolean; exchangeXref?: string; faxFlag?: null | boolean; googleXref?: string; id?: number; iphoneXref: string; phoneFlag?: null | boolean }>

getCompanyCommunicationTypesByIdInfo

  • getCompanyCommunicationTypesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; description?: string; emailFlag?: null | boolean; faxFlag?: null | boolean; id?: number; phoneFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; description?: string; emailFlag?: null | boolean; faxFlag?: null | boolean; id?: number; phoneFlag?: null | boolean }>

getCompanyCommunicationTypesByIdUsages

  • getCompanyCommunicationTypesByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyCommunicationTypesByIdUsagesList

  • getCompanyCommunicationTypesByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyCommunicationTypesCount

  • getCompanyCommunicationTypesCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyCommunicationTypesInfo

  • getCompanyCommunicationTypesInfo(params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; description?: string; emailFlag?: null | boolean; faxFlag?: null | boolean; id?: number; phoneFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; description?: string; emailFlag?: null | boolean; faxFlag?: null | boolean; id?: number; phoneFlag?: null | boolean }[]>

getCompanyCommunicationTypesInfoCount

  • getCompanyCommunicationTypesInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyCompanies

  • getCompanyCompanies(params?: CommonParameters): Promise<{ _info?: {}; accountNumber?: string; addressLine1?: string; addressLine2?: string; annualRevenue?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingContact?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; companyEntityType?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateAcquired?: string; dateDeleted?: string; defaultContact?: { _info?: {}; id?: null | number; name?: string }; deletedBy?: string; deletedFlag?: null | boolean; facebookUrl?: string; faxNumber?: string; id?: number; identifier: string; integratorTags?: string[]; invoiceCCEmailAddress?: string; invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoiceToEmailAddress?: string; isVendorFlag?: null | boolean; leadFlag?: null | boolean; leadSource?: string; linkedInUrl?: string; market?: { _info?: {}; id?: null | number; name?: string }; mobileGuid?: null | string; name: string; numberOfEmployees?: null | number; ownershipType?: { _info?: {}; id?: null | number; name?: string }; parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; phoneNumber?: string; pricingSchedule?: { _info?: {}; id?: null | number; name?: string }; resellerIdentifier?: string; revenueYear?: null | number; sicCode?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxIdentifier?: string; territory?: { _info?: {}; id?: null | number; name?: string }; territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; twitterUrl?: string; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; vendorIdentifier?: string; website?: string; yearEstablished?: null | number; zip?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; accountNumber?: string; addressLine1?: string; addressLine2?: string; annualRevenue?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingContact?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; companyEntityType?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateAcquired?: string; dateDeleted?: string; defaultContact?: { _info?: {}; id?: null | number; name?: string }; deletedBy?: string; deletedFlag?: null | boolean; facebookUrl?: string; faxNumber?: string; id?: number; identifier: string; integratorTags?: string[]; invoiceCCEmailAddress?: string; invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoiceToEmailAddress?: string; isVendorFlag?: null | boolean; leadFlag?: null | boolean; leadSource?: string; linkedInUrl?: string; market?: { _info?: {}; id?: null | number; name?: string }; mobileGuid?: null | string; name: string; numberOfEmployees?: null | number; ownershipType?: { _info?: {}; id?: null | number; name?: string }; parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; phoneNumber?: string; pricingSchedule?: { _info?: {}; id?: null | number; name?: string }; resellerIdentifier?: string; revenueYear?: null | number; sicCode?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxIdentifier?: string; territory?: { _info?: {}; id?: null | number; name?: string }; territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; twitterUrl?: string; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; vendorIdentifier?: string; website?: string; yearEstablished?: null | number; zip?: string }[]>

getCompanyCompaniesById

  • getCompanyCompaniesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; accountNumber?: string; addressLine1?: string; addressLine2?: string; annualRevenue?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingContact?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; companyEntityType?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateAcquired?: string; dateDeleted?: string; defaultContact?: { _info?: {}; id?: null | number; name?: string }; deletedBy?: string; deletedFlag?: null | boolean; facebookUrl?: string; faxNumber?: string; id?: number; identifier: string; integratorTags?: string[]; invoiceCCEmailAddress?: string; invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoiceToEmailAddress?: string; isVendorFlag?: null | boolean; leadFlag?: null | boolean; leadSource?: string; linkedInUrl?: string; market?: { _info?: {}; id?: null | number; name?: string }; mobileGuid?: null | string; name: string; numberOfEmployees?: null | number; ownershipType?: { _info?: {}; id?: null | number; name?: string }; parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; phoneNumber?: string; pricingSchedule?: { _info?: {}; id?: null | number; name?: string }; resellerIdentifier?: string; revenueYear?: null | number; sicCode?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxIdentifier?: string; territory?: { _info?: {}; id?: null | number; name?: string }; territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; twitterUrl?: string; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; vendorIdentifier?: string; website?: string; yearEstablished?: null | number; zip?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; accountNumber?: string; addressLine1?: string; addressLine2?: string; annualRevenue?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingContact?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; companyEntityType?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateAcquired?: string; dateDeleted?: string; defaultContact?: { _info?: {}; id?: null | number; name?: string }; deletedBy?: string; deletedFlag?: null | boolean; facebookUrl?: string; faxNumber?: string; id?: number; identifier: string; integratorTags?: string[]; invoiceCCEmailAddress?: string; invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoiceToEmailAddress?: string; isVendorFlag?: null | boolean; leadFlag?: null | boolean; leadSource?: string; linkedInUrl?: string; market?: { _info?: {}; id?: null | number; name?: string }; mobileGuid?: null | string; name: string; numberOfEmployees?: null | number; ownershipType?: { _info?: {}; id?: null | number; name?: string }; parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; phoneNumber?: string; pricingSchedule?: { _info?: {}; id?: null | number; name?: string }; resellerIdentifier?: string; revenueYear?: null | number; sicCode?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxIdentifier?: string; territory?: { _info?: {}; id?: null | number; name?: string }; territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; twitterUrl?: string; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; vendorIdentifier?: string; website?: string; yearEstablished?: null | number; zip?: string }>

getCompanyCompaniesByIdUsages

  • getCompanyCompaniesByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyCompaniesByIdUsagesList

  • getCompanyCompaniesByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyCompaniesByParentIdCustomStatusNotes

  • getCompanyCompaniesByParentIdCustomStatusNotes(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customNote: string; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customNote: string; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }[]>

getCompanyCompaniesByParentIdCustomStatusNotesById

  • getCompanyCompaniesByParentIdCustomStatusNotesById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customNote: string; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customNote: string; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }>

getCompanyCompaniesByParentIdCustomStatusNotesCount

  • getCompanyCompaniesByParentIdCustomStatusNotesCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyCompaniesByParentIdGroups

  • getCompanyCompaniesByParentIdGroups(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; allContactsFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contactIds?: number[]; defaultContactFlag?: null | boolean; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; removeAllContactsFlag?: null | boolean; unsubscribeFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; allContactsFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contactIds?: number[]; defaultContactFlag?: null | boolean; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; removeAllContactsFlag?: null | boolean; unsubscribeFlag?: null | boolean }[]>

getCompanyCompaniesByParentIdGroupsById

  • getCompanyCompaniesByParentIdGroupsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; allContactsFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contactIds?: number[]; defaultContactFlag?: null | boolean; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; removeAllContactsFlag?: null | boolean; unsubscribeFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; allContactsFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contactIds?: number[]; defaultContactFlag?: null | boolean; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; removeAllContactsFlag?: null | boolean; unsubscribeFlag?: null | boolean }>

getCompanyCompaniesByParentIdGroupsCount

  • getCompanyCompaniesByParentIdGroupsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyCompaniesByParentIdManagementReportNotifications

  • getCompanyCompaniesByParentIdManagementReportNotifications(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

getCompanyCompaniesByParentIdManagementReportNotificationsById

  • getCompanyCompaniesByParentIdManagementReportNotificationsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

getCompanyCompaniesByParentIdManagementReportNotificationsCount

  • getCompanyCompaniesByParentIdManagementReportNotificationsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyCompaniesByParentIdManagementReportSetup

  • getCompanyCompaniesByParentIdManagementReportSetup(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; scheduledReportDisabledFlag: boolean }[]>

getCompanyCompaniesByParentIdManagementSummaryReports

  • getCompanyCompaniesByParentIdManagementSummaryReports(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; alertsGenerated?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cpuUtilization?: null | number; deviceType?: null | "WorkstationsAndServers" | "BackupStats" | "Servers" | "Workstations"; diskCleanups?: null | number; diskDefragmentations?: null | number; diskSpaceCleanedMb?: null | number; failedBackupJobs?: null | number; fullyPatchedMachines?: null | number; groupIdentifier: string; id?: number; internetConnectivity?: null | number; managementSolution?: { _info?: {}; id?: null | number; name?: string; setupName?: string }; memoryUtilization?: null | number; missingMoreFivePatchesMachines?: null | number; missingOneTwoPatchesMachines?: null | number; missingSecurityPatches?: string; missingThreeFivePatchesMachines?: null | number; missingUnscannedPatchesMachines?: null | number; serverAvailability?: null | number; serversDiskSpaceLow?: null | number; serversOffline?: null | number; snmpMachines?: null | number; spywareItemsRemoved?: null | number; successfulBackupJobs?: null | number; totalManagedMachines?: null | number; totalNotifications?: null | number; totalServers?: null | number; totalWindowsServers?: null | number; totalWindowsWorkstations?: null | number; totalWorkstations?: null | number; virusesRemoved?: null | number; windowsPatchesInstalled?: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; alertsGenerated?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cpuUtilization?: null | number; deviceType?: null | "WorkstationsAndServers" | "BackupStats" | "Servers" | "Workstations"; diskCleanups?: null | number; diskDefragmentations?: null | number; diskSpaceCleanedMb?: null | number; failedBackupJobs?: null | number; fullyPatchedMachines?: null | number; groupIdentifier: string; id?: number; internetConnectivity?: null | number; managementSolution?: { _info?: {}; id?: null | number; name?: string; setupName?: string }; memoryUtilization?: null | number; missingMoreFivePatchesMachines?: null | number; missingOneTwoPatchesMachines?: null | number; missingSecurityPatches?: string; missingThreeFivePatchesMachines?: null | number; missingUnscannedPatchesMachines?: null | number; serverAvailability?: null | number; serversDiskSpaceLow?: null | number; serversOffline?: null | number; snmpMachines?: null | number; spywareItemsRemoved?: null | number; successfulBackupJobs?: null | number; totalManagedMachines?: null | number; totalNotifications?: null | number; totalServers?: null | number; totalWindowsServers?: null | number; totalWindowsWorkstations?: null | number; totalWorkstations?: null | number; virusesRemoved?: null | number; windowsPatchesInstalled?: null | number }[]>

getCompanyCompaniesByParentIdManagementSummaryReportsById

  • getCompanyCompaniesByParentIdManagementSummaryReportsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; alertsGenerated?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cpuUtilization?: null | number; deviceType?: null | "WorkstationsAndServers" | "BackupStats" | "Servers" | "Workstations"; diskCleanups?: null | number; diskDefragmentations?: null | number; diskSpaceCleanedMb?: null | number; failedBackupJobs?: null | number; fullyPatchedMachines?: null | number; groupIdentifier: string; id?: number; internetConnectivity?: null | number; managementSolution?: { _info?: {}; id?: null | number; name?: string; setupName?: string }; memoryUtilization?: null | number; missingMoreFivePatchesMachines?: null | number; missingOneTwoPatchesMachines?: null | number; missingSecurityPatches?: string; missingThreeFivePatchesMachines?: null | number; missingUnscannedPatchesMachines?: null | number; serverAvailability?: null | number; serversDiskSpaceLow?: null | number; serversOffline?: null | number; snmpMachines?: null | number; spywareItemsRemoved?: null | number; successfulBackupJobs?: null | number; totalManagedMachines?: null | number; totalNotifications?: null | number; totalServers?: null | number; totalWindowsServers?: null | number; totalWindowsWorkstations?: null | number; totalWorkstations?: null | number; virusesRemoved?: null | number; windowsPatchesInstalled?: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; alertsGenerated?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cpuUtilization?: null | number; deviceType?: null | "WorkstationsAndServers" | "BackupStats" | "Servers" | "Workstations"; diskCleanups?: null | number; diskDefragmentations?: null | number; diskSpaceCleanedMb?: null | number; failedBackupJobs?: null | number; fullyPatchedMachines?: null | number; groupIdentifier: string; id?: number; internetConnectivity?: null | number; managementSolution?: { _info?: {}; id?: null | number; name?: string; setupName?: string }; memoryUtilization?: null | number; missingMoreFivePatchesMachines?: null | number; missingOneTwoPatchesMachines?: null | number; missingSecurityPatches?: string; missingThreeFivePatchesMachines?: null | number; missingUnscannedPatchesMachines?: null | number; serverAvailability?: null | number; serversDiskSpaceLow?: null | number; serversOffline?: null | number; snmpMachines?: null | number; spywareItemsRemoved?: null | number; successfulBackupJobs?: null | number; totalManagedMachines?: null | number; totalNotifications?: null | number; totalServers?: null | number; totalWindowsServers?: null | number; totalWindowsWorkstations?: null | number; totalWorkstations?: null | number; virusesRemoved?: null | number; windowsPatchesInstalled?: null | number }>

getCompanyCompaniesByParentIdManagementSummaryReportsCount

  • getCompanyCompaniesByParentIdManagementSummaryReportsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyCompaniesByParentIdNotes

  • getCompanyCompaniesByParentIdNotes(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }[]>

getCompanyCompaniesByParentIdNotesById

  • getCompanyCompaniesByParentIdNotesById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

getCompanyCompaniesByParentIdNotesCount

  • getCompanyCompaniesByParentIdNotesCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyCompaniesByParentIdSites

  • getCompanyCompaniesByParentIdSites(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; addressFormat?: string; addressLine1?: string; addressLine2?: string; billSeparateFlag?: null | boolean; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultBillingFlag?: null | boolean; defaultMailingFlag?: null | boolean; defaultShippingFlag?: null | boolean; entityType?: { _info?: {}; id?: null | number; name?: string }; expenseReimbursement?: null | number; faxNumber?: string; id?: number; inactiveFlag?: null | boolean; mobileGuid?: null | string; name: string; phoneNumber?: string; primaryAddressFlag?: null | boolean; stateReference?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string }; zip?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; addressFormat?: string; addressLine1?: string; addressLine2?: string; billSeparateFlag?: null | boolean; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultBillingFlag?: null | boolean; defaultMailingFlag?: null | boolean; defaultShippingFlag?: null | boolean; entityType?: { _info?: {}; id?: null | number; name?: string }; expenseReimbursement?: null | number; faxNumber?: string; id?: number; inactiveFlag?: null | boolean; mobileGuid?: null | string; name: string; phoneNumber?: string; primaryAddressFlag?: null | boolean; stateReference?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string }; zip?: string }[]>

getCompanyCompaniesByParentIdSitesById

  • getCompanyCompaniesByParentIdSitesById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; addressFormat?: string; addressLine1?: string; addressLine2?: string; billSeparateFlag?: null | boolean; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultBillingFlag?: null | boolean; defaultMailingFlag?: null | boolean; defaultShippingFlag?: null | boolean; entityType?: { _info?: {}; id?: null | number; name?: string }; expenseReimbursement?: null | number; faxNumber?: string; id?: number; inactiveFlag?: null | boolean; mobileGuid?: null | string; name: string; phoneNumber?: string; primaryAddressFlag?: null | boolean; stateReference?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string }; zip?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; addressFormat?: string; addressLine1?: string; addressLine2?: string; billSeparateFlag?: null | boolean; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultBillingFlag?: null | boolean; defaultMailingFlag?: null | boolean; defaultShippingFlag?: null | boolean; entityType?: { _info?: {}; id?: null | number; name?: string }; expenseReimbursement?: null | number; faxNumber?: string; id?: number; inactiveFlag?: null | boolean; mobileGuid?: null | string; name: string; phoneNumber?: string; primaryAddressFlag?: null | boolean; stateReference?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string }; zip?: string }>

getCompanyCompaniesByParentIdSitesByIdUsages

  • getCompanyCompaniesByParentIdSitesByIdUsages(id: number, parentId: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyCompaniesByParentIdSitesByIdUsagesList

  • getCompanyCompaniesByParentIdSitesByIdUsagesList(id: number, parentId: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyCompaniesByParentIdSitesCount

  • getCompanyCompaniesByParentIdSitesCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyCompaniesByParentIdSurveysCount

  • getCompanyCompaniesByParentIdSurveysCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyCompaniesByParentIdTeams

  • getCompanyCompaniesByParentIdTeams(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; accountManagerFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; salesFlag?: null | boolean; teamRole?: { _info?: {}; id?: null | number; name?: string }; techFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; accountManagerFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; salesFlag?: null | boolean; teamRole?: { _info?: {}; id?: null | number; name?: string }; techFlag?: null | boolean }[]>

getCompanyCompaniesByParentIdTeamsById

  • getCompanyCompaniesByParentIdTeamsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; accountManagerFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; salesFlag?: null | boolean; teamRole?: { _info?: {}; id?: null | number; name?: string }; techFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; accountManagerFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; salesFlag?: null | boolean; teamRole?: { _info?: {}; id?: null | number; name?: string }; techFlag?: null | boolean }>

getCompanyCompaniesByParentIdTeamsCount

  • getCompanyCompaniesByParentIdTeamsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyCompaniesByParentIdTracks

  • getCompanyCompaniesByParentIdTracks(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; actionRemaining?: null | number; actionTaken?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; endDate?: string; id?: number; name?: string; startDate?: string; startedBy?: string; trackId?: number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; actionRemaining?: null | number; actionTaken?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; endDate?: string; id?: number; name?: string; startDate?: string; startedBy?: string; trackId?: number }[]>

getCompanyCompaniesByParentIdTracksById

  • getCompanyCompaniesByParentIdTracksById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; actionRemaining?: null | number; actionTaken?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; endDate?: string; id?: number; name?: string; startDate?: string; startedBy?: string; trackId?: number }>

  • Parameters

    Returns Promise<{ _info?: {}; actionRemaining?: null | number; actionTaken?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; endDate?: string; id?: number; name?: string; startDate?: string; startedBy?: string; trackId?: number }>

getCompanyCompaniesByParentIdTracksCount

  • getCompanyCompaniesByParentIdTracksCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyCompaniesByParentIdTypeAssociations

  • getCompanyCompaniesByParentIdTypeAssociations(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }[]>

getCompanyCompaniesByParentIdTypeAssociationsById

  • getCompanyCompaniesByParentIdTypeAssociationsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

getCompanyCompaniesByParentIdTypeAssociationsCount

  • getCompanyCompaniesByParentIdTypeAssociationsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyCompaniesCount

  • getCompanyCompaniesCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyCompaniesDefault

  • getCompanyCompaniesDefault(params?: CommonParameters): Promise<{ _info?: {}; accountNumber?: string; addressLine1?: string; addressLine2?: string; annualRevenue?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingContact?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; companyEntityType?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateAcquired?: string; dateDeleted?: string; defaultContact?: { _info?: {}; id?: null | number; name?: string }; deletedBy?: string; deletedFlag?: null | boolean; facebookUrl?: string; faxNumber?: string; id?: number; identifier: string; integratorTags?: string[]; invoiceCCEmailAddress?: string; invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoiceToEmailAddress?: string; isVendorFlag?: null | boolean; leadFlag?: null | boolean; leadSource?: string; linkedInUrl?: string; market?: { _info?: {}; id?: null | number; name?: string }; mobileGuid?: null | string; name: string; numberOfEmployees?: null | number; ownershipType?: { _info?: {}; id?: null | number; name?: string }; parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; phoneNumber?: string; pricingSchedule?: { _info?: {}; id?: null | number; name?: string }; resellerIdentifier?: string; revenueYear?: null | number; sicCode?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxIdentifier?: string; territory?: { _info?: {}; id?: null | number; name?: string }; territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; twitterUrl?: string; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; vendorIdentifier?: string; website?: string; yearEstablished?: null | number; zip?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; accountNumber?: string; addressLine1?: string; addressLine2?: string; annualRevenue?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingContact?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; companyEntityType?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateAcquired?: string; dateDeleted?: string; defaultContact?: { _info?: {}; id?: null | number; name?: string }; deletedBy?: string; deletedFlag?: null | boolean; facebookUrl?: string; faxNumber?: string; id?: number; identifier: string; integratorTags?: string[]; invoiceCCEmailAddress?: string; invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoiceToEmailAddress?: string; isVendorFlag?: null | boolean; leadFlag?: null | boolean; leadSource?: string; linkedInUrl?: string; market?: { _info?: {}; id?: null | number; name?: string }; mobileGuid?: null | string; name: string; numberOfEmployees?: null | number; ownershipType?: { _info?: {}; id?: null | number; name?: string }; parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; phoneNumber?: string; pricingSchedule?: { _info?: {}; id?: null | number; name?: string }; resellerIdentifier?: string; revenueYear?: null | number; sicCode?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxIdentifier?: string; territory?: { _info?: {}; id?: null | number; name?: string }; territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; twitterUrl?: string; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; vendorIdentifier?: string; website?: string; yearEstablished?: null | number; zip?: string }>

getCompanyCompaniesInfoTypes

  • getCompanyCompaniesInfoTypes(params?: CommonParameters): Promise<{ _info?: {}; id?: number; isVendor?: boolean; name?: string }[]>

getCompanyCompaniesInfoTypesById

  • getCompanyCompaniesInfoTypesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; isVendor?: boolean; name?: string }>

getCompanyCompaniesInfoTypesCount

  • getCompanyCompaniesInfoTypesCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyCompaniesStatuses

  • getCompanyCompaniesStatuses(params?: CommonParameters): Promise<{ _info?: {}; cancelOpenTracksFlag?: null | boolean; customNoteFlag?: null | boolean; defaultFlag?: null | boolean; disallowSavingFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; notificationMessage?: string; notifyFlag?: null | boolean; track?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; cancelOpenTracksFlag?: null | boolean; customNoteFlag?: null | boolean; defaultFlag?: null | boolean; disallowSavingFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; notificationMessage?: string; notifyFlag?: null | boolean; track?: { _info?: {}; id?: null | number; name?: string } }[]>

getCompanyCompaniesStatusesById

  • getCompanyCompaniesStatusesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; cancelOpenTracksFlag?: null | boolean; customNoteFlag?: null | boolean; defaultFlag?: null | boolean; disallowSavingFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; notificationMessage?: string; notifyFlag?: null | boolean; track?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; cancelOpenTracksFlag?: null | boolean; customNoteFlag?: null | boolean; defaultFlag?: null | boolean; disallowSavingFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; notificationMessage?: string; notifyFlag?: null | boolean; track?: { _info?: {}; id?: null | number; name?: string } }>

getCompanyCompaniesStatusesByIdUsages

  • getCompanyCompaniesStatusesByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyCompaniesStatusesByIdUsagesList

  • getCompanyCompaniesStatusesByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyCompaniesStatusesCount

  • getCompanyCompaniesStatusesCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyCompaniesTypes

  • getCompanyCompaniesTypes(params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string; vendorFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string; vendorFlag?: null | boolean }[]>

getCompanyCompaniesTypesById

  • getCompanyCompaniesTypesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string; vendorFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string; vendorFlag?: null | boolean }>

getCompanyCompaniesTypesByIdUsages

  • getCompanyCompaniesTypesByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyCompaniesTypesByIdUsagesList

  • getCompanyCompaniesTypesByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyCompaniesTypesCount

  • getCompanyCompaniesTypesCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyCompanyPickerItems

  • getCompanyCompanyPickerItems(params?: CommonParameters): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; companySite?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorPickerFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; companySite?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorPickerFlag?: null | boolean }[]>

getCompanyCompanyPickerItemsById

  • getCompanyCompanyPickerItemsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; companySite?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorPickerFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; companySite?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorPickerFlag?: null | boolean }>

getCompanyCompanyPickerItemsCount

  • getCompanyCompanyPickerItemsCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyCompanyTypeAssociations

  • getCompanyCompanyTypeAssociations(params?: CommonParameters): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }[]>

getCompanyCompanyTypeAssociationsById

  • getCompanyCompanyTypeAssociationsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

getCompanyCompanyTypeAssociationsCount

  • getCompanyCompanyTypeAssociationsCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyConfigurations

  • getCompanyConfigurations(managedIdentifier: string, params?: CommonParameters): Promise<{ _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }[]>

getCompanyConfigurationsById

  • getCompanyConfigurationsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }>

getCompanyConfigurationsCount

  • getCompanyConfigurationsCount(managedIdentifier: string, params?: CommonParameters): Promise<{ count?: number }>

getCompanyConfigurationsStatuses

  • getCompanyConfigurationsStatuses(params?: CommonParameters): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; description: string; id?: number }[]>

getCompanyConfigurationsStatusesById

  • getCompanyConfigurationsStatusesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; description: string; id?: number }>

getCompanyConfigurationsStatusesByIdInfo

  • getCompanyConfigurationsStatusesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; description?: string; id?: number }>

getCompanyConfigurationsStatusesByIdUsages

  • getCompanyConfigurationsStatusesByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyConfigurationsStatusesByIdUsagesList

  • getCompanyConfigurationsStatusesByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyConfigurationsStatusesCount

  • getCompanyConfigurationsStatusesCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyConfigurationsStatusesInfo

  • getCompanyConfigurationsStatusesInfo(params?: CommonParameters): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; description?: string; id?: number }[]>

getCompanyConfigurationsStatusesInfoCount

  • getCompanyConfigurationsStatusesInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyConfigurationsTypes

  • getCompanyConfigurationsTypes(params?: CommonParameters): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; systemFlag?: null | boolean }[]>

getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValues

  • getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValues(parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; question?: { _info?: {}; id?: null | number; question?: string }; value: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; question?: { _info?: {}; id?: null | number; question?: string }; value: string }[]>

getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesById

  • getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesById(id: number, parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; question?: { _info?: {}; id?: null | number; question?: string }; value: string }>

  • Parameters

    Returns Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; question?: { _info?: {}; id?: null | number; question?: string }; value: string }>

getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesByIdUsages

  • getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesByIdUsages(id: number, parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesByIdUsagesList

  • getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesByIdUsagesList(id: number, parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesCount

  • getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesCount(parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyConfigurationsTypesById

  • getCompanyConfigurationsTypesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; systemFlag?: null | boolean }>

getCompanyConfigurationsTypesByIdInfo

  • getCompanyConfigurationsTypesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name?: string; systemFlag?: null | boolean }>

getCompanyConfigurationsTypesByIdUsages

  • getCompanyConfigurationsTypesByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyConfigurationsTypesByIdUsagesList

  • getCompanyConfigurationsTypesByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyConfigurationsTypesByParentIdQuestions

  • getCompanyConfigurationsTypesByParentIdQuestions(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question: string; requiredFlag?: null | boolean; sequenceNumber: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question: string; requiredFlag?: null | boolean; sequenceNumber: null | number }[]>

getCompanyConfigurationsTypesByParentIdQuestionsById

  • getCompanyConfigurationsTypesByParentIdQuestionsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question: string; requiredFlag?: null | boolean; sequenceNumber: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question: string; requiredFlag?: null | boolean; sequenceNumber: null | number }>

getCompanyConfigurationsTypesByParentIdQuestionsCount

  • getCompanyConfigurationsTypesByParentIdQuestionsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyConfigurationsTypesCount

  • getCompanyConfigurationsTypesCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyContactTypeAssociations

  • getCompanyContactTypeAssociations(params?: CommonParameters): Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }[]>

getCompanyContactTypeAssociationsById

  • getCompanyContactTypeAssociationsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

getCompanyContactTypeAssociationsCount

  • getCompanyContactTypeAssociationsCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyContacts

  • getCompanyContacts(params?: CommonParameters): Promise<{ _info?: {}; addressLine1?: string; addressLine2?: string; anniversary?: string; assistantContact?: { _info?: {}; id?: null | number; name?: string }; birthDay?: string; children?: string; childrenFlag?: null | boolean; city?: string; communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultBillingFlag?: null | boolean; defaultFlag?: null | boolean; defaultMergeContactId?: null | number; defaultPhoneExtension?: string; defaultPhoneNbr?: string; defaultPhoneType?: string; department?: { _info?: {}; id?: null | number; name?: string }; disablePortalLoginFlag?: null | boolean; facebookUrl?: string; firstName?: string; gender?: null | "Female" | "Male"; id?: number; ignoreDuplicates?: boolean; inactiveFlag?: null | boolean; integratorTags?: string[]; lastName?: string; linkedInUrl?: string; managerContact?: { _info?: {}; id?: null | number; name?: string }; marriedFlag?: null | boolean; mobileGuid?: null | string; nickName?: string; photo?: { _info?: {}; id?: null | number; name?: string }; portalPassword?: string; portalSecurityLevel?: null | number; presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"; relationship?: { _info?: {}; id?: null | number; name?: string }; relationshipOverride?: string; school?: string; securityIdentifier?: string; significantOther?: string; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; title?: string; twitterUrl?: string; typeIds?: number[]; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; zip?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; addressLine1?: string; addressLine2?: string; anniversary?: string; assistantContact?: { _info?: {}; id?: null | number; name?: string }; birthDay?: string; children?: string; childrenFlag?: null | boolean; city?: string; communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultBillingFlag?: null | boolean; defaultFlag?: null | boolean; defaultMergeContactId?: null | number; defaultPhoneExtension?: string; defaultPhoneNbr?: string; defaultPhoneType?: string; department?: { _info?: {}; id?: null | number; name?: string }; disablePortalLoginFlag?: null | boolean; facebookUrl?: string; firstName?: string; gender?: null | "Female" | "Male"; id?: number; ignoreDuplicates?: boolean; inactiveFlag?: null | boolean; integratorTags?: string[]; lastName?: string; linkedInUrl?: string; managerContact?: { _info?: {}; id?: null | number; name?: string }; marriedFlag?: null | boolean; mobileGuid?: null | string; nickName?: string; photo?: { _info?: {}; id?: null | number; name?: string }; portalPassword?: string; portalSecurityLevel?: null | number; presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"; relationship?: { _info?: {}; id?: null | number; name?: string }; relationshipOverride?: string; school?: string; securityIdentifier?: string; significantOther?: string; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; title?: string; twitterUrl?: string; typeIds?: number[]; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; zip?: string }[]>

getCompanyContactsById

  • getCompanyContactsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; addressLine1?: string; addressLine2?: string; anniversary?: string; assistantContact?: { _info?: {}; id?: null | number; name?: string }; birthDay?: string; children?: string; childrenFlag?: null | boolean; city?: string; communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultBillingFlag?: null | boolean; defaultFlag?: null | boolean; defaultMergeContactId?: null | number; defaultPhoneExtension?: string; defaultPhoneNbr?: string; defaultPhoneType?: string; department?: { _info?: {}; id?: null | number; name?: string }; disablePortalLoginFlag?: null | boolean; facebookUrl?: string; firstName?: string; gender?: null | "Female" | "Male"; id?: number; ignoreDuplicates?: boolean; inactiveFlag?: null | boolean; integratorTags?: string[]; lastName?: string; linkedInUrl?: string; managerContact?: { _info?: {}; id?: null | number; name?: string }; marriedFlag?: null | boolean; mobileGuid?: null | string; nickName?: string; photo?: { _info?: {}; id?: null | number; name?: string }; portalPassword?: string; portalSecurityLevel?: null | number; presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"; relationship?: { _info?: {}; id?: null | number; name?: string }; relationshipOverride?: string; school?: string; securityIdentifier?: string; significantOther?: string; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; title?: string; twitterUrl?: string; typeIds?: number[]; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; zip?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; addressLine1?: string; addressLine2?: string; anniversary?: string; assistantContact?: { _info?: {}; id?: null | number; name?: string }; birthDay?: string; children?: string; childrenFlag?: null | boolean; city?: string; communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultBillingFlag?: null | boolean; defaultFlag?: null | boolean; defaultMergeContactId?: null | number; defaultPhoneExtension?: string; defaultPhoneNbr?: string; defaultPhoneType?: string; department?: { _info?: {}; id?: null | number; name?: string }; disablePortalLoginFlag?: null | boolean; facebookUrl?: string; firstName?: string; gender?: null | "Female" | "Male"; id?: number; ignoreDuplicates?: boolean; inactiveFlag?: null | boolean; integratorTags?: string[]; lastName?: string; linkedInUrl?: string; managerContact?: { _info?: {}; id?: null | number; name?: string }; marriedFlag?: null | boolean; mobileGuid?: null | string; nickName?: string; photo?: { _info?: {}; id?: null | number; name?: string }; portalPassword?: string; portalSecurityLevel?: null | number; presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"; relationship?: { _info?: {}; id?: null | number; name?: string }; relationshipOverride?: string; school?: string; securityIdentifier?: string; significantOther?: string; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; title?: string; twitterUrl?: string; typeIds?: number[]; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; zip?: string }>

getCompanyContactsByIdImage

  • getCompanyContactsByIdImage(id: number, useDefaultFlag: boolean, lastModified: string, params?: CommonParameters): Promise<Buffer>

getCompanyContactsByIdPortalSecurity

  • getCompanyContactsByIdPortalSecurity(id: number, params?: CommonParameters): Promise<{ enabled?: null | boolean; identifier?: string }[]>

getCompanyContactsByIdUsages

  • getCompanyContactsByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyContactsByIdUsagesList

  • getCompanyContactsByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyContactsByParentIdCommunications

  • getCompanyContactsByParentIdCommunications(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; communicationType?: null | "Email" | "Fax" | "Phone"; contactId?: null | number; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; mobileGuid?: null | string; type?: { _info?: {}; id?: null | number; name?: string }; value: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; communicationType?: null | "Email" | "Fax" | "Phone"; contactId?: null | number; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; mobileGuid?: null | string; type?: { _info?: {}; id?: null | number; name?: string }; value: string }[]>

getCompanyContactsByParentIdCommunicationsById

  • getCompanyContactsByParentIdCommunicationsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; communicationType?: null | "Email" | "Fax" | "Phone"; contactId?: null | number; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; mobileGuid?: null | string; type?: { _info?: {}; id?: null | number; name?: string }; value: string }>

  • Parameters

    Returns Promise<{ _info?: {}; communicationType?: null | "Email" | "Fax" | "Phone"; contactId?: null | number; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; mobileGuid?: null | string; type?: { _info?: {}; id?: null | number; name?: string }; value: string }>

getCompanyContactsByParentIdCommunicationsCount

  • getCompanyContactsByParentIdCommunicationsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyContactsByParentIdGroups

  • getCompanyContactsByParentIdGroups(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; companyGroupUnsubscribedEmailMessage?: string; companyUnsubcribedEmailMessage?: string; contact?: { _info?: {}; id?: null | number; name?: string }; contactGroupUnsubscribedEmailMessage?: string; contactUnsubscribedEmailMessage?: string; description?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; unsubscribeFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; companyGroupUnsubscribedEmailMessage?: string; companyUnsubcribedEmailMessage?: string; contact?: { _info?: {}; id?: null | number; name?: string }; contactGroupUnsubscribedEmailMessage?: string; contactUnsubscribedEmailMessage?: string; description?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; unsubscribeFlag?: null | boolean }[]>

getCompanyContactsByParentIdGroupsById

  • getCompanyContactsByParentIdGroupsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; companyGroupUnsubscribedEmailMessage?: string; companyUnsubcribedEmailMessage?: string; contact?: { _info?: {}; id?: null | number; name?: string }; contactGroupUnsubscribedEmailMessage?: string; contactUnsubscribedEmailMessage?: string; description?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; unsubscribeFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; companyGroupUnsubscribedEmailMessage?: string; companyUnsubcribedEmailMessage?: string; contact?: { _info?: {}; id?: null | number; name?: string }; contactGroupUnsubscribedEmailMessage?: string; contactUnsubscribedEmailMessage?: string; description?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; unsubscribeFlag?: null | boolean }>

getCompanyContactsByParentIdGroupsCount

  • getCompanyContactsByParentIdGroupsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyContactsByParentIdNotes

  • getCompanyContactsByParentIdNotes(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; contactId?: null | number; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; contactId?: null | number; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }[]>

getCompanyContactsByParentIdNotesById

  • getCompanyContactsByParentIdNotesById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; contactId?: null | number; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; contactId?: null | number; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

getCompanyContactsByParentIdNotesCount

  • getCompanyContactsByParentIdNotesCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyContactsByParentIdTracks

  • getCompanyContactsByParentIdTracks(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; actionRemaining?: null | number; actionTaken?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; endDate?: string; id?: number; name?: string; startDate?: string; startedBy?: string; trackId?: number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; actionRemaining?: null | number; actionTaken?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; endDate?: string; id?: number; name?: string; startDate?: string; startedBy?: string; trackId?: number }[]>

getCompanyContactsByParentIdTracksById

  • getCompanyContactsByParentIdTracksById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; actionRemaining?: null | number; actionTaken?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; endDate?: string; id?: number; name?: string; startDate?: string; startedBy?: string; trackId?: number }>

  • Parameters

    Returns Promise<{ _info?: {}; actionRemaining?: null | number; actionTaken?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; endDate?: string; id?: number; name?: string; startDate?: string; startedBy?: string; trackId?: number }>

getCompanyContactsByParentIdTracksCount

  • getCompanyContactsByParentIdTracksCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyContactsByParentIdTypeAssociations

  • getCompanyContactsByParentIdTypeAssociations(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }[]>

getCompanyContactsByParentIdTypeAssociationsById

  • getCompanyContactsByParentIdTypeAssociationsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

getCompanyContactsByParentIdTypeAssociationsCount

  • getCompanyContactsByParentIdTypeAssociationsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyContactsCount

getCompanyContactsDefault

  • getCompanyContactsDefault(companyId: number, params?: CommonParameters): Promise<{ _info?: {}; addressLine1?: string; addressLine2?: string; anniversary?: string; assistantContact?: { _info?: {}; id?: null | number; name?: string }; birthDay?: string; children?: string; childrenFlag?: null | boolean; city?: string; communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultBillingFlag?: null | boolean; defaultFlag?: null | boolean; defaultMergeContactId?: null | number; defaultPhoneExtension?: string; defaultPhoneNbr?: string; defaultPhoneType?: string; department?: { _info?: {}; id?: null | number; name?: string }; disablePortalLoginFlag?: null | boolean; facebookUrl?: string; firstName?: string; gender?: null | "Female" | "Male"; id?: number; ignoreDuplicates?: boolean; inactiveFlag?: null | boolean; integratorTags?: string[]; lastName?: string; linkedInUrl?: string; managerContact?: { _info?: {}; id?: null | number; name?: string }; marriedFlag?: null | boolean; mobileGuid?: null | string; nickName?: string; photo?: { _info?: {}; id?: null | number; name?: string }; portalPassword?: string; portalSecurityLevel?: null | number; presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"; relationship?: { _info?: {}; id?: null | number; name?: string }; relationshipOverride?: string; school?: string; securityIdentifier?: string; significantOther?: string; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; title?: string; twitterUrl?: string; typeIds?: number[]; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; zip?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; addressLine1?: string; addressLine2?: string; anniversary?: string; assistantContact?: { _info?: {}; id?: null | number; name?: string }; birthDay?: string; children?: string; childrenFlag?: null | boolean; city?: string; communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultBillingFlag?: null | boolean; defaultFlag?: null | boolean; defaultMergeContactId?: null | number; defaultPhoneExtension?: string; defaultPhoneNbr?: string; defaultPhoneType?: string; department?: { _info?: {}; id?: null | number; name?: string }; disablePortalLoginFlag?: null | boolean; facebookUrl?: string; firstName?: string; gender?: null | "Female" | "Male"; id?: number; ignoreDuplicates?: boolean; inactiveFlag?: null | boolean; integratorTags?: string[]; lastName?: string; linkedInUrl?: string; managerContact?: { _info?: {}; id?: null | number; name?: string }; marriedFlag?: null | boolean; mobileGuid?: null | string; nickName?: string; photo?: { _info?: {}; id?: null | number; name?: string }; portalPassword?: string; portalSecurityLevel?: null | number; presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"; relationship?: { _info?: {}; id?: null | number; name?: string }; relationshipOverride?: string; school?: string; securityIdentifier?: string; significantOther?: string; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; title?: string; twitterUrl?: string; typeIds?: number[]; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; zip?: string }>

getCompanyContactsDepartments

  • getCompanyContactsDepartments(params?: CommonParameters): Promise<{ _info?: {}; id?: number; name: string }[]>

getCompanyContactsDepartmentsById

  • getCompanyContactsDepartmentsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name: string }>

getCompanyContactsDepartmentsByIdInfo

  • getCompanyContactsDepartmentsByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }>

getCompanyContactsDepartmentsByIdUsages

  • getCompanyContactsDepartmentsByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyContactsDepartmentsByIdUsagesList

  • getCompanyContactsDepartmentsByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyContactsDepartmentsCount

  • getCompanyContactsDepartmentsCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyContactsDepartmentsInfo

  • getCompanyContactsDepartmentsInfo(params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }[]>

getCompanyContactsDepartmentsInfoCount

  • getCompanyContactsDepartmentsInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyContactsRelationships

  • getCompanyContactsRelationships(params?: CommonParameters): Promise<{ _info?: {}; id?: number; name: string }[]>

getCompanyContactsRelationshipsById

  • getCompanyContactsRelationshipsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name: string }>

getCompanyContactsRelationshipsCount

  • getCompanyContactsRelationshipsCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyContactsTypes

  • getCompanyContactsTypes(params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }[]>

getCompanyContactsTypesById

  • getCompanyContactsTypesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }>

getCompanyContactsTypesByIdInfo

  • getCompanyContactsTypesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; description?: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; description?: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }>

getCompanyContactsTypesCount

  • getCompanyContactsTypesCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyContactsTypesCountInfo

  • getCompanyContactsTypesCountInfo(params?: CommonParameters): Promise<{ count?: number }>

getCompanyContactsTypesInfo

  • getCompanyContactsTypesInfo(params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; description?: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; description?: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }[]>

getCompanyCountries

  • getCompanyCountries(params?: CommonParameters): Promise<{ _info?: {}; addressFormat?: { _info?: {}; id?: null | number; name?: string }; cityCaption?: string; countryCode?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; localizationValueOne?: string; name: string; stateCaption?: string; zipCaption?: string; zipMinimumLength?: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; addressFormat?: { _info?: {}; id?: null | number; name?: string }; cityCaption?: string; countryCode?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; localizationValueOne?: string; name: string; stateCaption?: string; zipCaption?: string; zipMinimumLength?: null | number }[]>

getCompanyCountriesById

  • getCompanyCountriesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; addressFormat?: { _info?: {}; id?: null | number; name?: string }; cityCaption?: string; countryCode?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; localizationValueOne?: string; name: string; stateCaption?: string; zipCaption?: string; zipMinimumLength?: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; addressFormat?: { _info?: {}; id?: null | number; name?: string }; cityCaption?: string; countryCode?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; localizationValueOne?: string; name: string; stateCaption?: string; zipCaption?: string; zipMinimumLength?: null | number }>

getCompanyCountriesByIdInfo

  • getCompanyCountriesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; cityCaption?: string; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; name?: string; stateCaption?: string; zipCaption?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; cityCaption?: string; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; name?: string; stateCaption?: string; zipCaption?: string }>

getCompanyCountriesCount

  • getCompanyCountriesCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyCountriesInfo

  • getCompanyCountriesInfo(params?: CommonParameters): Promise<{ _info?: {}; cityCaption?: string; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; name?: string; stateCaption?: string; zipCaption?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; cityCaption?: string; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; name?: string; stateCaption?: string; zipCaption?: string }[]>

getCompanyCountriesInfoCount

  • getCompanyCountriesInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyEntityTypes

  • getCompanyEntityTypes(params?: CommonParameters): Promise<{ code?: string; id?: number; name?: string }[]>

getCompanyEntityTypesById

  • getCompanyEntityTypesById(id: number, params?: CommonParameters): Promise<{ code?: string; id?: number; name?: string }>

getCompanyEntityTypesCount

  • getCompanyEntityTypesCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyEntityTypesInfoCount

  • getCompanyEntityTypesInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyEntitytypesByIdInfo

  • getCompanyEntitytypesByIdInfo(id: number, params?: CommonParameters): Promise<{ id?: number; name?: string }>

getCompanyEntitytypesInfo

  • getCompanyEntitytypesInfo(params?: CommonParameters): Promise<{ id?: number; name?: string }[]>

getCompanyExpenseTypesInfoCount

  • getCompanyExpenseTypesInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyManagedDevicesIntegrations

  • getCompanyManagedDevicesIntegrations(params?: CommonParameters): Promise<{ _info?: {}; configBillCustomerFlag?: null | boolean; defaultBillingLevel: null | "Detail" | "Summary"; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; disableNewCrossReferencesFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; loginBy: null | "Global" | "Member"; managementItSetupType?: string; matchOnSerialNumberFlag?: null | boolean; name: string; portalUrl?: string; solution: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; configBillCustomerFlag?: null | boolean; defaultBillingLevel: null | "Detail" | "Summary"; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; disableNewCrossReferencesFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; loginBy: null | "Global" | "Member"; managementItSetupType?: string; matchOnSerialNumberFlag?: null | boolean; name: string; portalUrl?: string; solution: string }[]>

getCompanyManagedDevicesIntegrationsById

  • getCompanyManagedDevicesIntegrationsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; configBillCustomerFlag?: null | boolean; defaultBillingLevel: null | "Detail" | "Summary"; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; disableNewCrossReferencesFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; loginBy: null | "Global" | "Member"; managementItSetupType?: string; matchOnSerialNumberFlag?: null | boolean; name: string; portalUrl?: string; solution: string }>

  • Parameters

    Returns Promise<{ _info?: {}; configBillCustomerFlag?: null | boolean; defaultBillingLevel: null | "Detail" | "Summary"; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; disableNewCrossReferencesFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; loginBy: null | "Global" | "Member"; managementItSetupType?: string; matchOnSerialNumberFlag?: null | boolean; name: string; portalUrl?: string; solution: string }>

getCompanyManagedDevicesIntegrationsByIdInfo

  • getCompanyManagedDevicesIntegrationsByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; managementItSetupType?: string; name?: string; solution?: string }>

getCompanyManagedDevicesIntegrationsByIdUsages

  • getCompanyManagedDevicesIntegrationsByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyManagedDevicesIntegrationsByIdUsagesList

  • getCompanyManagedDevicesIntegrationsByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyManagedDevicesIntegrationsByParentIdCrossReferences

  • getCompanyManagedDevicesIntegrationsByParentIdCrossReferences(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; vendorLevel?: string; vendorType?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; vendorLevel?: string; vendorType?: string }[]>

getCompanyManagedDevicesIntegrationsByParentIdCrossReferencesById

  • getCompanyManagedDevicesIntegrationsByParentIdCrossReferencesById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; vendorLevel?: string; vendorType?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; vendorLevel?: string; vendorType?: string }>

getCompanyManagedDevicesIntegrationsByParentIdCrossReferencesCount

  • getCompanyManagedDevicesIntegrationsByParentIdCrossReferencesCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyManagedDevicesIntegrationsByParentIdLogins

  • getCompanyManagedDevicesIntegrationsByParentIdLogins(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; password?: string; username: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; password?: string; username: string }[]>

getCompanyManagedDevicesIntegrationsByParentIdLoginsById

  • getCompanyManagedDevicesIntegrationsByParentIdLoginsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; password?: string; username: string }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; password?: string; username: string }>

getCompanyManagedDevicesIntegrationsByParentIdLoginsCount

  • getCompanyManagedDevicesIntegrationsByParentIdLoginsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyManagedDevicesIntegrationsByParentIdNotifications

  • getCompanyManagedDevicesIntegrationsByParentIdNotifications(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

getCompanyManagedDevicesIntegrationsByParentIdNotificationsById

  • getCompanyManagedDevicesIntegrationsByParentIdNotificationsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

getCompanyManagedDevicesIntegrationsByParentIdNotificationsCount

  • getCompanyManagedDevicesIntegrationsByParentIdNotificationsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyManagedDevicesIntegrationsCount

  • getCompanyManagedDevicesIntegrationsCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyManagedDevicesIntegrationsInfo

  • getCompanyManagedDevicesIntegrationsInfo(params?: CommonParameters): Promise<{ _info?: {}; id?: number; managementItSetupType?: string; name?: string; solution?: string }[]>

getCompanyManagedDevicesIntegrationsInfoCount

  • getCompanyManagedDevicesIntegrationsInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyManagement

  • getCompanyManagement(params?: CommonParameters): Promise<{ _info?: {}; addedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; deletedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; executiveSummaryReportScheduleDay?: null | number; executiveSummaryReportScheduleHour?: null | number; executiveSummaryReportScheduleMinute?: null | number; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; runTime?: string; scheduleExecutiveSummaryReportFlag: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; addedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; deletedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; executiveSummaryReportScheduleDay?: null | number; executiveSummaryReportScheduleHour?: null | number; executiveSummaryReportScheduleMinute?: null | number; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; runTime?: string; scheduleExecutiveSummaryReportFlag: null | boolean }[]>

getCompanyManagementBackups

  • getCompanyManagementBackups(params?: CommonParameters): Promise<{ _info?: {}; billingLevel: null | "Detail" | "Summary"; id?: number; item?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; billingLevel: null | "Detail" | "Summary"; id?: number; item?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }[]>

getCompanyManagementBackupsById

  • getCompanyManagementBackupsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; billingLevel: null | "Detail" | "Summary"; id?: number; item?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; billingLevel: null | "Detail" | "Summary"; id?: number; item?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

getCompanyManagementBackupsCount

  • getCompanyManagementBackupsCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyManagementById

  • getCompanyManagementById(id: number, params?: CommonParameters): Promise<{ _info?: {}; addedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; deletedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; executiveSummaryReportScheduleDay?: null | number; executiveSummaryReportScheduleHour?: null | number; executiveSummaryReportScheduleMinute?: null | number; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; runTime?: string; scheduleExecutiveSummaryReportFlag: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; addedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; deletedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; executiveSummaryReportScheduleDay?: null | number; executiveSummaryReportScheduleHour?: null | number; executiveSummaryReportScheduleMinute?: null | number; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; runTime?: string; scheduleExecutiveSummaryReportFlag: null | boolean }>

getCompanyManagementByIdLogDownload

  • getCompanyManagementByIdLogDownload(id: number, filePath: string, params?: CommonParameters): Promise<Buffer>

getCompanyManagementByIdLogs

  • getCompanyManagementByIdLogs(id: number, params?: CommonParameters): Promise<{ fileSize?: string; fullPathFileName?: string }[]>

getCompanyManagementByParentIdManagementReportNotifications

  • getCompanyManagementByParentIdManagementReportNotifications(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

getCompanyManagementByParentIdManagementReportNotificationsById

  • getCompanyManagementByParentIdManagementReportNotificationsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

getCompanyManagementByParentIdManagementReportNotificationsCount

  • getCompanyManagementByParentIdManagementReportNotificationsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyManagementCount

  • getCompanyManagementCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyManagementItSolutions

  • getCompanyManagementItSolutions(params?: CommonParameters): Promise<{ _info?: {}; continuumApiPassword?: string; continuumApiUsername?: string; globalLoginFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; levelApiPassword?: string; levelApiUsername?: string; levelVarDomain?: string; managementItSolutionType: null | "LevelPlatforms" | "NAble" | "Continuum" | "Custom"; managementServerUrl?: string; managementSolutionName?: string; nAblePassword?: string; nAbleUsername?: string; name: string; noDisplayFlag?: null | boolean; overrideLoginLocationFlag?: null | boolean; overrideWebServiceLocationFlag?: null | boolean; portalOverrideLoginUrl?: string; usingSslFlag?: null | boolean; webserviceOverrideUrl?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; continuumApiPassword?: string; continuumApiUsername?: string; globalLoginFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; levelApiPassword?: string; levelApiUsername?: string; levelVarDomain?: string; managementItSolutionType: null | "LevelPlatforms" | "NAble" | "Continuum" | "Custom"; managementServerUrl?: string; managementSolutionName?: string; nAblePassword?: string; nAbleUsername?: string; name: string; noDisplayFlag?: null | boolean; overrideLoginLocationFlag?: null | boolean; overrideWebServiceLocationFlag?: null | boolean; portalOverrideLoginUrl?: string; usingSslFlag?: null | boolean; webserviceOverrideUrl?: string }[]>

getCompanyManagementItSolutionsById

  • getCompanyManagementItSolutionsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; continuumApiPassword?: string; continuumApiUsername?: string; globalLoginFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; levelApiPassword?: string; levelApiUsername?: string; levelVarDomain?: string; managementItSolutionType: null | "LevelPlatforms" | "NAble" | "Continuum" | "Custom"; managementServerUrl?: string; managementSolutionName?: string; nAblePassword?: string; nAbleUsername?: string; name: string; noDisplayFlag?: null | boolean; overrideLoginLocationFlag?: null | boolean; overrideWebServiceLocationFlag?: null | boolean; portalOverrideLoginUrl?: string; usingSslFlag?: null | boolean; webserviceOverrideUrl?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; continuumApiPassword?: string; continuumApiUsername?: string; globalLoginFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; levelApiPassword?: string; levelApiUsername?: string; levelVarDomain?: string; managementItSolutionType: null | "LevelPlatforms" | "NAble" | "Continuum" | "Custom"; managementServerUrl?: string; managementSolutionName?: string; nAblePassword?: string; nAbleUsername?: string; name: string; noDisplayFlag?: null | boolean; overrideLoginLocationFlag?: null | boolean; overrideWebServiceLocationFlag?: null | boolean; portalOverrideLoginUrl?: string; usingSslFlag?: null | boolean; webserviceOverrideUrl?: string }>

getCompanyManagementItSolutionsByIdUsages

  • getCompanyManagementItSolutionsByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyManagementItSolutionsByIdUsagesList

  • getCompanyManagementItSolutionsByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyManagementItSolutionsByParentIdManagementProducts

  • getCompanyManagementItSolutionsByParentIdManagementProducts(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean } }[]>

getCompanyManagementItSolutionsByParentIdManagementProductsById

  • getCompanyManagementItSolutionsByParentIdManagementProductsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean } }>

  • Parameters

    Returns Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean } }>

getCompanyManagementItSolutionsByParentIdManagementProductsCount

  • getCompanyManagementItSolutionsByParentIdManagementProductsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyManagementItSolutionsCount

  • getCompanyManagementItSolutionsCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyMarketDescriptions

  • getCompanyMarketDescriptions(params?: CommonParameters): Promise<{ _info?: {}; id?: number; name: string }[]>

getCompanyMarketDescriptionsById

  • getCompanyMarketDescriptionsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name: string }>

getCompanyMarketDescriptionsByIdInfo

  • getCompanyMarketDescriptionsByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }>

getCompanyMarketDescriptionsByIdUsages

  • getCompanyMarketDescriptionsByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyMarketDescriptionsByIdUsagesList

  • getCompanyMarketDescriptionsByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyMarketDescriptionsCount

  • getCompanyMarketDescriptionsCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyMarketDescriptionsInfo

  • getCompanyMarketDescriptionsInfo(params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }[]>

getCompanyMarketDescriptionsInfoCount

  • getCompanyMarketDescriptionsInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyNoteTypes

  • getCompanyNoteTypes(params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; identifier?: string; importFlag?: null | boolean; name: string }[]>

getCompanyNoteTypesById

  • getCompanyNoteTypesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; identifier?: string; importFlag?: null | boolean; name: string }>

  • Parameters

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; identifier?: string; importFlag?: null | boolean; name: string }>

getCompanyNoteTypesByIdInfo

  • getCompanyNoteTypesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; identifier?: string; name?: string }>

getCompanyNoteTypesCount

  • getCompanyNoteTypesCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyNoteTypesCountInfo

  • getCompanyNoteTypesCountInfo(params?: CommonParameters): Promise<{ count?: number }>

getCompanyNoteTypesInfo

  • getCompanyNoteTypesInfo(params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; identifier?: string; name?: string }[]>

getCompanyOwnershipTypes

  • getCompanyOwnershipTypes(params?: CommonParameters): Promise<{ _info?: {}; id?: number; name: string }[]>

getCompanyOwnershipTypesById

  • getCompanyOwnershipTypesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name: string }>

getCompanyOwnershipTypesByIdInfo

  • getCompanyOwnershipTypesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }>

getCompanyOwnershipTypesCount

  • getCompanyOwnershipTypesCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyOwnershipTypesInfo

  • getCompanyOwnershipTypesInfo(params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }[]>

getCompanyOwnershipTypesInfoCount

  • getCompanyOwnershipTypesInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyPaymentTypesInfoCount

  • getCompanyPaymentTypesInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyPortalConfigurations

  • getCompanyPortalConfigurations(params?: CommonParameters): Promise<{ _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }[]>

getCompanyPortalConfigurationsById

  • getCompanyPortalConfigurationsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }>

getCompanyPortalConfigurationsByParentIdInvoiceSetups

  • getCompanyPortalConfigurationsByParentIdInvoiceSetups(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; addAllStatuses?: null | boolean; allowInvPmtFlag?: null | boolean; billingStatusIds?: number[]; displayInvPmtFlag?: null | boolean; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; login?: string; password?: string; paymentProcessor?: { _info?: {}; id?: null | number; name?: string }; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; removeAllStatuses?: null | boolean; urlOverride?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; addAllStatuses?: null | boolean; allowInvPmtFlag?: null | boolean; billingStatusIds?: number[]; displayInvPmtFlag?: null | boolean; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; login?: string; password?: string; paymentProcessor?: { _info?: {}; id?: null | number; name?: string }; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; removeAllStatuses?: null | boolean; urlOverride?: string }[]>

getCompanyPortalConfigurationsByParentIdInvoiceSetupsById

  • getCompanyPortalConfigurationsByParentIdInvoiceSetupsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; addAllStatuses?: null | boolean; allowInvPmtFlag?: null | boolean; billingStatusIds?: number[]; displayInvPmtFlag?: null | boolean; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; login?: string; password?: string; paymentProcessor?: { _info?: {}; id?: null | number; name?: string }; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; removeAllStatuses?: null | boolean; urlOverride?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; addAllStatuses?: null | boolean; allowInvPmtFlag?: null | boolean; billingStatusIds?: number[]; displayInvPmtFlag?: null | boolean; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; login?: string; password?: string; paymentProcessor?: { _info?: {}; id?: null | number; name?: string }; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; removeAllStatuses?: null | boolean; urlOverride?: string }>

getCompanyPortalConfigurationsByParentIdInvoiceSetupsCount

  • getCompanyPortalConfigurationsByParentIdInvoiceSetupsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyPortalConfigurationsByParentIdOpportunitySetups

  • getCompanyPortalConfigurationsByParentIdOpportunitySetups(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; acceptanceChangeStatusFlag?: null | boolean; acceptanceCreateActivityFlag?: null | boolean; acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; acceptanceEmailBody?: string; acceptanceEmailFromFirstName?: string; acceptanceEmailFromLastName?: string; acceptanceEmailSubject?: string; acceptanceFromEmail?: string; acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; acceptanceSendEmailFlag?: null | boolean; addAllOpportunityStatuses?: null | boolean; addAllOpportunityTypes?: null | boolean; confirmationEmailBody?: string; confirmationEmailFromFirstName?: string; confirmationEmailFromLastName?: string; confirmationEmailSubject?: string; confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean; confirmationFromEmail?: string; confirmationSendEmailFlag?: null | boolean; id?: number; opportunityStatusRecIDs?: number[]; opportunityTypeRecIDs?: number[]; rejectionChangeStatusFlag?: null | boolean; rejectionCreateActivityFlag?: null | boolean; rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; rejectionEmailBody?: string; rejectionEmailFromFirstName?: string; rejectionEmailFromLastName?: string; rejectionEmailSubject?: string; rejectionFromEmail?: string; rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; rejectionSendEmailFlag?: null | boolean; removeAllOpportunityStatuses?: null | boolean; removeAllOpportunityTypes?: null | boolean; restrictViewByOpportunityStatusFlag?: null | boolean; restrictViewByOpportunityTypeFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; acceptanceChangeStatusFlag?: null | boolean; acceptanceCreateActivityFlag?: null | boolean; acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; acceptanceEmailBody?: string; acceptanceEmailFromFirstName?: string; acceptanceEmailFromLastName?: string; acceptanceEmailSubject?: string; acceptanceFromEmail?: string; acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; acceptanceSendEmailFlag?: null | boolean; addAllOpportunityStatuses?: null | boolean; addAllOpportunityTypes?: null | boolean; confirmationEmailBody?: string; confirmationEmailFromFirstName?: string; confirmationEmailFromLastName?: string; confirmationEmailSubject?: string; confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean; confirmationFromEmail?: string; confirmationSendEmailFlag?: null | boolean; id?: number; opportunityStatusRecIDs?: number[]; opportunityTypeRecIDs?: number[]; rejectionChangeStatusFlag?: null | boolean; rejectionCreateActivityFlag?: null | boolean; rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; rejectionEmailBody?: string; rejectionEmailFromFirstName?: string; rejectionEmailFromLastName?: string; rejectionEmailSubject?: string; rejectionFromEmail?: string; rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; rejectionSendEmailFlag?: null | boolean; removeAllOpportunityStatuses?: null | boolean; removeAllOpportunityTypes?: null | boolean; restrictViewByOpportunityStatusFlag?: null | boolean; restrictViewByOpportunityTypeFlag?: null | boolean }[]>

getCompanyPortalConfigurationsByParentIdOpportunitySetupsById

  • getCompanyPortalConfigurationsByParentIdOpportunitySetupsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; acceptanceChangeStatusFlag?: null | boolean; acceptanceCreateActivityFlag?: null | boolean; acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; acceptanceEmailBody?: string; acceptanceEmailFromFirstName?: string; acceptanceEmailFromLastName?: string; acceptanceEmailSubject?: string; acceptanceFromEmail?: string; acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; acceptanceSendEmailFlag?: null | boolean; addAllOpportunityStatuses?: null | boolean; addAllOpportunityTypes?: null | boolean; confirmationEmailBody?: string; confirmationEmailFromFirstName?: string; confirmationEmailFromLastName?: string; confirmationEmailSubject?: string; confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean; confirmationFromEmail?: string; confirmationSendEmailFlag?: null | boolean; id?: number; opportunityStatusRecIDs?: number[]; opportunityTypeRecIDs?: number[]; rejectionChangeStatusFlag?: null | boolean; rejectionCreateActivityFlag?: null | boolean; rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; rejectionEmailBody?: string; rejectionEmailFromFirstName?: string; rejectionEmailFromLastName?: string; rejectionEmailSubject?: string; rejectionFromEmail?: string; rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; rejectionSendEmailFlag?: null | boolean; removeAllOpportunityStatuses?: null | boolean; removeAllOpportunityTypes?: null | boolean; restrictViewByOpportunityStatusFlag?: null | boolean; restrictViewByOpportunityTypeFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; acceptanceChangeStatusFlag?: null | boolean; acceptanceCreateActivityFlag?: null | boolean; acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; acceptanceEmailBody?: string; acceptanceEmailFromFirstName?: string; acceptanceEmailFromLastName?: string; acceptanceEmailSubject?: string; acceptanceFromEmail?: string; acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; acceptanceSendEmailFlag?: null | boolean; addAllOpportunityStatuses?: null | boolean; addAllOpportunityTypes?: null | boolean; confirmationEmailBody?: string; confirmationEmailFromFirstName?: string; confirmationEmailFromLastName?: string; confirmationEmailSubject?: string; confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean; confirmationFromEmail?: string; confirmationSendEmailFlag?: null | boolean; id?: number; opportunityStatusRecIDs?: number[]; opportunityTypeRecIDs?: number[]; rejectionChangeStatusFlag?: null | boolean; rejectionCreateActivityFlag?: null | boolean; rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; rejectionEmailBody?: string; rejectionEmailFromFirstName?: string; rejectionEmailFromLastName?: string; rejectionEmailSubject?: string; rejectionFromEmail?: string; rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; rejectionSendEmailFlag?: null | boolean; removeAllOpportunityStatuses?: null | boolean; removeAllOpportunityTypes?: null | boolean; restrictViewByOpportunityStatusFlag?: null | boolean; restrictViewByOpportunityTypeFlag?: null | boolean }>

getCompanyPortalConfigurationsByParentIdPasswordEmailSetups

  • getCompanyPortalConfigurationsByParentIdPasswordEmailSetups(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; invalidPasswordEmailBody?: string; invalidPasswordEmailFromEmail?: string; invalidPasswordEmailFromFirstName?: string; invalidPasswordEmailFromLastName?: string; invalidPasswordEmailSubject?: string; invalidPasswordEmailUseCustomEmailFlag?: null | boolean; validPasswordEmailBody?: string; validPasswordEmailFromEmail?: string; validPasswordEmailFromFirstName?: string; validPasswordEmailFromLastName?: string; validPasswordEmailSubject?: string; validPasswordEmailUseCustomEmailFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; invalidPasswordEmailBody?: string; invalidPasswordEmailFromEmail?: string; invalidPasswordEmailFromFirstName?: string; invalidPasswordEmailFromLastName?: string; invalidPasswordEmailSubject?: string; invalidPasswordEmailUseCustomEmailFlag?: null | boolean; validPasswordEmailBody?: string; validPasswordEmailFromEmail?: string; validPasswordEmailFromFirstName?: string; validPasswordEmailFromLastName?: string; validPasswordEmailSubject?: string; validPasswordEmailUseCustomEmailFlag?: null | boolean }[]>

getCompanyPortalConfigurationsByParentIdPasswordEmailSetupsById

  • getCompanyPortalConfigurationsByParentIdPasswordEmailSetupsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; invalidPasswordEmailBody?: string; invalidPasswordEmailFromEmail?: string; invalidPasswordEmailFromFirstName?: string; invalidPasswordEmailFromLastName?: string; invalidPasswordEmailSubject?: string; invalidPasswordEmailUseCustomEmailFlag?: null | boolean; validPasswordEmailBody?: string; validPasswordEmailFromEmail?: string; validPasswordEmailFromFirstName?: string; validPasswordEmailFromLastName?: string; validPasswordEmailSubject?: string; validPasswordEmailUseCustomEmailFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; invalidPasswordEmailBody?: string; invalidPasswordEmailFromEmail?: string; invalidPasswordEmailFromFirstName?: string; invalidPasswordEmailFromLastName?: string; invalidPasswordEmailSubject?: string; invalidPasswordEmailUseCustomEmailFlag?: null | boolean; validPasswordEmailBody?: string; validPasswordEmailFromEmail?: string; validPasswordEmailFromFirstName?: string; validPasswordEmailFromLastName?: string; validPasswordEmailSubject?: string; validPasswordEmailUseCustomEmailFlag?: null | boolean }>

getCompanyPortalConfigurationsByParentIdProjectSetups

  • getCompanyPortalConfigurationsByParentIdProjectSetups(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; billingMethodFlag?: null | boolean; contactFlag?: null | boolean; descriptionFlag?: null | boolean; estimatedEndFlag?: null | boolean; estimatedStartFlag?: null | boolean; fixedFeeActualFinishFlag?: null | boolean; fixedFeeActualHrsFlag?: null | boolean; fixedFeeActualStartFlag?: null | boolean; fixedFeeAssignedFlag?: null | boolean; fixedFeeBillFlag?: null | boolean; fixedFeeBudgetHrsFlag?: null | boolean; fixedFeeScheduledFinishFlag?: null | boolean; fixedFeeScheduledHrsFlag?: null | boolean; fixedFeeScheduledStartFlag?: null | boolean; fixedFeeStatusFlag?: null | boolean; id?: number; lastUpdatedFlag?: null | boolean; onlyDisplay: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; portalConfig?: { _info?: {}; id?: null | number; name?: string }; projectDetailTotalHoursFlag?: null | boolean; projectIssueActualFinishFlag?: null | boolean; projectIssueActualHrsFlag?: null | boolean; projectIssueActualStartFlag?: null | boolean; projectIssueAssignedFlag?: null | boolean; projectIssueBillFlag?: null | boolean; projectIssueBudgetHrsFlag?: null | boolean; projectIssueScheduledFinishFlag?: null | boolean; projectIssueScheduledHrsFlag?: null | boolean; projectIssueScheduledStartFlag?: null | boolean; projectIssueStatusFlag?: null | boolean; projectManagerFlag?: null | boolean; projectNameFlag?: null | boolean; projectTypeFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialActualFinishFlag?: null | boolean; timeMaterialActualHrsFlag?: null | boolean; timeMaterialActualStartFlag?: null | boolean; timeMaterialAssignedFlag?: null | boolean; timeMaterialBillFlag?: null | boolean; timeMaterialBudgetHrsFlag?: null | boolean; timeMaterialScheduledFinishFlag?: null | boolean; timeMaterialScheduledHrsFlag?: null | boolean; timeMaterialScheduledStartFlag?: null | boolean; timeMaterialStatusFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; billingMethodFlag?: null | boolean; contactFlag?: null | boolean; descriptionFlag?: null | boolean; estimatedEndFlag?: null | boolean; estimatedStartFlag?: null | boolean; fixedFeeActualFinishFlag?: null | boolean; fixedFeeActualHrsFlag?: null | boolean; fixedFeeActualStartFlag?: null | boolean; fixedFeeAssignedFlag?: null | boolean; fixedFeeBillFlag?: null | boolean; fixedFeeBudgetHrsFlag?: null | boolean; fixedFeeScheduledFinishFlag?: null | boolean; fixedFeeScheduledHrsFlag?: null | boolean; fixedFeeScheduledStartFlag?: null | boolean; fixedFeeStatusFlag?: null | boolean; id?: number; lastUpdatedFlag?: null | boolean; onlyDisplay: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; portalConfig?: { _info?: {}; id?: null | number; name?: string }; projectDetailTotalHoursFlag?: null | boolean; projectIssueActualFinishFlag?: null | boolean; projectIssueActualHrsFlag?: null | boolean; projectIssueActualStartFlag?: null | boolean; projectIssueAssignedFlag?: null | boolean; projectIssueBillFlag?: null | boolean; projectIssueBudgetHrsFlag?: null | boolean; projectIssueScheduledFinishFlag?: null | boolean; projectIssueScheduledHrsFlag?: null | boolean; projectIssueScheduledStartFlag?: null | boolean; projectIssueStatusFlag?: null | boolean; projectManagerFlag?: null | boolean; projectNameFlag?: null | boolean; projectTypeFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialActualFinishFlag?: null | boolean; timeMaterialActualHrsFlag?: null | boolean; timeMaterialActualStartFlag?: null | boolean; timeMaterialAssignedFlag?: null | boolean; timeMaterialBillFlag?: null | boolean; timeMaterialBudgetHrsFlag?: null | boolean; timeMaterialScheduledFinishFlag?: null | boolean; timeMaterialScheduledHrsFlag?: null | boolean; timeMaterialScheduledStartFlag?: null | boolean; timeMaterialStatusFlag?: null | boolean }[]>

getCompanyPortalConfigurationsByParentIdProjectSetupsById

  • getCompanyPortalConfigurationsByParentIdProjectSetupsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; billingMethodFlag?: null | boolean; contactFlag?: null | boolean; descriptionFlag?: null | boolean; estimatedEndFlag?: null | boolean; estimatedStartFlag?: null | boolean; fixedFeeActualFinishFlag?: null | boolean; fixedFeeActualHrsFlag?: null | boolean; fixedFeeActualStartFlag?: null | boolean; fixedFeeAssignedFlag?: null | boolean; fixedFeeBillFlag?: null | boolean; fixedFeeBudgetHrsFlag?: null | boolean; fixedFeeScheduledFinishFlag?: null | boolean; fixedFeeScheduledHrsFlag?: null | boolean; fixedFeeScheduledStartFlag?: null | boolean; fixedFeeStatusFlag?: null | boolean; id?: number; lastUpdatedFlag?: null | boolean; onlyDisplay: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; portalConfig?: { _info?: {}; id?: null | number; name?: string }; projectDetailTotalHoursFlag?: null | boolean; projectIssueActualFinishFlag?: null | boolean; projectIssueActualHrsFlag?: null | boolean; projectIssueActualStartFlag?: null | boolean; projectIssueAssignedFlag?: null | boolean; projectIssueBillFlag?: null | boolean; projectIssueBudgetHrsFlag?: null | boolean; projectIssueScheduledFinishFlag?: null | boolean; projectIssueScheduledHrsFlag?: null | boolean; projectIssueScheduledStartFlag?: null | boolean; projectIssueStatusFlag?: null | boolean; projectManagerFlag?: null | boolean; projectNameFlag?: null | boolean; projectTypeFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialActualFinishFlag?: null | boolean; timeMaterialActualHrsFlag?: null | boolean; timeMaterialActualStartFlag?: null | boolean; timeMaterialAssignedFlag?: null | boolean; timeMaterialBillFlag?: null | boolean; timeMaterialBudgetHrsFlag?: null | boolean; timeMaterialScheduledFinishFlag?: null | boolean; timeMaterialScheduledHrsFlag?: null | boolean; timeMaterialScheduledStartFlag?: null | boolean; timeMaterialStatusFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; billingMethodFlag?: null | boolean; contactFlag?: null | boolean; descriptionFlag?: null | boolean; estimatedEndFlag?: null | boolean; estimatedStartFlag?: null | boolean; fixedFeeActualFinishFlag?: null | boolean; fixedFeeActualHrsFlag?: null | boolean; fixedFeeActualStartFlag?: null | boolean; fixedFeeAssignedFlag?: null | boolean; fixedFeeBillFlag?: null | boolean; fixedFeeBudgetHrsFlag?: null | boolean; fixedFeeScheduledFinishFlag?: null | boolean; fixedFeeScheduledHrsFlag?: null | boolean; fixedFeeScheduledStartFlag?: null | boolean; fixedFeeStatusFlag?: null | boolean; id?: number; lastUpdatedFlag?: null | boolean; onlyDisplay: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; portalConfig?: { _info?: {}; id?: null | number; name?: string }; projectDetailTotalHoursFlag?: null | boolean; projectIssueActualFinishFlag?: null | boolean; projectIssueActualHrsFlag?: null | boolean; projectIssueActualStartFlag?: null | boolean; projectIssueAssignedFlag?: null | boolean; projectIssueBillFlag?: null | boolean; projectIssueBudgetHrsFlag?: null | boolean; projectIssueScheduledFinishFlag?: null | boolean; projectIssueScheduledHrsFlag?: null | boolean; projectIssueScheduledStartFlag?: null | boolean; projectIssueStatusFlag?: null | boolean; projectManagerFlag?: null | boolean; projectNameFlag?: null | boolean; projectTypeFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialActualFinishFlag?: null | boolean; timeMaterialActualHrsFlag?: null | boolean; timeMaterialActualStartFlag?: null | boolean; timeMaterialAssignedFlag?: null | boolean; timeMaterialBillFlag?: null | boolean; timeMaterialBudgetHrsFlag?: null | boolean; timeMaterialScheduledFinishFlag?: null | boolean; timeMaterialScheduledHrsFlag?: null | boolean; timeMaterialScheduledStartFlag?: null | boolean; timeMaterialStatusFlag?: null | boolean }>

getCompanyPortalConfigurationsByParentIdProjectSetupsCount

  • getCompanyPortalConfigurationsByParentIdProjectSetupsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyPortalConfigurationsByParentIdServiceSetups

  • getCompanyPortalConfigurationsByParentIdServiceSetups(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; actualHoursFlag?: null | boolean; approvalStatusFlag?: null | boolean; assignedResourcesFlag?: null | boolean; budgetHoursFlag?: null | boolean; closedTasksFlag?: null | boolean; contactFlag?: null | boolean; displayClosedTicketsOption: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; enableChatAssistFlag?: null | boolean; enteredDateFlag?: null | boolean; fixedFeeTicketTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; lastUpdateFlag?: null | boolean; openTasksFlag?: null | boolean; requiredDateFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceSubTypeFlag?: null | boolean; serviceSubTypeItemFlag?: null | boolean; serviceTypeFlag?: null | boolean; siteNameFlag?: null | boolean; slaInfoFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialsTicketTemplate?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; actualHoursFlag?: null | boolean; approvalStatusFlag?: null | boolean; assignedResourcesFlag?: null | boolean; budgetHoursFlag?: null | boolean; closedTasksFlag?: null | boolean; contactFlag?: null | boolean; displayClosedTicketsOption: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; enableChatAssistFlag?: null | boolean; enteredDateFlag?: null | boolean; fixedFeeTicketTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; lastUpdateFlag?: null | boolean; openTasksFlag?: null | boolean; requiredDateFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceSubTypeFlag?: null | boolean; serviceSubTypeItemFlag?: null | boolean; serviceTypeFlag?: null | boolean; siteNameFlag?: null | boolean; slaInfoFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialsTicketTemplate?: { _info?: {}; id?: null | number; name?: string } }[]>

getCompanyPortalConfigurationsByParentIdServiceSetupsById

  • getCompanyPortalConfigurationsByParentIdServiceSetupsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; actualHoursFlag?: null | boolean; approvalStatusFlag?: null | boolean; assignedResourcesFlag?: null | boolean; budgetHoursFlag?: null | boolean; closedTasksFlag?: null | boolean; contactFlag?: null | boolean; displayClosedTicketsOption: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; enableChatAssistFlag?: null | boolean; enteredDateFlag?: null | boolean; fixedFeeTicketTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; lastUpdateFlag?: null | boolean; openTasksFlag?: null | boolean; requiredDateFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceSubTypeFlag?: null | boolean; serviceSubTypeItemFlag?: null | boolean; serviceTypeFlag?: null | boolean; siteNameFlag?: null | boolean; slaInfoFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialsTicketTemplate?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; actualHoursFlag?: null | boolean; approvalStatusFlag?: null | boolean; assignedResourcesFlag?: null | boolean; budgetHoursFlag?: null | boolean; closedTasksFlag?: null | boolean; contactFlag?: null | boolean; displayClosedTicketsOption: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; enableChatAssistFlag?: null | boolean; enteredDateFlag?: null | boolean; fixedFeeTicketTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; lastUpdateFlag?: null | boolean; openTasksFlag?: null | boolean; requiredDateFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceSubTypeFlag?: null | boolean; serviceSubTypeItemFlag?: null | boolean; serviceTypeFlag?: null | boolean; siteNameFlag?: null | boolean; slaInfoFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialsTicketTemplate?: { _info?: {}; id?: null | number; name?: string } }>

getCompanyPortalConfigurationsByParentIdServiceSetupsCount

  • getCompanyPortalConfigurationsByParentIdServiceSetupsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyPortalConfigurationsCount

  • getCompanyPortalConfigurationsCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyPortalConfigurationsInvoiceSetupPaymentProcessors

  • getCompanyPortalConfigurationsInvoiceSetupPaymentProcessors(params?: CommonParameters): Promise<{ id?: number; name?: string; testURL?: string }[]>

getCompanyPortalConfigurationsInvoiceSetupPaymentProcessorsById

  • getCompanyPortalConfigurationsInvoiceSetupPaymentProcessorsById(id: number, params?: CommonParameters): Promise<{ id?: number; name?: string; testURL?: string }>

getCompanyPortalConfigurationsInvoiceSetupPaymentProcessorsCount

  • getCompanyPortalConfigurationsInvoiceSetupPaymentProcessorsCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyPortalSecurityLevels

  • getCompanyPortalSecurityLevels(params?: CommonParameters): Promise<{ _info?: {}; caption?: string; captionIdentifier?: string; id?: number; isDefaultFlag?: null | boolean }[]>

getCompanyPortalSecurityLevelsById

  • getCompanyPortalSecurityLevelsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; caption?: string; captionIdentifier?: string; id?: number; isDefaultFlag?: null | boolean }>

getCompanyPortalSecurityLevelsCount

  • getCompanyPortalSecurityLevelsCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyPortalSecuritySettings

  • getCompanyPortalSecuritySettings(params?: CommonParameters): Promise<{ _info?: {}; functionDescription?: string; functionIdentifier?: string; id?: number; levelFive?: null | boolean; levelFour?: null | boolean; levelOne?: null | boolean; levelSix?: null | boolean; levelThree?: null | boolean; levelTwo?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; functionDescription?: string; functionIdentifier?: string; id?: number; levelFive?: null | boolean; levelFour?: null | boolean; levelOne?: null | boolean; levelSix?: null | boolean; levelThree?: null | boolean; levelTwo?: null | boolean }[]>

getCompanyPortalSecuritySettingsById

  • getCompanyPortalSecuritySettingsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; functionDescription?: string; functionIdentifier?: string; id?: number; levelFive?: null | boolean; levelFour?: null | boolean; levelOne?: null | boolean; levelSix?: null | boolean; levelThree?: null | boolean; levelTwo?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; functionDescription?: string; functionIdentifier?: string; id?: number; levelFive?: null | boolean; levelFour?: null | boolean; levelOne?: null | boolean; levelSix?: null | boolean; levelThree?: null | boolean; levelTwo?: null | boolean }>

getCompanyPortalSecuritySettingsCount

  • getCompanyPortalSecuritySettingsCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyStates

  • getCompanyStates(params?: CommonParameters): Promise<{ _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier: string; name: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier: string; name: string }[]>

getCompanyStatesById

  • getCompanyStatesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier: string; name: string }>

  • Parameters

    Returns Promise<{ _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier: string; name: string }>

getCompanyStatesByIdInfo

  • getCompanyStatesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier?: string; name?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier?: string; name?: string }>

getCompanyStatesByIdUsages

  • getCompanyStatesByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyStatesByIdUsagesList

  • getCompanyStatesByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyStatesCount

getCompanyStatesInfo

  • getCompanyStatesInfo(params?: CommonParameters): Promise<{ _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier?: string; name?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier?: string; name?: string }[]>

getCompanyStatesInfoCount

  • getCompanyStatesInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyTeamRoles

  • getCompanyTeamRoles(params?: CommonParameters): Promise<{ _info?: {}; accountManagerFlag?: null | boolean; id?: number; name: string; salesFlag?: null | boolean; techFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; accountManagerFlag?: null | boolean; id?: number; name: string; salesFlag?: null | boolean; techFlag?: null | boolean }[]>

getCompanyTeamRolesById

  • getCompanyTeamRolesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; accountManagerFlag?: null | boolean; id?: number; name: string; salesFlag?: null | boolean; techFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; accountManagerFlag?: null | boolean; id?: number; name: string; salesFlag?: null | boolean; techFlag?: null | boolean }>

getCompanyTeamRolesByIdInfo

  • getCompanyTeamRolesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }>

getCompanyTeamRolesByIdUsages

  • getCompanyTeamRolesByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyTeamRolesByIdUsagesList

  • getCompanyTeamRolesByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getCompanyTeamRolesCount

  • getCompanyTeamRolesCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyTeamRolesInfo

  • getCompanyTeamRolesInfo(params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }[]>

getCompanyTeamRolesInfoCount

  • getCompanyTeamRolesInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getCompanyTracks

  • getCompanyTracks(params?: CommonParameters): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; notifyActionIds?: number[] }[]>

getCompanyTracksById

  • getCompanyTracksById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; notifyActionIds?: number[] }>

getCompanyTracksByParentIdActions

  • getCompanyTracksByParentIdActions(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: "CreateActivity" | "SendEmail" | "AddToGroup" | "AttachTrack" | "ChangeCompanyStatus" | "CreateServiceTicket"; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subject?: string; track?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: "CreateActivity" | "SendEmail" | "AddToGroup" | "AttachTrack" | "ChangeCompanyStatus" | "CreateServiceTicket"; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subject?: string; track?: { _info?: {}; id?: null | number; name?: string } }[]>

getCompanyTracksByParentIdActionsById

  • getCompanyTracksByParentIdActionsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: "CreateActivity" | "SendEmail" | "AddToGroup" | "AttachTrack" | "ChangeCompanyStatus" | "CreateServiceTicket"; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subject?: string; track?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: "CreateActivity" | "SendEmail" | "AddToGroup" | "AttachTrack" | "ChangeCompanyStatus" | "CreateServiceTicket"; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subject?: string; track?: { _info?: {}; id?: null | number; name?: string } }>

getCompanyTracksByParentIdActionsCount

  • getCompanyTracksByParentIdActionsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getCompanyTracksCount

patchCompanyAddressFormatsById

  • patchCompanyAddressFormatsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; addAllCountries?: null | boolean; countryIds?: number[]; defaultFlag?: null | boolean; format: string; id?: number; name: string; removeAllCountries?: null | boolean }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; addAllCountries?: null | boolean; countryIds?: number[]; defaultFlag?: null | boolean; format: string; id?: number; name: string; removeAllCountries?: null | boolean }>

patchCompanyCommunicationTypesById

  • patchCompanyCommunicationTypesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; androidXref: string; defaultFlag?: null | boolean; description: string; emailFlag?: null | boolean; exchangeXref?: string; faxFlag?: null | boolean; googleXref?: string; id?: number; iphoneXref: string; phoneFlag?: null | boolean }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; androidXref: string; defaultFlag?: null | boolean; description: string; emailFlag?: null | boolean; exchangeXref?: string; faxFlag?: null | boolean; googleXref?: string; id?: number; iphoneXref: string; phoneFlag?: null | boolean }>

patchCompanyCompaniesById

  • patchCompanyCompaniesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; accountNumber?: string; addressLine1?: string; addressLine2?: string; annualRevenue?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingContact?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; companyEntityType?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateAcquired?: string; dateDeleted?: string; defaultContact?: { _info?: {}; id?: null | number; name?: string }; deletedBy?: string; deletedFlag?: null | boolean; facebookUrl?: string; faxNumber?: string; id?: number; identifier: string; integratorTags?: string[]; invoiceCCEmailAddress?: string; invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoiceToEmailAddress?: string; isVendorFlag?: null | boolean; leadFlag?: null | boolean; leadSource?: string; linkedInUrl?: string; market?: { _info?: {}; id?: null | number; name?: string }; mobileGuid?: null | string; name: string; numberOfEmployees?: null | number; ownershipType?: { _info?: {}; id?: null | number; name?: string }; parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; phoneNumber?: string; pricingSchedule?: { _info?: {}; id?: null | number; name?: string }; resellerIdentifier?: string; revenueYear?: null | number; sicCode?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxIdentifier?: string; territory?: { _info?: {}; id?: null | number; name?: string }; territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; twitterUrl?: string; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; vendorIdentifier?: string; website?: string; yearEstablished?: null | number; zip?: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; accountNumber?: string; addressLine1?: string; addressLine2?: string; annualRevenue?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingContact?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; companyEntityType?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateAcquired?: string; dateDeleted?: string; defaultContact?: { _info?: {}; id?: null | number; name?: string }; deletedBy?: string; deletedFlag?: null | boolean; facebookUrl?: string; faxNumber?: string; id?: number; identifier: string; integratorTags?: string[]; invoiceCCEmailAddress?: string; invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoiceToEmailAddress?: string; isVendorFlag?: null | boolean; leadFlag?: null | boolean; leadSource?: string; linkedInUrl?: string; market?: { _info?: {}; id?: null | number; name?: string }; mobileGuid?: null | string; name: string; numberOfEmployees?: null | number; ownershipType?: { _info?: {}; id?: null | number; name?: string }; parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; phoneNumber?: string; pricingSchedule?: { _info?: {}; id?: null | number; name?: string }; resellerIdentifier?: string; revenueYear?: null | number; sicCode?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxIdentifier?: string; territory?: { _info?: {}; id?: null | number; name?: string }; territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; twitterUrl?: string; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; vendorIdentifier?: string; website?: string; yearEstablished?: null | number; zip?: string }>

patchCompanyCompaniesByParentIdCustomStatusNotesById

  • patchCompanyCompaniesByParentIdCustomStatusNotesById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customNote: string; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customNote: string; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }>

patchCompanyCompaniesByParentIdGroupsById

  • patchCompanyCompaniesByParentIdGroupsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; allContactsFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contactIds?: number[]; defaultContactFlag?: null | boolean; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; removeAllContactsFlag?: null | boolean; unsubscribeFlag?: null | boolean }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; allContactsFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contactIds?: number[]; defaultContactFlag?: null | boolean; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; removeAllContactsFlag?: null | boolean; unsubscribeFlag?: null | boolean }>

patchCompanyCompaniesByParentIdManagementReportNotificationsById

  • patchCompanyCompaniesByParentIdManagementReportNotificationsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

patchCompanyCompaniesByParentIdManagementReportSetupById

  • patchCompanyCompaniesByParentIdManagementReportSetupById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; scheduledReportDisabledFlag: boolean }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; scheduledReportDisabledFlag: boolean }>

patchCompanyCompaniesByParentIdManagementSummaryReportsById

  • patchCompanyCompaniesByParentIdManagementSummaryReportsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; alertsGenerated?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cpuUtilization?: null | number; deviceType?: null | "WorkstationsAndServers" | "BackupStats" | "Servers" | "Workstations"; diskCleanups?: null | number; diskDefragmentations?: null | number; diskSpaceCleanedMb?: null | number; failedBackupJobs?: null | number; fullyPatchedMachines?: null | number; groupIdentifier: string; id?: number; internetConnectivity?: null | number; managementSolution?: { _info?: {}; id?: null | number; name?: string; setupName?: string }; memoryUtilization?: null | number; missingMoreFivePatchesMachines?: null | number; missingOneTwoPatchesMachines?: null | number; missingSecurityPatches?: string; missingThreeFivePatchesMachines?: null | number; missingUnscannedPatchesMachines?: null | number; serverAvailability?: null | number; serversDiskSpaceLow?: null | number; serversOffline?: null | number; snmpMachines?: null | number; spywareItemsRemoved?: null | number; successfulBackupJobs?: null | number; totalManagedMachines?: null | number; totalNotifications?: null | number; totalServers?: null | number; totalWindowsServers?: null | number; totalWindowsWorkstations?: null | number; totalWorkstations?: null | number; virusesRemoved?: null | number; windowsPatchesInstalled?: null | number }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; alertsGenerated?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cpuUtilization?: null | number; deviceType?: null | "WorkstationsAndServers" | "BackupStats" | "Servers" | "Workstations"; diskCleanups?: null | number; diskDefragmentations?: null | number; diskSpaceCleanedMb?: null | number; failedBackupJobs?: null | number; fullyPatchedMachines?: null | number; groupIdentifier: string; id?: number; internetConnectivity?: null | number; managementSolution?: { _info?: {}; id?: null | number; name?: string; setupName?: string }; memoryUtilization?: null | number; missingMoreFivePatchesMachines?: null | number; missingOneTwoPatchesMachines?: null | number; missingSecurityPatches?: string; missingThreeFivePatchesMachines?: null | number; missingUnscannedPatchesMachines?: null | number; serverAvailability?: null | number; serversDiskSpaceLow?: null | number; serversOffline?: null | number; snmpMachines?: null | number; spywareItemsRemoved?: null | number; successfulBackupJobs?: null | number; totalManagedMachines?: null | number; totalNotifications?: null | number; totalServers?: null | number; totalWindowsServers?: null | number; totalWindowsWorkstations?: null | number; totalWorkstations?: null | number; virusesRemoved?: null | number; windowsPatchesInstalled?: null | number }>

patchCompanyCompaniesByParentIdNotesById

  • patchCompanyCompaniesByParentIdNotesById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

patchCompanyCompaniesByParentIdSitesById

  • patchCompanyCompaniesByParentIdSitesById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; addressFormat?: string; addressLine1?: string; addressLine2?: string; billSeparateFlag?: null | boolean; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultBillingFlag?: null | boolean; defaultMailingFlag?: null | boolean; defaultShippingFlag?: null | boolean; entityType?: { _info?: {}; id?: null | number; name?: string }; expenseReimbursement?: null | number; faxNumber?: string; id?: number; inactiveFlag?: null | boolean; mobileGuid?: null | string; name: string; phoneNumber?: string; primaryAddressFlag?: null | boolean; stateReference?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string }; zip?: string }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; addressFormat?: string; addressLine1?: string; addressLine2?: string; billSeparateFlag?: null | boolean; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultBillingFlag?: null | boolean; defaultMailingFlag?: null | boolean; defaultShippingFlag?: null | boolean; entityType?: { _info?: {}; id?: null | number; name?: string }; expenseReimbursement?: null | number; faxNumber?: string; id?: number; inactiveFlag?: null | boolean; mobileGuid?: null | string; name: string; phoneNumber?: string; primaryAddressFlag?: null | boolean; stateReference?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string }; zip?: string }>

patchCompanyCompaniesByParentIdTeamsById

  • patchCompanyCompaniesByParentIdTeamsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; accountManagerFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; salesFlag?: null | boolean; teamRole?: { _info?: {}; id?: null | number; name?: string }; techFlag?: null | boolean }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; accountManagerFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; salesFlag?: null | boolean; teamRole?: { _info?: {}; id?: null | number; name?: string }; techFlag?: null | boolean }>

patchCompanyCompaniesByParentIdTypeAssociationsById

  • patchCompanyCompaniesByParentIdTypeAssociationsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

patchCompanyCompaniesStatusesById

  • patchCompanyCompaniesStatusesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; cancelOpenTracksFlag?: null | boolean; customNoteFlag?: null | boolean; defaultFlag?: null | boolean; disallowSavingFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; notificationMessage?: string; notifyFlag?: null | boolean; track?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; cancelOpenTracksFlag?: null | boolean; customNoteFlag?: null | boolean; defaultFlag?: null | boolean; disallowSavingFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; notificationMessage?: string; notifyFlag?: null | boolean; track?: { _info?: {}; id?: null | number; name?: string } }>

patchCompanyCompaniesTypesById

  • patchCompanyCompaniesTypesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string; vendorFlag?: null | boolean }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string; vendorFlag?: null | boolean }>

patchCompanyCompanyTypeAssociationsById

  • patchCompanyCompanyTypeAssociationsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

patchCompanyConfigurationsById

  • patchCompanyConfigurationsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[], params?: CommonParameters): Promise<{ _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]
    • params: CommonParameters = {}

    Returns Promise<{ _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }>

patchCompanyConfigurationsByIdChangeType

  • patchCompanyConfigurationsByIdChangeType(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }>

patchCompanyConfigurationsStatusesById

  • patchCompanyConfigurationsStatusesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; description: string; id?: number }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; description: string; id?: number }>

patchCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesById

  • patchCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesById(id: number, parentId: number, grandparentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; question?: { _info?: {}; id?: null | number; question?: string }; value: string }>

  • Parameters

    • id: number
    • parentId: number
    • grandparentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; question?: { _info?: {}; id?: null | number; question?: string }; value: string }>

patchCompanyConfigurationsTypesById

  • patchCompanyConfigurationsTypesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; systemFlag?: null | boolean }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; systemFlag?: null | boolean }>

patchCompanyConfigurationsTypesByParentIdQuestionsById

  • patchCompanyConfigurationsTypesByParentIdQuestionsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question: string; requiredFlag?: null | boolean; sequenceNumber: null | number }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question: string; requiredFlag?: null | boolean; sequenceNumber: null | number }>

patchCompanyContactTypeAssociationsById

  • patchCompanyContactTypeAssociationsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

patchCompanyContactsById

  • patchCompanyContactsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; addressLine1?: string; addressLine2?: string; anniversary?: string; assistantContact?: { _info?: {}; id?: null | number; name?: string }; birthDay?: string; children?: string; childrenFlag?: null | boolean; city?: string; communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultBillingFlag?: null | boolean; defaultFlag?: null | boolean; defaultMergeContactId?: null | number; defaultPhoneExtension?: string; defaultPhoneNbr?: string; defaultPhoneType?: string; department?: { _info?: {}; id?: null | number; name?: string }; disablePortalLoginFlag?: null | boolean; facebookUrl?: string; firstName?: string; gender?: null | "Female" | "Male"; id?: number; ignoreDuplicates?: boolean; inactiveFlag?: null | boolean; integratorTags?: string[]; lastName?: string; linkedInUrl?: string; managerContact?: { _info?: {}; id?: null | number; name?: string }; marriedFlag?: null | boolean; mobileGuid?: null | string; nickName?: string; photo?: { _info?: {}; id?: null | number; name?: string }; portalPassword?: string; portalSecurityLevel?: null | number; presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"; relationship?: { _info?: {}; id?: null | number; name?: string }; relationshipOverride?: string; school?: string; securityIdentifier?: string; significantOther?: string; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; title?: string; twitterUrl?: string; typeIds?: number[]; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; zip?: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; addressLine1?: string; addressLine2?: string; anniversary?: string; assistantContact?: { _info?: {}; id?: null | number; name?: string }; birthDay?: string; children?: string; childrenFlag?: null | boolean; city?: string; communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultBillingFlag?: null | boolean; defaultFlag?: null | boolean; defaultMergeContactId?: null | number; defaultPhoneExtension?: string; defaultPhoneNbr?: string; defaultPhoneType?: string; department?: { _info?: {}; id?: null | number; name?: string }; disablePortalLoginFlag?: null | boolean; facebookUrl?: string; firstName?: string; gender?: null | "Female" | "Male"; id?: number; ignoreDuplicates?: boolean; inactiveFlag?: null | boolean; integratorTags?: string[]; lastName?: string; linkedInUrl?: string; managerContact?: { _info?: {}; id?: null | number; name?: string }; marriedFlag?: null | boolean; mobileGuid?: null | string; nickName?: string; photo?: { _info?: {}; id?: null | number; name?: string }; portalPassword?: string; portalSecurityLevel?: null | number; presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"; relationship?: { _info?: {}; id?: null | number; name?: string }; relationshipOverride?: string; school?: string; securityIdentifier?: string; significantOther?: string; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; title?: string; twitterUrl?: string; typeIds?: number[]; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; zip?: string }>

patchCompanyContactsByParentIdCommunicationsById

  • patchCompanyContactsByParentIdCommunicationsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; communicationType?: null | "Email" | "Fax" | "Phone"; contactId?: null | number; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; mobileGuid?: null | string; type?: { _info?: {}; id?: null | number; name?: string }; value: string }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; communicationType?: null | "Email" | "Fax" | "Phone"; contactId?: null | number; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; mobileGuid?: null | string; type?: { _info?: {}; id?: null | number; name?: string }; value: string }>

patchCompanyContactsByParentIdGroupsById

  • patchCompanyContactsByParentIdGroupsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; companyGroupUnsubscribedEmailMessage?: string; companyUnsubcribedEmailMessage?: string; contact?: { _info?: {}; id?: null | number; name?: string }; contactGroupUnsubscribedEmailMessage?: string; contactUnsubscribedEmailMessage?: string; description?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; unsubscribeFlag?: null | boolean }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; companyGroupUnsubscribedEmailMessage?: string; companyUnsubcribedEmailMessage?: string; contact?: { _info?: {}; id?: null | number; name?: string }; contactGroupUnsubscribedEmailMessage?: string; contactUnsubscribedEmailMessage?: string; description?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; unsubscribeFlag?: null | boolean }>

patchCompanyContactsByParentIdNotesById

  • patchCompanyContactsByParentIdNotesById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; contactId?: null | number; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; contactId?: null | number; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

patchCompanyContactsByParentIdTypeAssociationsById

  • patchCompanyContactsByParentIdTypeAssociationsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

patchCompanyContactsDepartmentsById

  • patchCompanyContactsDepartmentsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; name: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; name: string }>

patchCompanyContactsRelationshipsById

  • patchCompanyContactsRelationshipsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; name: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; name: string }>

patchCompanyContactsTypesById

  • patchCompanyContactsTypesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }>

patchCompanyCountriesById

  • patchCompanyCountriesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; addressFormat?: { _info?: {}; id?: null | number; name?: string }; cityCaption?: string; countryCode?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; localizationValueOne?: string; name: string; stateCaption?: string; zipCaption?: string; zipMinimumLength?: null | number }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; addressFormat?: { _info?: {}; id?: null | number; name?: string }; cityCaption?: string; countryCode?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; localizationValueOne?: string; name: string; stateCaption?: string; zipCaption?: string; zipMinimumLength?: null | number }>

patchCompanyManagedDevicesIntegrationsById

  • patchCompanyManagedDevicesIntegrationsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; configBillCustomerFlag?: null | boolean; defaultBillingLevel: null | "Detail" | "Summary"; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; disableNewCrossReferencesFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; loginBy: null | "Global" | "Member"; managementItSetupType?: string; matchOnSerialNumberFlag?: null | boolean; name: string; portalUrl?: string; solution: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; configBillCustomerFlag?: null | boolean; defaultBillingLevel: null | "Detail" | "Summary"; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; disableNewCrossReferencesFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; loginBy: null | "Global" | "Member"; managementItSetupType?: string; matchOnSerialNumberFlag?: null | boolean; name: string; portalUrl?: string; solution: string }>

patchCompanyManagedDevicesIntegrationsByParentIdCrossReferencesById

  • patchCompanyManagedDevicesIntegrationsByParentIdCrossReferencesById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; vendorLevel?: string; vendorType?: string }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; vendorLevel?: string; vendorType?: string }>

patchCompanyManagedDevicesIntegrationsByParentIdLoginsById

  • patchCompanyManagedDevicesIntegrationsByParentIdLoginsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; password?: string; username: string }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; password?: string; username: string }>

patchCompanyManagedDevicesIntegrationsByParentIdNotificationsById

  • patchCompanyManagedDevicesIntegrationsByParentIdNotificationsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

patchCompanyManagementBackupsById

  • patchCompanyManagementBackupsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; billingLevel: null | "Detail" | "Summary"; id?: number; item?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; billingLevel: null | "Detail" | "Summary"; id?: number; item?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

patchCompanyManagementById

  • patchCompanyManagementById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; addedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; deletedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; executiveSummaryReportScheduleDay?: null | number; executiveSummaryReportScheduleHour?: null | number; executiveSummaryReportScheduleMinute?: null | number; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; runTime?: string; scheduleExecutiveSummaryReportFlag: null | boolean }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; addedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; deletedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; executiveSummaryReportScheduleDay?: null | number; executiveSummaryReportScheduleHour?: null | number; executiveSummaryReportScheduleMinute?: null | number; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; runTime?: string; scheduleExecutiveSummaryReportFlag: null | boolean }>

patchCompanyManagementByParentIdManagementReportNotificationsById

  • patchCompanyManagementByParentIdManagementReportNotificationsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

patchCompanyManagementItSolutionsById

  • patchCompanyManagementItSolutionsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; continuumApiPassword?: string; continuumApiUsername?: string; globalLoginFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; levelApiPassword?: string; levelApiUsername?: string; levelVarDomain?: string; managementItSolutionType: null | "LevelPlatforms" | "NAble" | "Continuum" | "Custom"; managementServerUrl?: string; managementSolutionName?: string; nAblePassword?: string; nAbleUsername?: string; name: string; noDisplayFlag?: null | boolean; overrideLoginLocationFlag?: null | boolean; overrideWebServiceLocationFlag?: null | boolean; portalOverrideLoginUrl?: string; usingSslFlag?: null | boolean; webserviceOverrideUrl?: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; continuumApiPassword?: string; continuumApiUsername?: string; globalLoginFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; levelApiPassword?: string; levelApiUsername?: string; levelVarDomain?: string; managementItSolutionType: null | "LevelPlatforms" | "NAble" | "Continuum" | "Custom"; managementServerUrl?: string; managementSolutionName?: string; nAblePassword?: string; nAbleUsername?: string; name: string; noDisplayFlag?: null | boolean; overrideLoginLocationFlag?: null | boolean; overrideWebServiceLocationFlag?: null | boolean; portalOverrideLoginUrl?: string; usingSslFlag?: null | boolean; webserviceOverrideUrl?: string }>

patchCompanyManagementItSolutionsByParentIdManagementProductsById

  • patchCompanyManagementItSolutionsByParentIdManagementProductsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean } }>

patchCompanyMarketDescriptionsById

  • patchCompanyMarketDescriptionsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; name: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; name: string }>

patchCompanyNoteTypesById

  • patchCompanyNoteTypesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; identifier?: string; importFlag?: null | boolean; name: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; identifier?: string; importFlag?: null | boolean; name: string }>

patchCompanyOwnershipTypesById

  • patchCompanyOwnershipTypesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; name: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; name: string }>

patchCompanyPortalConfigurationsById

  • patchCompanyPortalConfigurationsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }>

patchCompanyPortalConfigurationsByParentIdInvoiceSetupsById

  • patchCompanyPortalConfigurationsByParentIdInvoiceSetupsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; addAllStatuses?: null | boolean; allowInvPmtFlag?: null | boolean; billingStatusIds?: number[]; displayInvPmtFlag?: null | boolean; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; login?: string; password?: string; paymentProcessor?: { _info?: {}; id?: null | number; name?: string }; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; removeAllStatuses?: null | boolean; urlOverride?: string }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; addAllStatuses?: null | boolean; allowInvPmtFlag?: null | boolean; billingStatusIds?: number[]; displayInvPmtFlag?: null | boolean; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; login?: string; password?: string; paymentProcessor?: { _info?: {}; id?: null | number; name?: string }; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; removeAllStatuses?: null | boolean; urlOverride?: string }>

patchCompanyPortalConfigurationsByParentIdOpportunitySetups

  • patchCompanyPortalConfigurationsByParentIdOpportunitySetups(parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; acceptanceChangeStatusFlag?: null | boolean; acceptanceCreateActivityFlag?: null | boolean; acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; acceptanceEmailBody?: string; acceptanceEmailFromFirstName?: string; acceptanceEmailFromLastName?: string; acceptanceEmailSubject?: string; acceptanceFromEmail?: string; acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; acceptanceSendEmailFlag?: null | boolean; addAllOpportunityStatuses?: null | boolean; addAllOpportunityTypes?: null | boolean; confirmationEmailBody?: string; confirmationEmailFromFirstName?: string; confirmationEmailFromLastName?: string; confirmationEmailSubject?: string; confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean; confirmationFromEmail?: string; confirmationSendEmailFlag?: null | boolean; id?: number; opportunityStatusRecIDs?: number[]; opportunityTypeRecIDs?: number[]; rejectionChangeStatusFlag?: null | boolean; rejectionCreateActivityFlag?: null | boolean; rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; rejectionEmailBody?: string; rejectionEmailFromFirstName?: string; rejectionEmailFromLastName?: string; rejectionEmailSubject?: string; rejectionFromEmail?: string; rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; rejectionSendEmailFlag?: null | boolean; removeAllOpportunityStatuses?: null | boolean; removeAllOpportunityTypes?: null | boolean; restrictViewByOpportunityStatusFlag?: null | boolean; restrictViewByOpportunityTypeFlag?: null | boolean }>

  • Parameters

    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; acceptanceChangeStatusFlag?: null | boolean; acceptanceCreateActivityFlag?: null | boolean; acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; acceptanceEmailBody?: string; acceptanceEmailFromFirstName?: string; acceptanceEmailFromLastName?: string; acceptanceEmailSubject?: string; acceptanceFromEmail?: string; acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; acceptanceSendEmailFlag?: null | boolean; addAllOpportunityStatuses?: null | boolean; addAllOpportunityTypes?: null | boolean; confirmationEmailBody?: string; confirmationEmailFromFirstName?: string; confirmationEmailFromLastName?: string; confirmationEmailSubject?: string; confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean; confirmationFromEmail?: string; confirmationSendEmailFlag?: null | boolean; id?: number; opportunityStatusRecIDs?: number[]; opportunityTypeRecIDs?: number[]; rejectionChangeStatusFlag?: null | boolean; rejectionCreateActivityFlag?: null | boolean; rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; rejectionEmailBody?: string; rejectionEmailFromFirstName?: string; rejectionEmailFromLastName?: string; rejectionEmailSubject?: string; rejectionFromEmail?: string; rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; rejectionSendEmailFlag?: null | boolean; removeAllOpportunityStatuses?: null | boolean; removeAllOpportunityTypes?: null | boolean; restrictViewByOpportunityStatusFlag?: null | boolean; restrictViewByOpportunityTypeFlag?: null | boolean }>

patchCompanyPortalConfigurationsByParentIdOpportunitySetupsById

  • patchCompanyPortalConfigurationsByParentIdOpportunitySetupsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; acceptanceChangeStatusFlag?: null | boolean; acceptanceCreateActivityFlag?: null | boolean; acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; acceptanceEmailBody?: string; acceptanceEmailFromFirstName?: string; acceptanceEmailFromLastName?: string; acceptanceEmailSubject?: string; acceptanceFromEmail?: string; acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; acceptanceSendEmailFlag?: null | boolean; addAllOpportunityStatuses?: null | boolean; addAllOpportunityTypes?: null | boolean; confirmationEmailBody?: string; confirmationEmailFromFirstName?: string; confirmationEmailFromLastName?: string; confirmationEmailSubject?: string; confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean; confirmationFromEmail?: string; confirmationSendEmailFlag?: null | boolean; id?: number; opportunityStatusRecIDs?: number[]; opportunityTypeRecIDs?: number[]; rejectionChangeStatusFlag?: null | boolean; rejectionCreateActivityFlag?: null | boolean; rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; rejectionEmailBody?: string; rejectionEmailFromFirstName?: string; rejectionEmailFromLastName?: string; rejectionEmailSubject?: string; rejectionFromEmail?: string; rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; rejectionSendEmailFlag?: null | boolean; removeAllOpportunityStatuses?: null | boolean; removeAllOpportunityTypes?: null | boolean; restrictViewByOpportunityStatusFlag?: null | boolean; restrictViewByOpportunityTypeFlag?: null | boolean }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; acceptanceChangeStatusFlag?: null | boolean; acceptanceCreateActivityFlag?: null | boolean; acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; acceptanceEmailBody?: string; acceptanceEmailFromFirstName?: string; acceptanceEmailFromLastName?: string; acceptanceEmailSubject?: string; acceptanceFromEmail?: string; acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; acceptanceSendEmailFlag?: null | boolean; addAllOpportunityStatuses?: null | boolean; addAllOpportunityTypes?: null | boolean; confirmationEmailBody?: string; confirmationEmailFromFirstName?: string; confirmationEmailFromLastName?: string; confirmationEmailSubject?: string; confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean; confirmationFromEmail?: string; confirmationSendEmailFlag?: null | boolean; id?: number; opportunityStatusRecIDs?: number[]; opportunityTypeRecIDs?: number[]; rejectionChangeStatusFlag?: null | boolean; rejectionCreateActivityFlag?: null | boolean; rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; rejectionEmailBody?: string; rejectionEmailFromFirstName?: string; rejectionEmailFromLastName?: string; rejectionEmailSubject?: string; rejectionFromEmail?: string; rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; rejectionSendEmailFlag?: null | boolean; removeAllOpportunityStatuses?: null | boolean; removeAllOpportunityTypes?: null | boolean; restrictViewByOpportunityStatusFlag?: null | boolean; restrictViewByOpportunityTypeFlag?: null | boolean }>

patchCompanyPortalConfigurationsByParentIdPasswordEmailSetupsById

  • patchCompanyPortalConfigurationsByParentIdPasswordEmailSetupsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; invalidPasswordEmailBody?: string; invalidPasswordEmailFromEmail?: string; invalidPasswordEmailFromFirstName?: string; invalidPasswordEmailFromLastName?: string; invalidPasswordEmailSubject?: string; invalidPasswordEmailUseCustomEmailFlag?: null | boolean; validPasswordEmailBody?: string; validPasswordEmailFromEmail?: string; validPasswordEmailFromFirstName?: string; validPasswordEmailFromLastName?: string; validPasswordEmailSubject?: string; validPasswordEmailUseCustomEmailFlag?: null | boolean }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; invalidPasswordEmailBody?: string; invalidPasswordEmailFromEmail?: string; invalidPasswordEmailFromFirstName?: string; invalidPasswordEmailFromLastName?: string; invalidPasswordEmailSubject?: string; invalidPasswordEmailUseCustomEmailFlag?: null | boolean; validPasswordEmailBody?: string; validPasswordEmailFromEmail?: string; validPasswordEmailFromFirstName?: string; validPasswordEmailFromLastName?: string; validPasswordEmailSubject?: string; validPasswordEmailUseCustomEmailFlag?: null | boolean }>

patchCompanyPortalConfigurationsByParentIdProjectSetupsById

  • patchCompanyPortalConfigurationsByParentIdProjectSetupsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; billingMethodFlag?: null | boolean; contactFlag?: null | boolean; descriptionFlag?: null | boolean; estimatedEndFlag?: null | boolean; estimatedStartFlag?: null | boolean; fixedFeeActualFinishFlag?: null | boolean; fixedFeeActualHrsFlag?: null | boolean; fixedFeeActualStartFlag?: null | boolean; fixedFeeAssignedFlag?: null | boolean; fixedFeeBillFlag?: null | boolean; fixedFeeBudgetHrsFlag?: null | boolean; fixedFeeScheduledFinishFlag?: null | boolean; fixedFeeScheduledHrsFlag?: null | boolean; fixedFeeScheduledStartFlag?: null | boolean; fixedFeeStatusFlag?: null | boolean; id?: number; lastUpdatedFlag?: null | boolean; onlyDisplay: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; portalConfig?: { _info?: {}; id?: null | number; name?: string }; projectDetailTotalHoursFlag?: null | boolean; projectIssueActualFinishFlag?: null | boolean; projectIssueActualHrsFlag?: null | boolean; projectIssueActualStartFlag?: null | boolean; projectIssueAssignedFlag?: null | boolean; projectIssueBillFlag?: null | boolean; projectIssueBudgetHrsFlag?: null | boolean; projectIssueScheduledFinishFlag?: null | boolean; projectIssueScheduledHrsFlag?: null | boolean; projectIssueScheduledStartFlag?: null | boolean; projectIssueStatusFlag?: null | boolean; projectManagerFlag?: null | boolean; projectNameFlag?: null | boolean; projectTypeFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialActualFinishFlag?: null | boolean; timeMaterialActualHrsFlag?: null | boolean; timeMaterialActualStartFlag?: null | boolean; timeMaterialAssignedFlag?: null | boolean; timeMaterialBillFlag?: null | boolean; timeMaterialBudgetHrsFlag?: null | boolean; timeMaterialScheduledFinishFlag?: null | boolean; timeMaterialScheduledHrsFlag?: null | boolean; timeMaterialScheduledStartFlag?: null | boolean; timeMaterialStatusFlag?: null | boolean }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; billingMethodFlag?: null | boolean; contactFlag?: null | boolean; descriptionFlag?: null | boolean; estimatedEndFlag?: null | boolean; estimatedStartFlag?: null | boolean; fixedFeeActualFinishFlag?: null | boolean; fixedFeeActualHrsFlag?: null | boolean; fixedFeeActualStartFlag?: null | boolean; fixedFeeAssignedFlag?: null | boolean; fixedFeeBillFlag?: null | boolean; fixedFeeBudgetHrsFlag?: null | boolean; fixedFeeScheduledFinishFlag?: null | boolean; fixedFeeScheduledHrsFlag?: null | boolean; fixedFeeScheduledStartFlag?: null | boolean; fixedFeeStatusFlag?: null | boolean; id?: number; lastUpdatedFlag?: null | boolean; onlyDisplay: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; portalConfig?: { _info?: {}; id?: null | number; name?: string }; projectDetailTotalHoursFlag?: null | boolean; projectIssueActualFinishFlag?: null | boolean; projectIssueActualHrsFlag?: null | boolean; projectIssueActualStartFlag?: null | boolean; projectIssueAssignedFlag?: null | boolean; projectIssueBillFlag?: null | boolean; projectIssueBudgetHrsFlag?: null | boolean; projectIssueScheduledFinishFlag?: null | boolean; projectIssueScheduledHrsFlag?: null | boolean; projectIssueScheduledStartFlag?: null | boolean; projectIssueStatusFlag?: null | boolean; projectManagerFlag?: null | boolean; projectNameFlag?: null | boolean; projectTypeFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialActualFinishFlag?: null | boolean; timeMaterialActualHrsFlag?: null | boolean; timeMaterialActualStartFlag?: null | boolean; timeMaterialAssignedFlag?: null | boolean; timeMaterialBillFlag?: null | boolean; timeMaterialBudgetHrsFlag?: null | boolean; timeMaterialScheduledFinishFlag?: null | boolean; timeMaterialScheduledHrsFlag?: null | boolean; timeMaterialScheduledStartFlag?: null | boolean; timeMaterialStatusFlag?: null | boolean }>

patchCompanyPortalConfigurationsByParentIdServiceSetupsById

  • patchCompanyPortalConfigurationsByParentIdServiceSetupsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; actualHoursFlag?: null | boolean; approvalStatusFlag?: null | boolean; assignedResourcesFlag?: null | boolean; budgetHoursFlag?: null | boolean; closedTasksFlag?: null | boolean; contactFlag?: null | boolean; displayClosedTicketsOption: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; enableChatAssistFlag?: null | boolean; enteredDateFlag?: null | boolean; fixedFeeTicketTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; lastUpdateFlag?: null | boolean; openTasksFlag?: null | boolean; requiredDateFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceSubTypeFlag?: null | boolean; serviceSubTypeItemFlag?: null | boolean; serviceTypeFlag?: null | boolean; siteNameFlag?: null | boolean; slaInfoFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialsTicketTemplate?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; actualHoursFlag?: null | boolean; approvalStatusFlag?: null | boolean; assignedResourcesFlag?: null | boolean; budgetHoursFlag?: null | boolean; closedTasksFlag?: null | boolean; contactFlag?: null | boolean; displayClosedTicketsOption: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; enableChatAssistFlag?: null | boolean; enteredDateFlag?: null | boolean; fixedFeeTicketTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; lastUpdateFlag?: null | boolean; openTasksFlag?: null | boolean; requiredDateFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceSubTypeFlag?: null | boolean; serviceSubTypeItemFlag?: null | boolean; serviceTypeFlag?: null | boolean; siteNameFlag?: null | boolean; slaInfoFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialsTicketTemplate?: { _info?: {}; id?: null | number; name?: string } }>

patchCompanyPortalSecurityLevelsById

  • patchCompanyPortalSecurityLevelsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; caption?: string; captionIdentifier?: string; id?: number; isDefaultFlag?: null | boolean }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; caption?: string; captionIdentifier?: string; id?: number; isDefaultFlag?: null | boolean }>

patchCompanyPortalSecuritySettingsById

  • patchCompanyPortalSecuritySettingsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; functionDescription?: string; functionIdentifier?: string; id?: number; levelFive?: null | boolean; levelFour?: null | boolean; levelOne?: null | boolean; levelSix?: null | boolean; levelThree?: null | boolean; levelTwo?: null | boolean }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; functionDescription?: string; functionIdentifier?: string; id?: number; levelFive?: null | boolean; levelFour?: null | boolean; levelOne?: null | boolean; levelSix?: null | boolean; levelThree?: null | boolean; levelTwo?: null | boolean }>

patchCompanyStatesById

  • patchCompanyStatesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier: string; name: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier: string; name: string }>

patchCompanyTeamRolesById

  • patchCompanyTeamRolesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; accountManagerFlag?: null | boolean; id?: number; name: string; salesFlag?: null | boolean; techFlag?: null | boolean }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; accountManagerFlag?: null | boolean; id?: number; name: string; salesFlag?: null | boolean; techFlag?: null | boolean }>

patchCompanyTracksById

  • patchCompanyTracksById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; notifyActionIds?: number[] }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; notifyActionIds?: number[] }>

patchCompanyTracksByParentIdActionsById

  • patchCompanyTracksByParentIdActionsById(id: number, parentId: number): Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: "CreateActivity" | "SendEmail" | "AddToGroup" | "AttachTrack" | "ChangeCompanyStatus" | "CreateServiceTicket"; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subject?: string; track?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number

    Returns Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: "CreateActivity" | "SendEmail" | "AddToGroup" | "AttachTrack" | "ChangeCompanyStatus" | "CreateServiceTicket"; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subject?: string; track?: { _info?: {}; id?: null | number; name?: string } }>

postCompanyAddressFormats

  • postCompanyAddressFormats(addressFormat: { _info?: {}; addAllCountries?: null | boolean; countryIds?: number[]; defaultFlag?: null | boolean; format: string; id?: number; name: string; removeAllCountries?: null | boolean }): Promise<{ _info?: {}; addAllCountries?: null | boolean; countryIds?: number[]; defaultFlag?: null | boolean; format: string; id?: number; name: string; removeAllCountries?: null | boolean }>

  • Parameters

    • addressFormat: { _info?: {}; addAllCountries?: null | boolean; countryIds?: number[]; defaultFlag?: null | boolean; format: string; id?: number; name: string; removeAllCountries?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addAllCountries?: null | boolean
      • Optional countryIds?: number[]
      • Optional defaultFlag?: null | boolean
      • format: string
        description

        Max length: 250;

      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 50;

      • Optional removeAllCountries?: null | boolean

    Returns Promise<{ _info?: {}; addAllCountries?: null | boolean; countryIds?: number[]; defaultFlag?: null | boolean; format: string; id?: number; name: string; removeAllCountries?: null | boolean }>

postCompanyCommunicationTypes

  • postCompanyCommunicationTypes(communicationType: { _info?: {}; androidXref: string; defaultFlag?: null | boolean; description: string; emailFlag?: null | boolean; exchangeXref?: string; faxFlag?: null | boolean; googleXref?: string; id?: number; iphoneXref: string; phoneFlag?: null | boolean }): Promise<{ _info?: {}; androidXref: string; defaultFlag?: null | boolean; description: string; emailFlag?: null | boolean; exchangeXref?: string; faxFlag?: null | boolean; googleXref?: string; id?: number; iphoneXref: string; phoneFlag?: null | boolean }>

  • Parameters

    • communicationType: { _info?: {}; androidXref: string; defaultFlag?: null | boolean; description: string; emailFlag?: null | boolean; exchangeXref?: string; faxFlag?: null | boolean; googleXref?: string; id?: number; iphoneXref: string; phoneFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • androidXref: string
        description

        Max length: 50;

      • Optional defaultFlag?: null | boolean
      • description: string
      • Optional emailFlag?: null | boolean
        description

        At least one flag is required to be true -- phone, fax, or email

      • Optional exchangeXref?: string
        description

        Exchange Xref required if phone or fax Max length: 50;

      • Optional faxFlag?: null | boolean
        description

        At least one flag is required to be true -- phone, fax, or email

      • Optional googleXref?: string
        description

        Google Xref required if phone or fax Max length: 50;

      • Optional id?: number

        Format: int32

      • iphoneXref: string
        description

        Max length: 50;

      • Optional phoneFlag?: null | boolean
        description

        At least one flag is required to be true -- phone, fax, or email

    Returns Promise<{ _info?: {}; androidXref: string; defaultFlag?: null | boolean; description: string; emailFlag?: null | boolean; exchangeXref?: string; faxFlag?: null | boolean; googleXref?: string; id?: number; iphoneXref: string; phoneFlag?: null | boolean }>

postCompanyCompanies

  • postCompanyCompanies(company: { _info?: {}; accountNumber?: string; addressLine1?: string; addressLine2?: string; annualRevenue?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingContact?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; companyEntityType?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateAcquired?: string; dateDeleted?: string; defaultContact?: { _info?: {}; id?: null | number; name?: string }; deletedBy?: string; deletedFlag?: null | boolean; facebookUrl?: string; faxNumber?: string; id?: number; identifier: string; integratorTags?: string[]; invoiceCCEmailAddress?: string; invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoiceToEmailAddress?: string; isVendorFlag?: null | boolean; leadFlag?: null | boolean; leadSource?: string; linkedInUrl?: string; market?: { _info?: {}; id?: null | number; name?: string }; mobileGuid?: null | string; name: string; numberOfEmployees?: null | number; ownershipType?: { _info?: {}; id?: null | number; name?: string }; parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; phoneNumber?: string; pricingSchedule?: { _info?: {}; id?: null | number; name?: string }; resellerIdentifier?: string; revenueYear?: null | number; sicCode?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxIdentifier?: string; territory?: { _info?: {}; id?: null | number; name?: string }; territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; twitterUrl?: string; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; vendorIdentifier?: string; website?: string; yearEstablished?: null | number; zip?: string }): Promise<{ _info?: {}; accountNumber?: string; addressLine1?: string; addressLine2?: string; annualRevenue?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingContact?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; companyEntityType?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateAcquired?: string; dateDeleted?: string; defaultContact?: { _info?: {}; id?: null | number; name?: string }; deletedBy?: string; deletedFlag?: null | boolean; facebookUrl?: string; faxNumber?: string; id?: number; identifier: string; integratorTags?: string[]; invoiceCCEmailAddress?: string; invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoiceToEmailAddress?: string; isVendorFlag?: null | boolean; leadFlag?: null | boolean; leadSource?: string; linkedInUrl?: string; market?: { _info?: {}; id?: null | number; name?: string }; mobileGuid?: null | string; name: string; numberOfEmployees?: null | number; ownershipType?: { _info?: {}; id?: null | number; name?: string }; parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; phoneNumber?: string; pricingSchedule?: { _info?: {}; id?: null | number; name?: string }; resellerIdentifier?: string; revenueYear?: null | number; sicCode?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxIdentifier?: string; territory?: { _info?: {}; id?: null | number; name?: string }; territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; twitterUrl?: string; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; vendorIdentifier?: string; website?: string; yearEstablished?: null | number; zip?: string }>

  • Parameters

    • company: { _info?: {}; accountNumber?: string; addressLine1?: string; addressLine2?: string; annualRevenue?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingContact?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; companyEntityType?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateAcquired?: string; dateDeleted?: string; defaultContact?: { _info?: {}; id?: null | number; name?: string }; deletedBy?: string; deletedFlag?: null | boolean; facebookUrl?: string; faxNumber?: string; id?: number; identifier: string; integratorTags?: string[]; invoiceCCEmailAddress?: string; invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoiceToEmailAddress?: string; isVendorFlag?: null | boolean; leadFlag?: null | boolean; leadSource?: string; linkedInUrl?: string; market?: { _info?: {}; id?: null | number; name?: string }; mobileGuid?: null | string; name: string; numberOfEmployees?: null | number; ownershipType?: { _info?: {}; id?: null | number; name?: string }; parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; phoneNumber?: string; pricingSchedule?: { _info?: {}; id?: null | number; name?: string }; resellerIdentifier?: string; revenueYear?: null | number; sicCode?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxIdentifier?: string; territory?: { _info?: {}; id?: null | number; name?: string }; territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; twitterUrl?: string; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; vendorIdentifier?: string; website?: string; yearEstablished?: null | number; zip?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional accountNumber?: string
      • Optional addressLine1?: string
        description

        At least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country Max length: 50;

      • Optional addressLine2?: string
        description

        At least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country Max length: 50;

      • Optional annualRevenue?: null | number

        Format: double

      • Optional billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional billingContact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional billingSite?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional billingTerms?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional calendar?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional city?: string
        description

        At least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country Max length: 50;

      • Optional companyEntityType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional currencyCode?: string
        • Optional currencyIdentifier?: string
        • Optional decimalSeparator?: string
        • Optional displayIdFlag?: boolean
        • Optional displaySymbolFlag?: boolean
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional negativeParenthesesFlag?: boolean
        • Optional numberOfDecimals?: number

          Format: int32

        • Optional rightAlign?: boolean
        • Optional symbol?: string
        • Optional thousandsSeparator?: string
      • Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
      • Optional dateAcquired?: string

        Format: date-time

      • Optional dateDeleted?: string

        Format: date-time

      • Optional defaultContact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional deletedBy?: string
      • Optional deletedFlag?: null | boolean
      • Optional facebookUrl?: string
      • Optional faxNumber?: string
        description

        Max length: 30;

      • Optional id?: number

        Format: int32

      • identifier: string
        description

        Max length: 25;

      • Optional integratorTags?: string[]
      • Optional invoiceCCEmailAddress?: string
      • Optional invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional invoiceToEmailAddress?: string
      • Optional isVendorFlag?: null | boolean
      • Optional leadFlag?: null | boolean
      • Optional leadSource?: string
        description

        Max length: 50;

      • Optional linkedInUrl?: string
      • Optional market?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional mobileGuid?: null | string

        Format: uuid

      • name: string
        description

        Max length: 50;

      • Optional numberOfEmployees?: null | number

        Format: int32

      • Optional ownershipType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional phoneNumber?: string
        description

        Max length: 30;

      • Optional pricingSchedule?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional resellerIdentifier?: string
      • Optional revenueYear?: null | number

        Format: int32

      • Optional sicCode?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional site?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional state?: string
        description

        At least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country Max length: 50;

      • Optional status?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional taxCode?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional taxIdentifier?: string
      • Optional territory?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional twitterUrl?: string
      • Optional types?: { _info?: {}; id?: null | number; name?: string }[]
        description

        Integrer array of Company_Type_Recids to be assigned to company that can be passed in only during new company creation (post) To update existing companies type, use the /company/companyTypeAssociations or /company/companies/{ID}/typeAssociations endpoints

      • Optional unsubscribeFlag?: null | boolean
      • Optional userDefinedField1?: string
        description

        Max length: 50;

      • Optional userDefinedField10?: string
        description

        Max length: 50;

      • Optional userDefinedField2?: string
        description

        Max length: 50;

      • Optional userDefinedField3?: string
        description

        Max length: 50;

      • Optional userDefinedField4?: string
        description

        Max length: 50;

      • Optional userDefinedField5?: string
        description

        Max length: 50;

      • Optional userDefinedField6?: string
        description

        Max length: 50;

      • Optional userDefinedField7?: string
        description

        Max length: 50;

      • Optional userDefinedField8?: string
        description

        Max length: 50;

      • Optional userDefinedField9?: string
        description

        Max length: 50;

      • Optional vendorIdentifier?: string
      • Optional website?: string
        description

        Max length: 255;

      • Optional yearEstablished?: null | number

        Format: int32

      • Optional zip?: string
        description

        At least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country Max length: 12;

    Returns Promise<{ _info?: {}; accountNumber?: string; addressLine1?: string; addressLine2?: string; annualRevenue?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingContact?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; companyEntityType?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateAcquired?: string; dateDeleted?: string; defaultContact?: { _info?: {}; id?: null | number; name?: string }; deletedBy?: string; deletedFlag?: null | boolean; facebookUrl?: string; faxNumber?: string; id?: number; identifier: string; integratorTags?: string[]; invoiceCCEmailAddress?: string; invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoiceToEmailAddress?: string; isVendorFlag?: null | boolean; leadFlag?: null | boolean; leadSource?: string; linkedInUrl?: string; market?: { _info?: {}; id?: null | number; name?: string }; mobileGuid?: null | string; name: string; numberOfEmployees?: null | number; ownershipType?: { _info?: {}; id?: null | number; name?: string }; parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; phoneNumber?: string; pricingSchedule?: { _info?: {}; id?: null | number; name?: string }; resellerIdentifier?: string; revenueYear?: null | number; sicCode?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxIdentifier?: string; territory?: { _info?: {}; id?: null | number; name?: string }; territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; twitterUrl?: string; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; vendorIdentifier?: string; website?: string; yearEstablished?: null | number; zip?: string }>

postCompanyCompaniesByIdMerge

  • postCompanyCompaniesByIdMerge(id: number, merge: { accountNumber?: null | "From" | "To"; activities?: null | "Discard" | "Merge"; billingAddress?: null | "From" | "To"; billingContact?: null | "From" | "To"; billingTerms?: null | "From" | "To"; contacts?: null | "Discard" | "Merge"; dateAcquired?: null | "From" | "To"; documents?: null | "Discard" | "Merge"; fax?: null | "From" | "To"; identifier?: null | "From" | "To"; market?: null | "From" | "To"; name?: null | "From" | "To"; notes?: null | "Discard" | "Merge"; numberOfEmployees?: null | "From" | "To"; opportunities?: null | "Discard" | "Merge"; phone?: null | "From" | "To"; primaryAddress?: null | "From" | "To"; primaryContact?: null | "From" | "To"; projects?: null | "Discard" | "Merge"; revenue?: null | "From" | "To"; revenueYear?: null | "From" | "To"; services?: null | "Discard" | "Merge"; sicCode?: null | "From" | "To"; sites?: null | "Discard" | "Merge"; sourceList?: null | "From" | "To"; status?: null | "From" | "To"; taxCode?: null | "From" | "To"; territory?: null | "From" | "To"; timeZone?: null | "From" | "To"; toCompanyId: number; type?: null | "From" | "To"; userDefinedField1?: null | "From" | "To"; userDefinedField10?: null | "From" | "To"; userDefinedField2?: null | "From" | "To"; userDefinedField3?: null | "From" | "To"; userDefinedField4?: null | "From" | "To"; userDefinedField5?: null | "From" | "To"; userDefinedField6?: null | "From" | "To"; userDefinedField7?: null | "From" | "To"; userDefinedField8?: null | "From" | "To"; userDefinedField9?: null | "From" | "To"; website?: null | "From" | "To" }): Promise<{ message?: string; success?: boolean }>

  • Parameters

    • id: number
    • merge: { accountNumber?: null | "From" | "To"; activities?: null | "Discard" | "Merge"; billingAddress?: null | "From" | "To"; billingContact?: null | "From" | "To"; billingTerms?: null | "From" | "To"; contacts?: null | "Discard" | "Merge"; dateAcquired?: null | "From" | "To"; documents?: null | "Discard" | "Merge"; fax?: null | "From" | "To"; identifier?: null | "From" | "To"; market?: null | "From" | "To"; name?: null | "From" | "To"; notes?: null | "Discard" | "Merge"; numberOfEmployees?: null | "From" | "To"; opportunities?: null | "Discard" | "Merge"; phone?: null | "From" | "To"; primaryAddress?: null | "From" | "To"; primaryContact?: null | "From" | "To"; projects?: null | "Discard" | "Merge"; revenue?: null | "From" | "To"; revenueYear?: null | "From" | "To"; services?: null | "Discard" | "Merge"; sicCode?: null | "From" | "To"; sites?: null | "Discard" | "Merge"; sourceList?: null | "From" | "To"; status?: null | "From" | "To"; taxCode?: null | "From" | "To"; territory?: null | "From" | "To"; timeZone?: null | "From" | "To"; toCompanyId: number; type?: null | "From" | "To"; userDefinedField1?: null | "From" | "To"; userDefinedField10?: null | "From" | "To"; userDefinedField2?: null | "From" | "To"; userDefinedField3?: null | "From" | "To"; userDefinedField4?: null | "From" | "To"; userDefinedField5?: null | "From" | "To"; userDefinedField6?: null | "From" | "To"; userDefinedField7?: null | "From" | "To"; userDefinedField8?: null | "From" | "To"; userDefinedField9?: null | "From" | "To"; website?: null | "From" | "To" }
      • Optional accountNumber?: null | "From" | "To"
      • Optional activities?: null | "Discard" | "Merge"
      • Optional billingAddress?: null | "From" | "To"
      • Optional billingContact?: null | "From" | "To"
      • Optional billingTerms?: null | "From" | "To"
      • Optional contacts?: null | "Discard" | "Merge"
      • Optional dateAcquired?: null | "From" | "To"
      • Optional documents?: null | "Discard" | "Merge"
      • Optional fax?: null | "From" | "To"
      • Optional identifier?: null | "From" | "To"
      • Optional market?: null | "From" | "To"
      • Optional name?: null | "From" | "To"
      • Optional notes?: null | "Discard" | "Merge"
      • Optional numberOfEmployees?: null | "From" | "To"
      • Optional opportunities?: null | "Discard" | "Merge"
      • Optional phone?: null | "From" | "To"
      • Optional primaryAddress?: null | "From" | "To"
      • Optional primaryContact?: null | "From" | "To"
      • Optional projects?: null | "Discard" | "Merge"
      • Optional revenue?: null | "From" | "To"
      • Optional revenueYear?: null | "From" | "To"
      • Optional services?: null | "Discard" | "Merge"
      • Optional sicCode?: null | "From" | "To"
      • Optional sites?: null | "Discard" | "Merge"
      • Optional sourceList?: null | "From" | "To"
      • Optional status?: null | "From" | "To"
      • Optional taxCode?: null | "From" | "To"
      • Optional territory?: null | "From" | "To"
      • Optional timeZone?: null | "From" | "To"
      • toCompanyId: number

        Format: int32

      • Optional type?: null | "From" | "To"
      • Optional userDefinedField1?: null | "From" | "To"
      • Optional userDefinedField10?: null | "From" | "To"
      • Optional userDefinedField2?: null | "From" | "To"
      • Optional userDefinedField3?: null | "From" | "To"
      • Optional userDefinedField4?: null | "From" | "To"
      • Optional userDefinedField5?: null | "From" | "To"
      • Optional userDefinedField6?: null | "From" | "To"
      • Optional userDefinedField7?: null | "From" | "To"
      • Optional userDefinedField8?: null | "From" | "To"
      • Optional userDefinedField9?: null | "From" | "To"
      • Optional website?: null | "From" | "To"

    Returns Promise<{ message?: string; success?: boolean }>

postCompanyCompaniesByParentIdCustomStatusNotes

  • postCompanyCompaniesByParentIdCustomStatusNotes(parentId: number, customNote: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customNote: string; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customNote: string; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • customNote: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customNote: string; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • customNote: string
        description

        Max length: 1500;

      • Optional id?: number

        Format: int32

      • Optional status?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customNote: string; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }>

postCompanyCompaniesByParentIdGroups

  • postCompanyCompaniesByParentIdGroups(parentId: number, companyGroup: { _info?: {}; allContactsFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contactIds?: number[]; defaultContactFlag?: null | boolean; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; removeAllContactsFlag?: null | boolean; unsubscribeFlag?: null | boolean }): Promise<{ _info?: {}; allContactsFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contactIds?: number[]; defaultContactFlag?: null | boolean; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; removeAllContactsFlag?: null | boolean; unsubscribeFlag?: null | boolean }>

  • Parameters

    • parentId: number
    • companyGroup: { _info?: {}; allContactsFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contactIds?: number[]; defaultContactFlag?: null | boolean; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; removeAllContactsFlag?: null | boolean; unsubscribeFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional allContactsFlag?: null | boolean
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional contactIds?: number[]
      • Optional defaultContactFlag?: null | boolean
      • Optional group?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

        description

        Required On Updates;

      • Optional removeAllContactsFlag?: null | boolean
      • Optional unsubscribeFlag?: null | boolean

    Returns Promise<{ _info?: {}; allContactsFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contactIds?: number[]; defaultContactFlag?: null | boolean; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; removeAllContactsFlag?: null | boolean; unsubscribeFlag?: null | boolean }>

postCompanyCompaniesByParentIdManagementReportNotifications

  • postCompanyCompaniesByParentIdManagementReportNotifications(parentId: number, managementReportNotification: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • parentId: number
    • managementReportNotification: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional email?: string
        description

        Max length: 50;

      • Optional globalFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

postCompanyCompaniesByParentIdManagementReportSetup

  • postCompanyCompaniesByParentIdManagementReportSetup(parentId: number, managementReportSetup: { _info?: {}; id?: number; scheduledReportDisabledFlag: boolean }): Promise<{ _info?: {}; id?: number; scheduledReportDisabledFlag: boolean }>

  • Parameters

    • parentId: number
    • managementReportSetup: { _info?: {}; id?: number; scheduledReportDisabledFlag: boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • scheduledReportDisabledFlag: boolean

    Returns Promise<{ _info?: {}; id?: number; scheduledReportDisabledFlag: boolean }>

postCompanyCompaniesByParentIdManagementSummaryReports

  • postCompanyCompaniesByParentIdManagementSummaryReports(parentId: number, managementSummary: { _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; alertsGenerated?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cpuUtilization?: null | number; deviceType?: null | "WorkstationsAndServers" | "BackupStats" | "Servers" | "Workstations"; diskCleanups?: null | number; diskDefragmentations?: null | number; diskSpaceCleanedMb?: null | number; failedBackupJobs?: null | number; fullyPatchedMachines?: null | number; groupIdentifier: string; id?: number; internetConnectivity?: null | number; managementSolution?: { _info?: {}; id?: null | number; name?: string; setupName?: string }; memoryUtilization?: null | number; missingMoreFivePatchesMachines?: null | number; missingOneTwoPatchesMachines?: null | number; missingSecurityPatches?: string; missingThreeFivePatchesMachines?: null | number; missingUnscannedPatchesMachines?: null | number; serverAvailability?: null | number; serversDiskSpaceLow?: null | number; serversOffline?: null | number; snmpMachines?: null | number; spywareItemsRemoved?: null | number; successfulBackupJobs?: null | number; totalManagedMachines?: null | number; totalNotifications?: null | number; totalServers?: null | number; totalWindowsServers?: null | number; totalWindowsWorkstations?: null | number; totalWorkstations?: null | number; virusesRemoved?: null | number; windowsPatchesInstalled?: null | number }): Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; alertsGenerated?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cpuUtilization?: null | number; deviceType?: null | "WorkstationsAndServers" | "BackupStats" | "Servers" | "Workstations"; diskCleanups?: null | number; diskDefragmentations?: null | number; diskSpaceCleanedMb?: null | number; failedBackupJobs?: null | number; fullyPatchedMachines?: null | number; groupIdentifier: string; id?: number; internetConnectivity?: null | number; managementSolution?: { _info?: {}; id?: null | number; name?: string; setupName?: string }; memoryUtilization?: null | number; missingMoreFivePatchesMachines?: null | number; missingOneTwoPatchesMachines?: null | number; missingSecurityPatches?: string; missingThreeFivePatchesMachines?: null | number; missingUnscannedPatchesMachines?: null | number; serverAvailability?: null | number; serversDiskSpaceLow?: null | number; serversOffline?: null | number; snmpMachines?: null | number; spywareItemsRemoved?: null | number; successfulBackupJobs?: null | number; totalManagedMachines?: null | number; totalNotifications?: null | number; totalServers?: null | number; totalWindowsServers?: null | number; totalWindowsWorkstations?: null | number; totalWorkstations?: null | number; virusesRemoved?: null | number; windowsPatchesInstalled?: null | number }>

  • Parameters

    • parentId: number
    • managementSummary: { _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; alertsGenerated?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cpuUtilization?: null | number; deviceType?: null | "WorkstationsAndServers" | "BackupStats" | "Servers" | "Workstations"; diskCleanups?: null | number; diskDefragmentations?: null | number; diskSpaceCleanedMb?: null | number; failedBackupJobs?: null | number; fullyPatchedMachines?: null | number; groupIdentifier: string; id?: number; internetConnectivity?: null | number; managementSolution?: { _info?: {}; id?: null | number; name?: string; setupName?: string }; memoryUtilization?: null | number; missingMoreFivePatchesMachines?: null | number; missingOneTwoPatchesMachines?: null | number; missingSecurityPatches?: string; missingThreeFivePatchesMachines?: null | number; missingUnscannedPatchesMachines?: null | number; serverAvailability?: null | number; serversDiskSpaceLow?: null | number; serversOffline?: null | number; snmpMachines?: null | number; spywareItemsRemoved?: null | number; successfulBackupJobs?: null | number; totalManagedMachines?: null | number; totalNotifications?: null | number; totalServers?: null | number; totalWindowsServers?: null | number; totalWindowsWorkstations?: null | number; totalWorkstations?: null | number; virusesRemoved?: null | number; windowsPatchesInstalled?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional type?: string
      • Optional alertsGenerated?: string
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional cpuUtilization?: null | number

        Format: double

      • Optional deviceType?: null | "WorkstationsAndServers" | "BackupStats" | "Servers" | "Workstations"
        description

        deviceType is required if the managementSolution is Legacy

      • Optional diskCleanups?: null | number

        Format: int32

      • Optional diskDefragmentations?: null | number

        Format: int32

      • Optional diskSpaceCleanedMb?: null | number

        Format: int32

      • Optional failedBackupJobs?: null | number

        Format: int32

      • Optional fullyPatchedMachines?: null | number

        Format: int32

      • groupIdentifier: string
        description

        Max length: 100;

      • Optional id?: number

        Format: int32

      • Optional internetConnectivity?: null | number

        Format: double

      • Optional managementSolution?: { _info?: {}; id?: null | number; name?: string; setupName?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional setupName?: string
      • Optional memoryUtilization?: null | number

        Format: double

      • Optional missingMoreFivePatchesMachines?: null | number

        Format: int32

      • Optional missingOneTwoPatchesMachines?: null | number

        Format: int32

      • Optional missingSecurityPatches?: string
      • Optional missingThreeFivePatchesMachines?: null | number

        Format: int32

      • Optional missingUnscannedPatchesMachines?: null | number

        Format: int32

      • Optional serverAvailability?: null | number

        Format: int32

      • Optional serversDiskSpaceLow?: null | number

        Format: int32

      • Optional serversOffline?: null | number

        Format: int32

      • Optional snmpMachines?: null | number

        Format: int32

      • Optional spywareItemsRemoved?: null | number

        Format: int32

      • Optional successfulBackupJobs?: null | number

        Format: int32

      • Optional totalManagedMachines?: null | number

        Format: int32

      • Optional totalNotifications?: null | number

        Format: int32

      • Optional totalServers?: null | number

        Format: int32

      • Optional totalWindowsServers?: null | number

        Format: int32

      • Optional totalWindowsWorkstations?: null | number

        Format: int32

      • Optional totalWorkstations?: null | number

        Format: int32

      • Optional virusesRemoved?: null | number

        Format: int32

      • Optional windowsPatchesInstalled?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; alertsGenerated?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cpuUtilization?: null | number; deviceType?: null | "WorkstationsAndServers" | "BackupStats" | "Servers" | "Workstations"; diskCleanups?: null | number; diskDefragmentations?: null | number; diskSpaceCleanedMb?: null | number; failedBackupJobs?: null | number; fullyPatchedMachines?: null | number; groupIdentifier: string; id?: number; internetConnectivity?: null | number; managementSolution?: { _info?: {}; id?: null | number; name?: string; setupName?: string }; memoryUtilization?: null | number; missingMoreFivePatchesMachines?: null | number; missingOneTwoPatchesMachines?: null | number; missingSecurityPatches?: string; missingThreeFivePatchesMachines?: null | number; missingUnscannedPatchesMachines?: null | number; serverAvailability?: null | number; serversDiskSpaceLow?: null | number; serversOffline?: null | number; snmpMachines?: null | number; spywareItemsRemoved?: null | number; successfulBackupJobs?: null | number; totalManagedMachines?: null | number; totalNotifications?: null | number; totalServers?: null | number; totalWindowsServers?: null | number; totalWindowsWorkstations?: null | number; totalWorkstations?: null | number; virusesRemoved?: null | number; windowsPatchesInstalled?: null | number }>

postCompanyCompaniesByParentIdNotes

  • postCompanyCompaniesByParentIdNotes(parentId: number, companyNote: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • companyNote: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional enteredBy?: string
      • Optional flagged?: null | boolean
      • Optional id?: number

        Format: int32

      • text: string
      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

postCompanyCompaniesByParentIdSites

  • postCompanyCompaniesByParentIdSites(parentId: number, site: { _info?: {}; addressFormat?: string; addressLine1?: string; addressLine2?: string; billSeparateFlag?: null | boolean; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultBillingFlag?: null | boolean; defaultMailingFlag?: null | boolean; defaultShippingFlag?: null | boolean; entityType?: { _info?: {}; id?: null | number; name?: string }; expenseReimbursement?: null | number; faxNumber?: string; id?: number; inactiveFlag?: null | boolean; mobileGuid?: null | string; name: string; phoneNumber?: string; primaryAddressFlag?: null | boolean; stateReference?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string }; zip?: string }): Promise<{ _info?: {}; addressFormat?: string; addressLine1?: string; addressLine2?: string; billSeparateFlag?: null | boolean; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultBillingFlag?: null | boolean; defaultMailingFlag?: null | boolean; defaultShippingFlag?: null | boolean; entityType?: { _info?: {}; id?: null | number; name?: string }; expenseReimbursement?: null | number; faxNumber?: string; id?: number; inactiveFlag?: null | boolean; mobileGuid?: null | string; name: string; phoneNumber?: string; primaryAddressFlag?: null | boolean; stateReference?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string }; zip?: string }>

  • Parameters

    • parentId: number
    • site: { _info?: {}; addressFormat?: string; addressLine1?: string; addressLine2?: string; billSeparateFlag?: null | boolean; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultBillingFlag?: null | boolean; defaultMailingFlag?: null | boolean; defaultShippingFlag?: null | boolean; entityType?: { _info?: {}; id?: null | number; name?: string }; expenseReimbursement?: null | number; faxNumber?: string; id?: number; inactiveFlag?: null | boolean; mobileGuid?: null | string; name: string; phoneNumber?: string; primaryAddressFlag?: null | boolean; stateReference?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string }; zip?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addressFormat?: string
      • Optional addressLine1?: string
        description

        Max length: 50;

      • Optional addressLine2?: string
        description

        Max length: 50;

      • Optional billSeparateFlag?: null | boolean
      • Optional calendar?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional city?: string
        description

        Max length: 50;

      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional defaultBillingFlag?: null | boolean
      • Optional defaultMailingFlag?: null | boolean
      • Optional defaultShippingFlag?: null | boolean
      • Optional entityType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional expenseReimbursement?: null | number

        Format: double

      • Optional faxNumber?: string
        description

        Max length: 30;

      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • Optional mobileGuid?: null | string

        Format: uuid

      • name: string
        description

        Max length: 50;

      • Optional phoneNumber?: string
        description

        Max length: 30;

      • Optional primaryAddressFlag?: null | boolean
      • Optional stateReference?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional taxCode?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional timeZone?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional zip?: string
        description

        Max length: 12;

    Returns Promise<{ _info?: {}; addressFormat?: string; addressLine1?: string; addressLine2?: string; billSeparateFlag?: null | boolean; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultBillingFlag?: null | boolean; defaultMailingFlag?: null | boolean; defaultShippingFlag?: null | boolean; entityType?: { _info?: {}; id?: null | number; name?: string }; expenseReimbursement?: null | number; faxNumber?: string; id?: number; inactiveFlag?: null | boolean; mobileGuid?: null | string; name: string; phoneNumber?: string; primaryAddressFlag?: null | boolean; stateReference?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string }; zip?: string }>

postCompanyCompaniesByParentIdTeams

  • postCompanyCompaniesByParentIdTeams(parentId: number, companyTeam: { _info?: {}; accountManagerFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; salesFlag?: null | boolean; teamRole?: { _info?: {}; id?: null | number; name?: string }; techFlag?: null | boolean }): Promise<{ _info?: {}; accountManagerFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; salesFlag?: null | boolean; teamRole?: { _info?: {}; id?: null | number; name?: string }; techFlag?: null | boolean }>

  • Parameters

    • parentId: number
    • companyTeam: { _info?: {}; accountManagerFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; salesFlag?: null | boolean; teamRole?: { _info?: {}; id?: null | number; name?: string }; techFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional accountManagerFlag?: null | boolean
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional contact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional location?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional salesFlag?: null | boolean
      • Optional teamRole?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional techFlag?: null | boolean

    Returns Promise<{ _info?: {}; accountManagerFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; salesFlag?: null | boolean; teamRole?: { _info?: {}; id?: null | number; name?: string }; techFlag?: null | boolean }>

postCompanyCompaniesByParentIdTracks

  • postCompanyCompaniesByParentIdTracks(parentId: number, track: { _info?: {}; actionRemaining?: null | number; actionTaken?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; endDate?: string; id?: number; name?: string; startDate?: string; startedBy?: string; trackId?: number }): Promise<{ _info?: {}; actionRemaining?: null | number; actionTaken?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; endDate?: string; id?: number; name?: string; startDate?: string; startedBy?: string; trackId?: number }>

  • Parameters

    • parentId: number
    • track: { _info?: {}; actionRemaining?: null | number; actionTaken?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; endDate?: string; id?: number; name?: string; startDate?: string; startedBy?: string; trackId?: number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional actionRemaining?: null | number

        Format: int32

      • Optional actionTaken?: null | number

        Format: int32

      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional contact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional endDate?: string
      • Optional id?: number

        Format: int32

      • Optional name?: string
      • Optional startDate?: string
      • Optional startedBy?: string
      • Optional trackId?: number

        Format: int32

    Returns Promise<{ _info?: {}; actionRemaining?: null | number; actionTaken?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; endDate?: string; id?: number; name?: string; startDate?: string; startedBy?: string; trackId?: number }>

postCompanyCompaniesByParentIdTypeAssociations

  • postCompanyCompaniesByParentIdTypeAssociations(parentId: number, companyTypeAssociation: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • companyTypeAssociation: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

postCompanyCompaniesStatuses

  • postCompanyCompaniesStatuses(companyStatus: { _info?: {}; cancelOpenTracksFlag?: null | boolean; customNoteFlag?: null | boolean; defaultFlag?: null | boolean; disallowSavingFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; notificationMessage?: string; notifyFlag?: null | boolean; track?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; cancelOpenTracksFlag?: null | boolean; customNoteFlag?: null | boolean; defaultFlag?: null | boolean; disallowSavingFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; notificationMessage?: string; notifyFlag?: null | boolean; track?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • companyStatus: { _info?: {}; cancelOpenTracksFlag?: null | boolean; customNoteFlag?: null | boolean; defaultFlag?: null | boolean; disallowSavingFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; notificationMessage?: string; notifyFlag?: null | boolean; track?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional cancelOpenTracksFlag?: null | boolean
      • Optional customNoteFlag?: null | boolean
      • Optional defaultFlag?: null | boolean
      • Optional disallowSavingFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • name: string
        description

        Max length: 50;

      • Optional notificationMessage?: string
        description

        Max length: 500;

      • Optional notifyFlag?: null | boolean
      • Optional track?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; cancelOpenTracksFlag?: null | boolean; customNoteFlag?: null | boolean; defaultFlag?: null | boolean; disallowSavingFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; notificationMessage?: string; notifyFlag?: null | boolean; track?: { _info?: {}; id?: null | number; name?: string } }>

postCompanyCompaniesTypes

  • postCompanyCompaniesTypes(companyType: { _info?: {}; defaultFlag?: null | boolean; id?: number; name: string; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string; vendorFlag?: null | boolean }): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string; vendorFlag?: null | boolean }>

  • Parameters

    • companyType: { _info?: {}; defaultFlag?: null | boolean; id?: number; name: string; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string; vendorFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional defaultFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 50;

      • Optional serviceAlertFlag?: null | boolean
      • Optional serviceAlertMessage?: string
        description

        Max length: 150;

      • Optional vendorFlag?: null | boolean

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string; vendorFlag?: null | boolean }>

postCompanyCompanyPickerItems

  • postCompanyCompanyPickerItems(companyPickerItem: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; companySite?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorPickerFlag?: null | boolean }): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; companySite?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorPickerFlag?: null | boolean }>

  • Parameters

    • companyPickerItem: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; companySite?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorPickerFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional companyCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional companyLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional companySite?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional companyStatus?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional companyType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional vendorPickerFlag?: null | boolean
        description

        If true, this record was created by the vendor picker component. Otherwise, the record was created by the company picker component.

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; companySite?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorPickerFlag?: null | boolean }>

postCompanyCompanyPickerItemsClear

  • postCompanyCompanyPickerItemsClear(clearPickerRequest: { member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: null | "Company" | "Vendor" }): Promise<undefined>

  • Parameters

    • clearPickerRequest: { member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: null | "Company" | "Vendor" }
      • Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional type?: null | "Company" | "Vendor"

    Returns Promise<undefined>

postCompanyCompanyTypeAssociations

  • postCompanyCompanyTypeAssociations(companyTypeAssociation: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • companyTypeAssociation: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

postCompanyConfigurations

  • postCompanyConfigurations(configuration: { _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }, params?: CommonParameters): Promise<{ _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }>

  • Parameters

    • configuration: { _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional activeFlag?: null | boolean
      • Optional backupBillableSpaceGb?: null | number

        Format: double

      • Optional backupFailed?: null | number

        Format: int32

      • Optional backupIncomplete?: null | number

        Format: int32

      • Optional backupMonth?: null | number

        Format: int32

      • Optional backupProtectedDeviceList?: string
      • Optional backupRestores?: null | number

        Format: int32

      • Optional backupServerName?: string
        description

        Max length: 50;

      • Optional backupSuccesses?: null | number

        Format: int32

      • Optional backupYear?: null | number

        Format: int32

      • Optional billFlag?: null | boolean
      • Optional businessUnitId?: null | number

        Format: int32

      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional companyLocationId?: null | number

        Format: int32

      • Optional contact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional cpuSpeed?: string
        description

        Max length: 100;

      • Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
      • Optional defaultGateway?: string
        description

        Max length: 50;

      • Optional deviceIdentifier?: string
        description

        Max length: 100;

      • Optional displayVendorFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional installationDate?: string

        Format: date-time

      • Optional installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional ipAddress?: string
        description

        Max length: 50;

      • Optional lastBackupDate?: string

        Format: date-time

      • Optional lastLoginName?: string
        description

        Max length: 100;

      • Optional localHardDrives?: string
      • Optional locationId?: null | number

        Format: int32

      • Optional macAddress?: string
        description

        Max length: 25;

      • Optional managementLink?: string
        description

        Max length: 1000;

      • Optional manufacturer?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional manufacturerPartNumber?: string
        description

        Max length: 50;

      • Optional mobileGuid?: null | string

        Format: uuid

      • Optional modelNumber?: string
        description

        Max length: 50;

      • name: string
        description

        Max length: 100;

      • Optional needsRenewalFlag?: null | boolean
      • Optional notes?: string
      • Optional osInfo?: string
        description

        Max length: 250;

      • Optional osType?: string
        description

        Max length: 250;

      • Optional parentConfigurationId?: null | number

        Format: int32

      • Optional purchaseDate?: string

        Format: date-time

      • Optional questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]
      • Optional ram?: string
        description

        Max length: 25;

      • Optional remoteLink?: string
        description

        Max length: 1000;

      • Optional serialNumber?: string
        description

        Max length: 250;

      • Optional showAutomateFlag?: null | boolean
      • Optional showRemoteFlag?: null | boolean
      • Optional site?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional sla?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional status?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional tagNumber?: string
        description

        Max length: 50;

      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional vendorNotes?: string
      • Optional warrantyExpirationDate?: string

        Format: date-time

    • params: CommonParameters = {}

    Returns Promise<{ _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }>

postCompanyConfigurationsBulk

  • postCompanyConfigurationsBulk(companyConfigurations: { _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }[]): Promise<{ _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }>

  • Parameters

    • companyConfigurations: { _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }[]

    Returns Promise<{ _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }>

postCompanyConfigurationsStatuses

  • postCompanyConfigurationsStatuses(configurationStatus: { _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; description: string; id?: number }): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; description: string; id?: number }>

  • Parameters

    • configurationStatus: { _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; description: string; id?: number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional closedFlag?: null | boolean
      • Optional defaultFlag?: null | boolean
      • description: string
        description

        Max length: 50;

      • Optional id?: number

        Format: int32

    Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; description: string; id?: number }>

postCompanyConfigurationsTypes

  • postCompanyConfigurationsTypes(configurationType: { _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; systemFlag?: null | boolean }): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; systemFlag?: null | boolean }>

  • Parameters

    • configurationType: { _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; systemFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • name: string
        description

        Max length: 50;

      • Optional systemFlag?: null | boolean

    Returns Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; systemFlag?: null | boolean }>

postCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValues

  • postCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValues(parentId: number, grandparentId: number, configurationTypeQuestionValue: { _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; question?: { _info?: {}; id?: null | number; question?: string }; value: string }): Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; question?: { _info?: {}; id?: null | number; question?: string }; value: string }>

  • Parameters

    • parentId: number
    • grandparentId: number
    • configurationTypeQuestionValue: { _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; question?: { _info?: {}; id?: null | number; question?: string }; value: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional configurationType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional defaultFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • Optional question?: { _info?: {}; id?: null | number; question?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional question?: string
      • value: string
        description

        Max length: 1000;

    Returns Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; question?: { _info?: {}; id?: null | number; question?: string }; value: string }>

postCompanyConfigurationsTypesByParentIdQuestions

  • postCompanyConfigurationsTypesByParentIdQuestions(parentId: number, configurationTypeQuestion: { _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question: string; requiredFlag?: null | boolean; sequenceNumber: null | number }): Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question: string; requiredFlag?: null | boolean; sequenceNumber: null | number }>

  • Parameters

    • parentId: number
    • configurationTypeQuestion: { _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question: string; requiredFlag?: null | boolean; sequenceNumber: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional configurationType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • entryType: null | "Date" | "EntryField" | "List" | "Option"
      • fieldType: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • Optional numberOfDecimals?: null | number

        Format: int32

      • question: string
        description

        Max length: 1000;

      • Optional requiredFlag?: null | boolean
      • sequenceNumber: null | number

        Format: double

    Returns Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question: string; requiredFlag?: null | boolean; sequenceNumber: null | number }>

postCompanyContactTypeAssociations

  • postCompanyContactTypeAssociations(contactTypeAssociation: { _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • contactTypeAssociation: { _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional contact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

postCompanyContacts

  • postCompanyContacts(contact: { _info?: {}; addressLine1?: string; addressLine2?: string; anniversary?: string; assistantContact?: { _info?: {}; id?: null | number; name?: string }; birthDay?: string; children?: string; childrenFlag?: null | boolean; city?: string; communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultBillingFlag?: null | boolean; defaultFlag?: null | boolean; defaultMergeContactId?: null | number; defaultPhoneExtension?: string; defaultPhoneNbr?: string; defaultPhoneType?: string; department?: { _info?: {}; id?: null | number; name?: string }; disablePortalLoginFlag?: null | boolean; facebookUrl?: string; firstName?: string; gender?: null | "Female" | "Male"; id?: number; ignoreDuplicates?: boolean; inactiveFlag?: null | boolean; integratorTags?: string[]; lastName?: string; linkedInUrl?: string; managerContact?: { _info?: {}; id?: null | number; name?: string }; marriedFlag?: null | boolean; mobileGuid?: null | string; nickName?: string; photo?: { _info?: {}; id?: null | number; name?: string }; portalPassword?: string; portalSecurityLevel?: null | number; presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"; relationship?: { _info?: {}; id?: null | number; name?: string }; relationshipOverride?: string; school?: string; securityIdentifier?: string; significantOther?: string; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; title?: string; twitterUrl?: string; typeIds?: number[]; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; zip?: string }): Promise<{ _info?: {}; addressLine1?: string; addressLine2?: string; anniversary?: string; assistantContact?: { _info?: {}; id?: null | number; name?: string }; birthDay?: string; children?: string; childrenFlag?: null | boolean; city?: string; communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultBillingFlag?: null | boolean; defaultFlag?: null | boolean; defaultMergeContactId?: null | number; defaultPhoneExtension?: string; defaultPhoneNbr?: string; defaultPhoneType?: string; department?: { _info?: {}; id?: null | number; name?: string }; disablePortalLoginFlag?: null | boolean; facebookUrl?: string; firstName?: string; gender?: null | "Female" | "Male"; id?: number; ignoreDuplicates?: boolean; inactiveFlag?: null | boolean; integratorTags?: string[]; lastName?: string; linkedInUrl?: string; managerContact?: { _info?: {}; id?: null | number; name?: string }; marriedFlag?: null | boolean; mobileGuid?: null | string; nickName?: string; photo?: { _info?: {}; id?: null | number; name?: string }; portalPassword?: string; portalSecurityLevel?: null | number; presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"; relationship?: { _info?: {}; id?: null | number; name?: string }; relationshipOverride?: string; school?: string; securityIdentifier?: string; significantOther?: string; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; title?: string; twitterUrl?: string; typeIds?: number[]; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; zip?: string }>

  • Parameters

    • contact: { _info?: {}; addressLine1?: string; addressLine2?: string; anniversary?: string; assistantContact?: { _info?: {}; id?: null | number; name?: string }; birthDay?: string; children?: string; childrenFlag?: null | boolean; city?: string; communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultBillingFlag?: null | boolean; defaultFlag?: null | boolean; defaultMergeContactId?: null | number; defaultPhoneExtension?: string; defaultPhoneNbr?: string; defaultPhoneType?: string; department?: { _info?: {}; id?: null | number; name?: string }; disablePortalLoginFlag?: null | boolean; facebookUrl?: string; firstName?: string; gender?: null | "Female" | "Male"; id?: number; ignoreDuplicates?: boolean; inactiveFlag?: null | boolean; integratorTags?: string[]; lastName?: string; linkedInUrl?: string; managerContact?: { _info?: {}; id?: null | number; name?: string }; marriedFlag?: null | boolean; mobileGuid?: null | string; nickName?: string; photo?: { _info?: {}; id?: null | number; name?: string }; portalPassword?: string; portalSecurityLevel?: null | number; presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"; relationship?: { _info?: {}; id?: null | number; name?: string }; relationshipOverride?: string; school?: string; securityIdentifier?: string; significantOther?: string; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; title?: string; twitterUrl?: string; typeIds?: number[]; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; zip?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addressLine1?: string
      • Optional addressLine2?: string
      • Optional anniversary?: string
      • Optional assistantContact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional birthDay?: string
      • Optional children?: string
      • Optional childrenFlag?: null | boolean
      • Optional city?: string
      • Optional communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional companyLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
      • Optional defaultBillingFlag?: null | boolean
      • Optional defaultFlag?: null | boolean
      • Optional defaultMergeContactId?: null | number

        Format: int32

      • Optional defaultPhoneExtension?: string
      • Optional defaultPhoneNbr?: string
      • Optional defaultPhoneType?: string
      • Optional department?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional disablePortalLoginFlag?: null | boolean
      • Optional facebookUrl?: string
      • Optional firstName?: string
      • Optional gender?: null | "Female" | "Male"
      • Optional id?: number

        Format: int32

      • Optional ignoreDuplicates?: boolean
      • Optional inactiveFlag?: null | boolean
      • Optional integratorTags?: string[]
      • Optional lastName?: string
      • Optional linkedInUrl?: string
      • Optional managerContact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional marriedFlag?: null | boolean
      • Optional mobileGuid?: null | string

        Format: uuid

      • Optional nickName?: string
      • Optional photo?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional portalPassword?: string
      • Optional portalSecurityLevel?: null | number

        Format: int32

      • Optional presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"
      • Optional relationship?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional relationshipOverride?: string
      • Optional school?: string
      • Optional securityIdentifier?: string
      • Optional significantOther?: string
      • Optional site?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional state?: string
      • Optional title?: string
      • Optional twitterUrl?: string
      • Optional typeIds?: number[]
        description

        Integrer array of Contact_Type_Recids to be assigned to contact that can be passed in only during new contact creation (post) To update existing contacts type, use the /company/contactTypeAssociations or /company/contacts/{ID}/typeAssociations endpoints

      • Optional types?: { _info?: {}; id?: null | number; name?: string }[]
      • Optional unsubscribeFlag?: null | boolean
      • Optional userDefinedField1?: string
        description

        Max length: 50;

      • Optional userDefinedField10?: string
        description

        Max length: 50;

      • Optional userDefinedField2?: string
        description

        Max length: 50;

      • Optional userDefinedField3?: string
        description

        Max length: 50;

      • Optional userDefinedField4?: string
        description

        Max length: 50;

      • Optional userDefinedField5?: string
        description

        Max length: 50;

      • Optional userDefinedField6?: string
        description

        Max length: 50;

      • Optional userDefinedField7?: string
        description

        Max length: 50;

      • Optional userDefinedField8?: string
        description

        Max length: 50;

      • Optional userDefinedField9?: string
        description

        Max length: 50;

      • Optional zip?: string

    Returns Promise<{ _info?: {}; addressLine1?: string; addressLine2?: string; anniversary?: string; assistantContact?: { _info?: {}; id?: null | number; name?: string }; birthDay?: string; children?: string; childrenFlag?: null | boolean; city?: string; communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultBillingFlag?: null | boolean; defaultFlag?: null | boolean; defaultMergeContactId?: null | number; defaultPhoneExtension?: string; defaultPhoneNbr?: string; defaultPhoneType?: string; department?: { _info?: {}; id?: null | number; name?: string }; disablePortalLoginFlag?: null | boolean; facebookUrl?: string; firstName?: string; gender?: null | "Female" | "Male"; id?: number; ignoreDuplicates?: boolean; inactiveFlag?: null | boolean; integratorTags?: string[]; lastName?: string; linkedInUrl?: string; managerContact?: { _info?: {}; id?: null | number; name?: string }; marriedFlag?: null | boolean; mobileGuid?: null | string; nickName?: string; photo?: { _info?: {}; id?: null | number; name?: string }; portalPassword?: string; portalSecurityLevel?: null | number; presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"; relationship?: { _info?: {}; id?: null | number; name?: string }; relationshipOverride?: string; school?: string; securityIdentifier?: string; significantOther?: string; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; title?: string; twitterUrl?: string; typeIds?: number[]; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; zip?: string }>

postCompanyContactsByParentIdCommunications

  • postCompanyContactsByParentIdCommunications(parentId: number, contactCommunication: { _info?: {}; communicationType?: null | "Email" | "Fax" | "Phone"; contactId?: null | number; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; mobileGuid?: null | string; type?: { _info?: {}; id?: null | number; name?: string }; value: string }): Promise<{ _info?: {}; communicationType?: null | "Email" | "Fax" | "Phone"; contactId?: null | number; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; mobileGuid?: null | string; type?: { _info?: {}; id?: null | number; name?: string }; value: string }>

  • Parameters

    • parentId: number
    • contactCommunication: { _info?: {}; communicationType?: null | "Email" | "Fax" | "Phone"; contactId?: null | number; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; mobileGuid?: null | string; type?: { _info?: {}; id?: null | number; name?: string }; value: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional communicationType?: null | "Email" | "Fax" | "Phone"
      • Optional contactId?: null | number

        Format: int32

      • Optional defaultFlag?: null | boolean
      • Optional domain?: string
      • Optional extension?: string
        description

        Max length: 15;

      • Optional id?: number

        Format: int32

      • Optional mobileGuid?: null | string

        Format: uuid

      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • value: string
        description

        Max length: 250;

    Returns Promise<{ _info?: {}; communicationType?: null | "Email" | "Fax" | "Phone"; contactId?: null | number; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; mobileGuid?: null | string; type?: { _info?: {}; id?: null | number; name?: string }; value: string }>

postCompanyContactsByParentIdGroups

  • postCompanyContactsByParentIdGroups(parentId: number, contactGroup: { _info?: {}; companyGroupUnsubscribedEmailMessage?: string; companyUnsubcribedEmailMessage?: string; contact?: { _info?: {}; id?: null | number; name?: string }; contactGroupUnsubscribedEmailMessage?: string; contactUnsubscribedEmailMessage?: string; description?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; unsubscribeFlag?: null | boolean }): Promise<{ _info?: {}; companyGroupUnsubscribedEmailMessage?: string; companyUnsubcribedEmailMessage?: string; contact?: { _info?: {}; id?: null | number; name?: string }; contactGroupUnsubscribedEmailMessage?: string; contactUnsubscribedEmailMessage?: string; description?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; unsubscribeFlag?: null | boolean }>

  • Parameters

    • parentId: number
    • contactGroup: { _info?: {}; companyGroupUnsubscribedEmailMessage?: string; companyUnsubcribedEmailMessage?: string; contact?: { _info?: {}; id?: null | number; name?: string }; contactGroupUnsubscribedEmailMessage?: string; contactUnsubscribedEmailMessage?: string; description?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; unsubscribeFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional companyGroupUnsubscribedEmailMessage?: string
      • Optional companyUnsubcribedEmailMessage?: string
      • Optional contact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional contactGroupUnsubscribedEmailMessage?: string
      • Optional contactUnsubscribedEmailMessage?: string
      • Optional description?: string
        description

        Max length: 50;

      • Optional group?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional unsubscribeFlag?: null | boolean

    Returns Promise<{ _info?: {}; companyGroupUnsubscribedEmailMessage?: string; companyUnsubcribedEmailMessage?: string; contact?: { _info?: {}; id?: null | number; name?: string }; contactGroupUnsubscribedEmailMessage?: string; contactUnsubscribedEmailMessage?: string; description?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; unsubscribeFlag?: null | boolean }>

postCompanyContactsByParentIdNotes

  • postCompanyContactsByParentIdNotes(parentId: number, contactNote: { _info?: {}; contactId?: null | number; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; contactId?: null | number; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • contactNote: { _info?: {}; contactId?: null | number; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional contactId?: null | number

        Format: int32

      • Optional enteredBy?: string
      • Optional flagged?: null | boolean
      • Optional id?: number

        Format: int32

      • text: string
      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; contactId?: null | number; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

postCompanyContactsByParentIdTracks

  • postCompanyContactsByParentIdTracks(parentId: number, track: { _info?: {}; actionRemaining?: null | number; actionTaken?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; endDate?: string; id?: number; name?: string; startDate?: string; startedBy?: string; trackId?: number }): Promise<{ _info?: {}; actionRemaining?: null | number; actionTaken?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; endDate?: string; id?: number; name?: string; startDate?: string; startedBy?: string; trackId?: number }>

  • Parameters

    • parentId: number
    • track: { _info?: {}; actionRemaining?: null | number; actionTaken?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; endDate?: string; id?: number; name?: string; startDate?: string; startedBy?: string; trackId?: number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional actionRemaining?: null | number

        Format: int32

      • Optional actionTaken?: null | number

        Format: int32

      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional contact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional endDate?: string
      • Optional id?: number

        Format: int32

      • Optional name?: string
      • Optional startDate?: string
      • Optional startedBy?: string
      • Optional trackId?: number

        Format: int32

    Returns Promise<{ _info?: {}; actionRemaining?: null | number; actionTaken?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; endDate?: string; id?: number; name?: string; startDate?: string; startedBy?: string; trackId?: number }>

postCompanyContactsByParentIdTypeAssociations

  • postCompanyContactsByParentIdTypeAssociations(parentId: number, contactTypeAssociation: { _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • contactTypeAssociation: { _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional contact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

postCompanyContactsDepartments

  • postCompanyContactsDepartments(contactDepartment: { _info?: {}; id?: number; name: string }): Promise<{ _info?: {}; id?: number; name: string }>

  • Parameters

    • contactDepartment: { _info?: {}; id?: number; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 30;

    Returns Promise<{ _info?: {}; id?: number; name: string }>

postCompanyContactsRelationships

  • postCompanyContactsRelationships(contactRelationship: { _info?: {}; id?: number; name: string }): Promise<{ _info?: {}; id?: number; name: string }>

  • Parameters

    • contactRelationship: { _info?: {}; id?: number; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; id?: number; name: string }>

postCompanyContactsRequestPassword

  • postCompanyContactsRequestPassword(request: { email: string }): Promise<undefined>

postCompanyContactsTypes

  • postCompanyContactsTypes(contactType: { _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }): Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }>

  • Parameters

    • contactType: { _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional defaultFlag?: null | boolean
      • description: string
        description

        Max length: 50;

      • Optional id?: number

        Format: int32

      • Optional serviceAlertFlag?: null | boolean
      • Optional serviceAlertMessage?: string
        description

        Max length: 150;

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }>

postCompanyContactsValidatePortalCredentials

  • postCompanyContactsValidatePortalCredentials(request: { email: string; password: string }): Promise<{ contactId?: number; success?: boolean }>

  • Parameters

    • request: { email: string; password: string }
      • email: string
      • password: string

    Returns Promise<{ contactId?: number; success?: boolean }>

postCompanyCountries

  • postCompanyCountries(country: { _info?: {}; addressFormat?: { _info?: {}; id?: null | number; name?: string }; cityCaption?: string; countryCode?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; localizationValueOne?: string; name: string; stateCaption?: string; zipCaption?: string; zipMinimumLength?: null | number }): Promise<{ _info?: {}; addressFormat?: { _info?: {}; id?: null | number; name?: string }; cityCaption?: string; countryCode?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; localizationValueOne?: string; name: string; stateCaption?: string; zipCaption?: string; zipMinimumLength?: null | number }>

  • Parameters

    • country: { _info?: {}; addressFormat?: { _info?: {}; id?: null | number; name?: string }; cityCaption?: string; countryCode?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; localizationValueOne?: string; name: string; stateCaption?: string; zipCaption?: string; zipMinimumLength?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addressFormat?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional cityCaption?: string
        description

        Max length: 25;

      • Optional countryCode?: string
        description

        Max length: 2;

      • Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional currencyCode?: string
        • Optional currencyIdentifier?: string
        • Optional decimalSeparator?: string
        • Optional displayIdFlag?: boolean
        • Optional displaySymbolFlag?: boolean
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional negativeParenthesesFlag?: boolean
        • Optional numberOfDecimals?: number

          Format: int32

        • Optional rightAlign?: boolean
        • Optional symbol?: string
        • Optional thousandsSeparator?: string
      • Optional defaultFlag?: null | boolean
      • Optional dialingPrefix?: string
        description

        Max length: 5;

      • Optional id?: number

        Format: int32

      • Optional localizationCaptionOne?: string
        description

        Max length: 25;

      • Optional localizationValueOne?: string
        description

        Max length: 50;

      • name: string
        description

        Max length: 50;

      • Optional stateCaption?: string
        description

        Max length: 25;

      • Optional zipCaption?: string
        description

        Max length: 25;

      • Optional zipMinimumLength?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; addressFormat?: { _info?: {}; id?: null | number; name?: string }; cityCaption?: string; countryCode?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; localizationValueOne?: string; name: string; stateCaption?: string; zipCaption?: string; zipMinimumLength?: null | number }>

postCompanyManagedDevicesIntegrations

  • postCompanyManagedDevicesIntegrations(managedDevicesIntegration: { _info?: {}; configBillCustomerFlag?: null | boolean; defaultBillingLevel: null | "Detail" | "Summary"; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; disableNewCrossReferencesFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; loginBy: null | "Global" | "Member"; managementItSetupType?: string; matchOnSerialNumberFlag?: null | boolean; name: string; portalUrl?: string; solution: string }): Promise<{ _info?: {}; configBillCustomerFlag?: null | boolean; defaultBillingLevel: null | "Detail" | "Summary"; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; disableNewCrossReferencesFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; loginBy: null | "Global" | "Member"; managementItSetupType?: string; matchOnSerialNumberFlag?: null | boolean; name: string; portalUrl?: string; solution: string }>

  • Parameters

    • managedDevicesIntegration: { _info?: {}; configBillCustomerFlag?: null | boolean; defaultBillingLevel: null | "Detail" | "Summary"; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; disableNewCrossReferencesFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; loginBy: null | "Global" | "Member"; managementItSetupType?: string; matchOnSerialNumberFlag?: null | boolean; name: string; portalUrl?: string; solution: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional configBillCustomerFlag?: null | boolean
      • defaultBillingLevel: null | "Detail" | "Summary"
      • Optional defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional defaultLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional disableNewCrossReferencesFlag?: null | boolean
      • Optional globalLoginPassword?: string
        description

        This is only required when globalLoginFlag = true Max length: 50;

      • Optional globalLoginUsername?: string
        description

        This is only required when globalLoginFlag = true Max length: 50;

      • Optional id?: number

        Format: int32

      • Optional integratorLogin?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • loginBy: null | "Global" | "Member"
      • Optional managementItSetupType?: string
      • Optional matchOnSerialNumberFlag?: null | boolean
      • name: string
        description

        Max length: 30;

      • Optional portalUrl?: string
        description

        Max length: 200;

      • solution: string
        description

        Max length: 30;

    Returns Promise<{ _info?: {}; configBillCustomerFlag?: null | boolean; defaultBillingLevel: null | "Detail" | "Summary"; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; disableNewCrossReferencesFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; loginBy: null | "Global" | "Member"; managementItSetupType?: string; matchOnSerialNumberFlag?: null | boolean; name: string; portalUrl?: string; solution: string }>

postCompanyManagedDevicesIntegrationsByParentIdCrossReferences

  • postCompanyManagedDevicesIntegrationsByParentIdCrossReferences(parentId: number, crossReference: { _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; vendorLevel?: string; vendorType?: string }): Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; vendorLevel?: string; vendorType?: string }>

  • Parameters

    • parentId: number
    • crossReference: { _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; vendorLevel?: string; vendorType?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional configurationType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • Optional managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional serializedFlag?: null | boolean
      • Optional vendorLevel?: string
        description

        Max length: 255;

      • Optional vendorType?: string
        description

        Max length: 255;

    Returns Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; vendorLevel?: string; vendorType?: string }>

postCompanyManagedDevicesIntegrationsByParentIdLogins

  • postCompanyManagedDevicesIntegrationsByParentIdLogins(parentId: number, login: { _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; password?: string; username: string }): Promise<{ _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; password?: string; username: string }>

  • Parameters

    • parentId: number
    • login: { _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; password?: string; username: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional password?: string
        description

        Max length: 50;

      • username: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; password?: string; username: string }>

postCompanyManagedDevicesIntegrationsByParentIdNotifications

  • postCompanyManagedDevicesIntegrationsByParentIdNotifications(parentId: number, notification: { _info?: {}; id?: number; logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; id?: number; logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • parentId: number
    • notification: { _info?: {}; id?: number; logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"
      • Optional managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string

    Returns Promise<{ _info?: {}; id?: number; logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

postCompanyManagementBackups

  • postCompanyManagementBackups(managementBackup: { _info?: {}; billingLevel: null | "Detail" | "Summary"; id?: number; item?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; billingLevel: null | "Detail" | "Summary"; id?: number; item?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • managementBackup: { _info?: {}; billingLevel: null | "Detail" | "Summary"; id?: number; item?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • billingLevel: null | "Detail" | "Summary"
      • Optional id?: number

        Format: int32

      • Optional item?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; billingLevel: null | "Detail" | "Summary"; id?: number; item?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

postCompanyManagementByIdExecuteManagedItSync

  • postCompanyManagementByIdExecuteManagedItSync(id: number): Promise<{ message?: string; success?: boolean }>

postCompanyManagementByParentIdManagementReportNotifications

  • postCompanyManagementByParentIdManagementReportNotifications(parentId: number, managementReportNotification: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • parentId: number
    • managementReportNotification: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional email?: string
        description

        Max length: 50;

      • Optional globalFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

postCompanyManagementItSolutions

  • postCompanyManagementItSolutions(managementItSolution: { _info?: {}; continuumApiPassword?: string; continuumApiUsername?: string; globalLoginFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; levelApiPassword?: string; levelApiUsername?: string; levelVarDomain?: string; managementItSolutionType: null | "LevelPlatforms" | "NAble" | "Continuum" | "Custom"; managementServerUrl?: string; managementSolutionName?: string; nAblePassword?: string; nAbleUsername?: string; name: string; noDisplayFlag?: null | boolean; overrideLoginLocationFlag?: null | boolean; overrideWebServiceLocationFlag?: null | boolean; portalOverrideLoginUrl?: string; usingSslFlag?: null | boolean; webserviceOverrideUrl?: string }): Promise<{ _info?: {}; continuumApiPassword?: string; continuumApiUsername?: string; globalLoginFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; levelApiPassword?: string; levelApiUsername?: string; levelVarDomain?: string; managementItSolutionType: null | "LevelPlatforms" | "NAble" | "Continuum" | "Custom"; managementServerUrl?: string; managementSolutionName?: string; nAblePassword?: string; nAbleUsername?: string; name: string; noDisplayFlag?: null | boolean; overrideLoginLocationFlag?: null | boolean; overrideWebServiceLocationFlag?: null | boolean; portalOverrideLoginUrl?: string; usingSslFlag?: null | boolean; webserviceOverrideUrl?: string }>

  • Parameters

    • managementItSolution: { _info?: {}; continuumApiPassword?: string; continuumApiUsername?: string; globalLoginFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; levelApiPassword?: string; levelApiUsername?: string; levelVarDomain?: string; managementItSolutionType: null | "LevelPlatforms" | "NAble" | "Continuum" | "Custom"; managementServerUrl?: string; managementSolutionName?: string; nAblePassword?: string; nAbleUsername?: string; name: string; noDisplayFlag?: null | boolean; overrideLoginLocationFlag?: null | boolean; overrideWebServiceLocationFlag?: null | boolean; portalOverrideLoginUrl?: string; usingSslFlag?: null | boolean; webserviceOverrideUrl?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional continuumApiPassword?: string
        description

        This is only required for Continuum solution Max length: 100;

      • Optional continuumApiUsername?: string
        description

        This is only required for Continuum solution Max length: 100;

      • Optional globalLoginFlag?: null | boolean
      • Optional globalLoginPassword?: string
        description

        This is only required when globalLoginFlag = true Max length: 50;

      • Optional globalLoginUsername?: string
        description

        This is only required when globalLoginFlag = true Max length: 50;

      • Optional id?: number

        Format: int32

      • Optional levelApiPassword?: string
        description

        This is only required for Level Platforms solution Max length: 100;

      • Optional levelApiUsername?: string
        description

        This is only required for Level Platforms solution Max length: 100;

      • Optional levelVarDomain?: string
        description

        This is only required for Level Platforms solution Max length: 100;

      • managementItSolutionType: null | "LevelPlatforms" | "NAble" | "Continuum" | "Custom"
      • Optional managementServerUrl?: string
        description

        This is only required for Level Platforms Max length: 200;

      • Optional managementSolutionName?: string
        description

        This is only required when managementItSolutionType is Custom Max length: 30;

      • Optional nAblePassword?: string
        description

        This is only required for N-Able solution Max length: 50;

      • Optional nAbleUsername?: string
        description

        This is only required for N-Able solution Max length: 50;

      • name: string
        description

        Max length: 30;

      • Optional noDisplayFlag?: null | boolean
      • Optional overrideLoginLocationFlag?: null | boolean
      • Optional overrideWebServiceLocationFlag?: null | boolean
      • Optional portalOverrideLoginUrl?: string
        description

        This is only required for Level Platforms when overrideLoginLocationFlag is true Max length: 200;

      • Optional usingSslFlag?: null | boolean
      • Optional webserviceOverrideUrl?: string
        description

        This is only required for Level Platforms when overrideWebServiceLocationFlag is true Max length: 200;

    Returns Promise<{ _info?: {}; continuumApiPassword?: string; continuumApiUsername?: string; globalLoginFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; levelApiPassword?: string; levelApiUsername?: string; levelVarDomain?: string; managementItSolutionType: null | "LevelPlatforms" | "NAble" | "Continuum" | "Custom"; managementServerUrl?: string; managementSolutionName?: string; nAblePassword?: string; nAbleUsername?: string; name: string; noDisplayFlag?: null | boolean; overrideLoginLocationFlag?: null | boolean; overrideWebServiceLocationFlag?: null | boolean; portalOverrideLoginUrl?: string; usingSslFlag?: null | boolean; webserviceOverrideUrl?: string }>

postCompanyManagementItSolutionsByParentIdManagementProducts

  • postCompanyManagementItSolutionsByParentIdManagementProducts(parentId: number, managementProduct: { _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean } }): Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean } }>

  • Parameters

    • parentId: number
    • managementProduct: { _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional serializedFlag?: null | boolean
      • Optional spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional serializedFlag?: null | boolean
      • Optional workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional serializedFlag?: null | boolean

    Returns Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean } }>

postCompanyMarketDescriptions

  • postCompanyMarketDescriptions(marketDescription: { _info?: {}; id?: number; name: string }): Promise<{ _info?: {}; id?: number; name: string }>

  • Parameters

    • marketDescription: { _info?: {}; id?: number; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; id?: number; name: string }>

postCompanyNoteTypes

  • postCompanyNoteTypes(noteType: { _info?: {}; defaultFlag?: null | boolean; id?: number; identifier?: string; importFlag?: null | boolean; name: string }): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; identifier?: string; importFlag?: null | boolean; name: string }>

  • Parameters

    • noteType: { _info?: {}; defaultFlag?: null | boolean; id?: number; identifier?: string; importFlag?: null | boolean; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional defaultFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional identifier?: string
        description

        Max length: 15;

      • Optional importFlag?: null | boolean
      • name: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; identifier?: string; importFlag?: null | boolean; name: string }>

postCompanyOwnershipTypes

  • postCompanyOwnershipTypes(ownershipType: { _info?: {}; id?: number; name: string }): Promise<{ _info?: {}; id?: number; name: string }>

  • Parameters

    • ownershipType: { _info?: {}; id?: number; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 200;

    Returns Promise<{ _info?: {}; id?: number; name: string }>

postCompanyPortalConfigurations

  • postCompanyPortalConfigurations(portalConfiguration: { _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }): Promise<{ _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }>

  • Parameters

    • portalConfiguration: { _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementTypeIds?: number[]
      • Optional boardIds?: number[]
      • Optional buttonColor?: string
        description

        Max length: 7;

      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional configTypeIds?: number[]
      • Optional defaultFlag?: null | boolean
      • Optional displayVendorFlag?: null | boolean
      • Optional headerColor?: string
        description

        Max length: 7;

      • Optional id?: number

        Format: int32

        description

        An existing Portal Configuration id is required when copying a Portal Configuration.

      • Optional language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"
      • Optional locationIds?: number[]
      • Optional loginBackgroundColor?: string
        description

        Max length: 7;

      • Optional menuColor?: string
        description

        Max length: 7;

      • name: string
        description

        Max length: 150;

      • Optional portalBackgroundColor?: string
        description

        Max length: 7;

      • Optional portalImageCopySuccessFlag?: null | boolean
      • Optional url?: string
        description

        Max length: 1000;

      • Optional welcomeText?: string
        description

        Max length: 4000;

    Returns Promise<{ _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }>

postCompanyPortalConfigurationsByParentIdInvoiceSetupsByIdTestTransaction

  • postCompanyPortalConfigurationsByParentIdInvoiceSetupsByIdTestTransaction(id: number, parentId: number, portalConfigurationInvoiceSetup: { _info?: {}; addAllStatuses?: null | boolean; allowInvPmtFlag?: null | boolean; billingStatusIds?: number[]; displayInvPmtFlag?: null | boolean; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; login?: string; password?: string; paymentProcessor?: { _info?: {}; id?: null | number; name?: string }; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; removeAllStatuses?: null | boolean; urlOverride?: string }): Promise<{ message?: string; success?: boolean }>

  • Parameters

    • id: number
    • parentId: number
    • portalConfigurationInvoiceSetup: { _info?: {}; addAllStatuses?: null | boolean; allowInvPmtFlag?: null | boolean; billingStatusIds?: number[]; displayInvPmtFlag?: null | boolean; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; login?: string; password?: string; paymentProcessor?: { _info?: {}; id?: null | number; name?: string }; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; removeAllStatuses?: null | boolean; urlOverride?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addAllStatuses?: null | boolean
      • Optional allowInvPmtFlag?: null | boolean
      • Optional billingStatusIds?: number[]
      • Optional displayInvPmtFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional location?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional login?: string
      • Optional password?: string
      • Optional paymentProcessor?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional portalConfiguration?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional removeAllStatuses?: null | boolean
      • Optional urlOverride?: string

    Returns Promise<{ message?: string; success?: boolean }>

postCompanyPortalConfigurationsCopy

  • postCompanyPortalConfigurationsCopy(copy: { _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }): Promise<{ _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }>

  • Parameters

    • copy: { _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementTypeIds?: number[]
      • Optional boardIds?: number[]
      • Optional buttonColor?: string
        description

        Max length: 7;

      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional configTypeIds?: number[]
      • Optional defaultFlag?: null | boolean
      • Optional displayVendorFlag?: null | boolean
      • Optional headerColor?: string
        description

        Max length: 7;

      • Optional id?: number

        Format: int32

        description

        An existing Portal Configuration id is required when copying a Portal Configuration.

      • Optional language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"
      • Optional locationIds?: number[]
      • Optional loginBackgroundColor?: string
        description

        Max length: 7;

      • Optional menuColor?: string
        description

        Max length: 7;

      • name: string
        description

        Max length: 150;

      • Optional portalBackgroundColor?: string
        description

        Max length: 7;

      • Optional portalImageCopySuccessFlag?: null | boolean
      • Optional url?: string
        description

        Max length: 1000;

      • Optional welcomeText?: string
        description

        Max length: 4000;

    Returns Promise<{ _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }>

postCompanyStates

  • postCompanyStates(state: { _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier: string; name: string }): Promise<{ _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier: string; name: string }>

  • Parameters

    • state: { _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier: string; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional id?: number

        Format: int32

      • identifier: string
        description

        Max length: 50;

      • name: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier: string; name: string }>

postCompanyTeamRoles

  • postCompanyTeamRoles(teamRole: { _info?: {}; accountManagerFlag?: null | boolean; id?: number; name: string; salesFlag?: null | boolean; techFlag?: null | boolean }): Promise<{ _info?: {}; accountManagerFlag?: null | boolean; id?: number; name: string; salesFlag?: null | boolean; techFlag?: null | boolean }>

  • Parameters

    • teamRole: { _info?: {}; accountManagerFlag?: null | boolean; id?: number; name: string; salesFlag?: null | boolean; techFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional accountManagerFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 20;

      • Optional salesFlag?: null | boolean
      • Optional techFlag?: null | boolean

    Returns Promise<{ _info?: {}; accountManagerFlag?: null | boolean; id?: number; name: string; salesFlag?: null | boolean; techFlag?: null | boolean }>

postCompanyTracks

  • postCompanyTracks(track: { _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; notifyActionIds?: number[] }): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; notifyActionIds?: number[] }>

  • Parameters

    • track: { _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; notifyActionIds?: number[] }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • name: string
        description

        Max length: 100;

      • Optional notifyActionIds?: number[]

    Returns Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; notifyActionIds?: number[] }>

postCompanyTracksByParentIdActions

  • postCompanyTracksByParentIdActions(parentId: number, trackAction: { _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: "CreateActivity" | "SendEmail" | "AddToGroup" | "AttachTrack" | "ChangeCompanyStatus" | "CreateServiceTicket"; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subject?: string; track?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: "CreateActivity" | "SendEmail" | "AddToGroup" | "AttachTrack" | "ChangeCompanyStatus" | "CreateServiceTicket"; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subject?: string; track?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • trackAction: { _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: "CreateActivity" | "SendEmail" | "AddToGroup" | "AttachTrack" | "ChangeCompanyStatus" | "CreateServiceTicket"; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subject?: string; track?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional activityStatus?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional activityType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional attachedTrack?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional bccContact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional ccContact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional companyStatus?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional daysToExecute?: null | number

        Format: int32

      • Optional emailFrom?: string
        description

        Max length: 250;

      • Optional emailRecipient?: string
        description

        Max length: 250;

      • Optional group?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional notes?: string
      • Optional notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • notifyType: "CreateActivity" | "SendEmail" | "AddToGroup" | "AttachTrack" | "ChangeCompanyStatus" | "CreateServiceTicket"
      • Optional notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional summary?: string
      • Optional specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional subject?: string
        description

        Max length: 100;

      • Optional track?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: "CreateActivity" | "SendEmail" | "AddToGroup" | "AttachTrack" | "ChangeCompanyStatus" | "CreateServiceTicket"; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subject?: string; track?: { _info?: {}; id?: null | number; name?: string } }>

putCompanyAddressFormatsById

  • putCompanyAddressFormatsById(id: number, addressFormat: { _info?: {}; addAllCountries?: null | boolean; countryIds?: number[]; defaultFlag?: null | boolean; format: string; id?: number; name: string; removeAllCountries?: null | boolean }): Promise<{ _info?: {}; addAllCountries?: null | boolean; countryIds?: number[]; defaultFlag?: null | boolean; format: string; id?: number; name: string; removeAllCountries?: null | boolean }>

  • Parameters

    • id: number
    • addressFormat: { _info?: {}; addAllCountries?: null | boolean; countryIds?: number[]; defaultFlag?: null | boolean; format: string; id?: number; name: string; removeAllCountries?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addAllCountries?: null | boolean
      • Optional countryIds?: number[]
      • Optional defaultFlag?: null | boolean
      • format: string
        description

        Max length: 250;

      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 50;

      • Optional removeAllCountries?: null | boolean

    Returns Promise<{ _info?: {}; addAllCountries?: null | boolean; countryIds?: number[]; defaultFlag?: null | boolean; format: string; id?: number; name: string; removeAllCountries?: null | boolean }>

putCompanyCommunicationTypesById

  • putCompanyCommunicationTypesById(id: number, communicationType: { _info?: {}; androidXref: string; defaultFlag?: null | boolean; description: string; emailFlag?: null | boolean; exchangeXref?: string; faxFlag?: null | boolean; googleXref?: string; id?: number; iphoneXref: string; phoneFlag?: null | boolean }): Promise<{ _info?: {}; androidXref: string; defaultFlag?: null | boolean; description: string; emailFlag?: null | boolean; exchangeXref?: string; faxFlag?: null | boolean; googleXref?: string; id?: number; iphoneXref: string; phoneFlag?: null | boolean }>

  • Parameters

    • id: number
    • communicationType: { _info?: {}; androidXref: string; defaultFlag?: null | boolean; description: string; emailFlag?: null | boolean; exchangeXref?: string; faxFlag?: null | boolean; googleXref?: string; id?: number; iphoneXref: string; phoneFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • androidXref: string
        description

        Max length: 50;

      • Optional defaultFlag?: null | boolean
      • description: string
      • Optional emailFlag?: null | boolean
        description

        At least one flag is required to be true -- phone, fax, or email

      • Optional exchangeXref?: string
        description

        Exchange Xref required if phone or fax Max length: 50;

      • Optional faxFlag?: null | boolean
        description

        At least one flag is required to be true -- phone, fax, or email

      • Optional googleXref?: string
        description

        Google Xref required if phone or fax Max length: 50;

      • Optional id?: number

        Format: int32

      • iphoneXref: string
        description

        Max length: 50;

      • Optional phoneFlag?: null | boolean
        description

        At least one flag is required to be true -- phone, fax, or email

    Returns Promise<{ _info?: {}; androidXref: string; defaultFlag?: null | boolean; description: string; emailFlag?: null | boolean; exchangeXref?: string; faxFlag?: null | boolean; googleXref?: string; id?: number; iphoneXref: string; phoneFlag?: null | boolean }>

putCompanyCompaniesById

  • putCompanyCompaniesById(id: number, company: { _info?: {}; accountNumber?: string; addressLine1?: string; addressLine2?: string; annualRevenue?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingContact?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; companyEntityType?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateAcquired?: string; dateDeleted?: string; defaultContact?: { _info?: {}; id?: null | number; name?: string }; deletedBy?: string; deletedFlag?: null | boolean; facebookUrl?: string; faxNumber?: string; id?: number; identifier: string; integratorTags?: string[]; invoiceCCEmailAddress?: string; invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoiceToEmailAddress?: string; isVendorFlag?: null | boolean; leadFlag?: null | boolean; leadSource?: string; linkedInUrl?: string; market?: { _info?: {}; id?: null | number; name?: string }; mobileGuid?: null | string; name: string; numberOfEmployees?: null | number; ownershipType?: { _info?: {}; id?: null | number; name?: string }; parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; phoneNumber?: string; pricingSchedule?: { _info?: {}; id?: null | number; name?: string }; resellerIdentifier?: string; revenueYear?: null | number; sicCode?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxIdentifier?: string; territory?: { _info?: {}; id?: null | number; name?: string }; territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; twitterUrl?: string; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; vendorIdentifier?: string; website?: string; yearEstablished?: null | number; zip?: string }): Promise<{ _info?: {}; accountNumber?: string; addressLine1?: string; addressLine2?: string; annualRevenue?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingContact?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; companyEntityType?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateAcquired?: string; dateDeleted?: string; defaultContact?: { _info?: {}; id?: null | number; name?: string }; deletedBy?: string; deletedFlag?: null | boolean; facebookUrl?: string; faxNumber?: string; id?: number; identifier: string; integratorTags?: string[]; invoiceCCEmailAddress?: string; invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoiceToEmailAddress?: string; isVendorFlag?: null | boolean; leadFlag?: null | boolean; leadSource?: string; linkedInUrl?: string; market?: { _info?: {}; id?: null | number; name?: string }; mobileGuid?: null | string; name: string; numberOfEmployees?: null | number; ownershipType?: { _info?: {}; id?: null | number; name?: string }; parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; phoneNumber?: string; pricingSchedule?: { _info?: {}; id?: null | number; name?: string }; resellerIdentifier?: string; revenueYear?: null | number; sicCode?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxIdentifier?: string; territory?: { _info?: {}; id?: null | number; name?: string }; territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; twitterUrl?: string; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; vendorIdentifier?: string; website?: string; yearEstablished?: null | number; zip?: string }>

  • Parameters

    • id: number
    • company: { _info?: {}; accountNumber?: string; addressLine1?: string; addressLine2?: string; annualRevenue?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingContact?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; companyEntityType?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateAcquired?: string; dateDeleted?: string; defaultContact?: { _info?: {}; id?: null | number; name?: string }; deletedBy?: string; deletedFlag?: null | boolean; facebookUrl?: string; faxNumber?: string; id?: number; identifier: string; integratorTags?: string[]; invoiceCCEmailAddress?: string; invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoiceToEmailAddress?: string; isVendorFlag?: null | boolean; leadFlag?: null | boolean; leadSource?: string; linkedInUrl?: string; market?: { _info?: {}; id?: null | number; name?: string }; mobileGuid?: null | string; name: string; numberOfEmployees?: null | number; ownershipType?: { _info?: {}; id?: null | number; name?: string }; parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; phoneNumber?: string; pricingSchedule?: { _info?: {}; id?: null | number; name?: string }; resellerIdentifier?: string; revenueYear?: null | number; sicCode?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxIdentifier?: string; territory?: { _info?: {}; id?: null | number; name?: string }; territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; twitterUrl?: string; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; vendorIdentifier?: string; website?: string; yearEstablished?: null | number; zip?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional accountNumber?: string
      • Optional addressLine1?: string
        description

        At least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country Max length: 50;

      • Optional addressLine2?: string
        description

        At least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country Max length: 50;

      • Optional annualRevenue?: null | number

        Format: double

      • Optional billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional billingContact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional billingSite?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional billingTerms?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional calendar?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional city?: string
        description

        At least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country Max length: 50;

      • Optional companyEntityType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional currencyCode?: string
        • Optional currencyIdentifier?: string
        • Optional decimalSeparator?: string
        • Optional displayIdFlag?: boolean
        • Optional displaySymbolFlag?: boolean
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional negativeParenthesesFlag?: boolean
        • Optional numberOfDecimals?: number

          Format: int32

        • Optional rightAlign?: boolean
        • Optional symbol?: string
        • Optional thousandsSeparator?: string
      • Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
      • Optional dateAcquired?: string

        Format: date-time

      • Optional dateDeleted?: string

        Format: date-time

      • Optional defaultContact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional deletedBy?: string
      • Optional deletedFlag?: null | boolean
      • Optional facebookUrl?: string
      • Optional faxNumber?: string
        description

        Max length: 30;

      • Optional id?: number

        Format: int32

      • identifier: string
        description

        Max length: 25;

      • Optional integratorTags?: string[]
      • Optional invoiceCCEmailAddress?: string
      • Optional invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional invoiceToEmailAddress?: string
      • Optional isVendorFlag?: null | boolean
      • Optional leadFlag?: null | boolean
      • Optional leadSource?: string
        description

        Max length: 50;

      • Optional linkedInUrl?: string
      • Optional market?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional mobileGuid?: null | string

        Format: uuid

      • name: string
        description

        Max length: 50;

      • Optional numberOfEmployees?: null | number

        Format: int32

      • Optional ownershipType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional phoneNumber?: string
        description

        Max length: 30;

      • Optional pricingSchedule?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional resellerIdentifier?: string
      • Optional revenueYear?: null | number

        Format: int32

      • Optional sicCode?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional site?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional state?: string
        description

        At least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country Max length: 50;

      • Optional status?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional taxCode?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional taxIdentifier?: string
      • Optional territory?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional twitterUrl?: string
      • Optional types?: { _info?: {}; id?: null | number; name?: string }[]
        description

        Integrer array of Company_Type_Recids to be assigned to company that can be passed in only during new company creation (post) To update existing companies type, use the /company/companyTypeAssociations or /company/companies/{ID}/typeAssociations endpoints

      • Optional unsubscribeFlag?: null | boolean
      • Optional userDefinedField1?: string
        description

        Max length: 50;

      • Optional userDefinedField10?: string
        description

        Max length: 50;

      • Optional userDefinedField2?: string
        description

        Max length: 50;

      • Optional userDefinedField3?: string
        description

        Max length: 50;

      • Optional userDefinedField4?: string
        description

        Max length: 50;

      • Optional userDefinedField5?: string
        description

        Max length: 50;

      • Optional userDefinedField6?: string
        description

        Max length: 50;

      • Optional userDefinedField7?: string
        description

        Max length: 50;

      • Optional userDefinedField8?: string
        description

        Max length: 50;

      • Optional userDefinedField9?: string
        description

        Max length: 50;

      • Optional vendorIdentifier?: string
      • Optional website?: string
        description

        Max length: 255;

      • Optional yearEstablished?: null | number

        Format: int32

      • Optional zip?: string
        description

        At least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country Max length: 12;

    Returns Promise<{ _info?: {}; accountNumber?: string; addressLine1?: string; addressLine2?: string; annualRevenue?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingContact?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; companyEntityType?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateAcquired?: string; dateDeleted?: string; defaultContact?: { _info?: {}; id?: null | number; name?: string }; deletedBy?: string; deletedFlag?: null | boolean; facebookUrl?: string; faxNumber?: string; id?: number; identifier: string; integratorTags?: string[]; invoiceCCEmailAddress?: string; invoiceDeliveryMethod?: { _info?: {}; id?: null | number; name?: string }; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoiceToEmailAddress?: string; isVendorFlag?: null | boolean; leadFlag?: null | boolean; leadSource?: string; linkedInUrl?: string; market?: { _info?: {}; id?: null | number; name?: string }; mobileGuid?: null | string; name: string; numberOfEmployees?: null | number; ownershipType?: { _info?: {}; id?: null | number; name?: string }; parentCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; phoneNumber?: string; pricingSchedule?: { _info?: {}; id?: null | number; name?: string }; resellerIdentifier?: string; revenueYear?: null | number; sicCode?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxIdentifier?: string; territory?: { _info?: {}; id?: null | number; name?: string }; territoryManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; twitterUrl?: string; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; vendorIdentifier?: string; website?: string; yearEstablished?: null | number; zip?: string }>

putCompanyCompaniesByParentIdCustomStatusNotesById

  • putCompanyCompaniesByParentIdCustomStatusNotesById(id: number, parentId: number, customNote: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customNote: string; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customNote: string; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • customNote: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customNote: string; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • customNote: string
        description

        Max length: 1500;

      • Optional id?: number

        Format: int32

      • Optional status?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customNote: string; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }>

putCompanyCompaniesByParentIdGroupsById

  • putCompanyCompaniesByParentIdGroupsById(id: number, parentId: number, companyGroup: { _info?: {}; allContactsFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contactIds?: number[]; defaultContactFlag?: null | boolean; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; removeAllContactsFlag?: null | boolean; unsubscribeFlag?: null | boolean }): Promise<{ _info?: {}; allContactsFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contactIds?: number[]; defaultContactFlag?: null | boolean; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; removeAllContactsFlag?: null | boolean; unsubscribeFlag?: null | boolean }>

  • Parameters

    • id: number
    • parentId: number
    • companyGroup: { _info?: {}; allContactsFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contactIds?: number[]; defaultContactFlag?: null | boolean; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; removeAllContactsFlag?: null | boolean; unsubscribeFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional allContactsFlag?: null | boolean
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional contactIds?: number[]
      • Optional defaultContactFlag?: null | boolean
      • Optional group?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

        description

        Required On Updates;

      • Optional removeAllContactsFlag?: null | boolean
      • Optional unsubscribeFlag?: null | boolean

    Returns Promise<{ _info?: {}; allContactsFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contactIds?: number[]; defaultContactFlag?: null | boolean; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; removeAllContactsFlag?: null | boolean; unsubscribeFlag?: null | boolean }>

putCompanyCompaniesByParentIdManagementReportNotificationsById

  • putCompanyCompaniesByParentIdManagementReportNotificationsById(id: number, parentId: number, managementReportNotification: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • managementReportNotification: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional email?: string
        description

        Max length: 50;

      • Optional globalFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

putCompanyCompaniesByParentIdManagementReportSetupById

  • putCompanyCompaniesByParentIdManagementReportSetupById(id: number, parentId: number, managementReportSetup: { _info?: {}; id?: number; scheduledReportDisabledFlag: boolean }): Promise<{ _info?: {}; id?: number; scheduledReportDisabledFlag: boolean }>

  • Parameters

    • id: number
    • parentId: number
    • managementReportSetup: { _info?: {}; id?: number; scheduledReportDisabledFlag: boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • scheduledReportDisabledFlag: boolean

    Returns Promise<{ _info?: {}; id?: number; scheduledReportDisabledFlag: boolean }>

putCompanyCompaniesByParentIdManagementSummaryReportsById

  • putCompanyCompaniesByParentIdManagementSummaryReportsById(id: number, parentId: number, managementSummary: { _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; alertsGenerated?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cpuUtilization?: null | number; deviceType?: null | "WorkstationsAndServers" | "BackupStats" | "Servers" | "Workstations"; diskCleanups?: null | number; diskDefragmentations?: null | number; diskSpaceCleanedMb?: null | number; failedBackupJobs?: null | number; fullyPatchedMachines?: null | number; groupIdentifier: string; id?: number; internetConnectivity?: null | number; managementSolution?: { _info?: {}; id?: null | number; name?: string; setupName?: string }; memoryUtilization?: null | number; missingMoreFivePatchesMachines?: null | number; missingOneTwoPatchesMachines?: null | number; missingSecurityPatches?: string; missingThreeFivePatchesMachines?: null | number; missingUnscannedPatchesMachines?: null | number; serverAvailability?: null | number; serversDiskSpaceLow?: null | number; serversOffline?: null | number; snmpMachines?: null | number; spywareItemsRemoved?: null | number; successfulBackupJobs?: null | number; totalManagedMachines?: null | number; totalNotifications?: null | number; totalServers?: null | number; totalWindowsServers?: null | number; totalWindowsWorkstations?: null | number; totalWorkstations?: null | number; virusesRemoved?: null | number; windowsPatchesInstalled?: null | number }): Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; alertsGenerated?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cpuUtilization?: null | number; deviceType?: null | "WorkstationsAndServers" | "BackupStats" | "Servers" | "Workstations"; diskCleanups?: null | number; diskDefragmentations?: null | number; diskSpaceCleanedMb?: null | number; failedBackupJobs?: null | number; fullyPatchedMachines?: null | number; groupIdentifier: string; id?: number; internetConnectivity?: null | number; managementSolution?: { _info?: {}; id?: null | number; name?: string; setupName?: string }; memoryUtilization?: null | number; missingMoreFivePatchesMachines?: null | number; missingOneTwoPatchesMachines?: null | number; missingSecurityPatches?: string; missingThreeFivePatchesMachines?: null | number; missingUnscannedPatchesMachines?: null | number; serverAvailability?: null | number; serversDiskSpaceLow?: null | number; serversOffline?: null | number; snmpMachines?: null | number; spywareItemsRemoved?: null | number; successfulBackupJobs?: null | number; totalManagedMachines?: null | number; totalNotifications?: null | number; totalServers?: null | number; totalWindowsServers?: null | number; totalWindowsWorkstations?: null | number; totalWorkstations?: null | number; virusesRemoved?: null | number; windowsPatchesInstalled?: null | number }>

  • Parameters

    • id: number
    • parentId: number
    • managementSummary: { _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; alertsGenerated?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cpuUtilization?: null | number; deviceType?: null | "WorkstationsAndServers" | "BackupStats" | "Servers" | "Workstations"; diskCleanups?: null | number; diskDefragmentations?: null | number; diskSpaceCleanedMb?: null | number; failedBackupJobs?: null | number; fullyPatchedMachines?: null | number; groupIdentifier: string; id?: number; internetConnectivity?: null | number; managementSolution?: { _info?: {}; id?: null | number; name?: string; setupName?: string }; memoryUtilization?: null | number; missingMoreFivePatchesMachines?: null | number; missingOneTwoPatchesMachines?: null | number; missingSecurityPatches?: string; missingThreeFivePatchesMachines?: null | number; missingUnscannedPatchesMachines?: null | number; serverAvailability?: null | number; serversDiskSpaceLow?: null | number; serversOffline?: null | number; snmpMachines?: null | number; spywareItemsRemoved?: null | number; successfulBackupJobs?: null | number; totalManagedMachines?: null | number; totalNotifications?: null | number; totalServers?: null | number; totalWindowsServers?: null | number; totalWindowsWorkstations?: null | number; totalWorkstations?: null | number; virusesRemoved?: null | number; windowsPatchesInstalled?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional type?: string
      • Optional alertsGenerated?: string
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional cpuUtilization?: null | number

        Format: double

      • Optional deviceType?: null | "WorkstationsAndServers" | "BackupStats" | "Servers" | "Workstations"
        description

        deviceType is required if the managementSolution is Legacy

      • Optional diskCleanups?: null | number

        Format: int32

      • Optional diskDefragmentations?: null | number

        Format: int32

      • Optional diskSpaceCleanedMb?: null | number

        Format: int32

      • Optional failedBackupJobs?: null | number

        Format: int32

      • Optional fullyPatchedMachines?: null | number

        Format: int32

      • groupIdentifier: string
        description

        Max length: 100;

      • Optional id?: number

        Format: int32

      • Optional internetConnectivity?: null | number

        Format: double

      • Optional managementSolution?: { _info?: {}; id?: null | number; name?: string; setupName?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional setupName?: string
      • Optional memoryUtilization?: null | number

        Format: double

      • Optional missingMoreFivePatchesMachines?: null | number

        Format: int32

      • Optional missingOneTwoPatchesMachines?: null | number

        Format: int32

      • Optional missingSecurityPatches?: string
      • Optional missingThreeFivePatchesMachines?: null | number

        Format: int32

      • Optional missingUnscannedPatchesMachines?: null | number

        Format: int32

      • Optional serverAvailability?: null | number

        Format: int32

      • Optional serversDiskSpaceLow?: null | number

        Format: int32

      • Optional serversOffline?: null | number

        Format: int32

      • Optional snmpMachines?: null | number

        Format: int32

      • Optional spywareItemsRemoved?: null | number

        Format: int32

      • Optional successfulBackupJobs?: null | number

        Format: int32

      • Optional totalManagedMachines?: null | number

        Format: int32

      • Optional totalNotifications?: null | number

        Format: int32

      • Optional totalServers?: null | number

        Format: int32

      • Optional totalWindowsServers?: null | number

        Format: int32

      • Optional totalWindowsWorkstations?: null | number

        Format: int32

      • Optional totalWorkstations?: null | number

        Format: int32

      • Optional virusesRemoved?: null | number

        Format: int32

      • Optional windowsPatchesInstalled?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; alertsGenerated?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cpuUtilization?: null | number; deviceType?: null | "WorkstationsAndServers" | "BackupStats" | "Servers" | "Workstations"; diskCleanups?: null | number; diskDefragmentations?: null | number; diskSpaceCleanedMb?: null | number; failedBackupJobs?: null | number; fullyPatchedMachines?: null | number; groupIdentifier: string; id?: number; internetConnectivity?: null | number; managementSolution?: { _info?: {}; id?: null | number; name?: string; setupName?: string }; memoryUtilization?: null | number; missingMoreFivePatchesMachines?: null | number; missingOneTwoPatchesMachines?: null | number; missingSecurityPatches?: string; missingThreeFivePatchesMachines?: null | number; missingUnscannedPatchesMachines?: null | number; serverAvailability?: null | number; serversDiskSpaceLow?: null | number; serversOffline?: null | number; snmpMachines?: null | number; spywareItemsRemoved?: null | number; successfulBackupJobs?: null | number; totalManagedMachines?: null | number; totalNotifications?: null | number; totalServers?: null | number; totalWindowsServers?: null | number; totalWindowsWorkstations?: null | number; totalWorkstations?: null | number; virusesRemoved?: null | number; windowsPatchesInstalled?: null | number }>

putCompanyCompaniesByParentIdNotesById

  • putCompanyCompaniesByParentIdNotesById(id: number, parentId: number, companyNote: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • companyNote: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional enteredBy?: string
      • Optional flagged?: null | boolean
      • Optional id?: number

        Format: int32

      • text: string
      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

putCompanyCompaniesByParentIdSitesById

  • putCompanyCompaniesByParentIdSitesById(id: number, parentId: number, site: { _info?: {}; addressFormat?: string; addressLine1?: string; addressLine2?: string; billSeparateFlag?: null | boolean; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultBillingFlag?: null | boolean; defaultMailingFlag?: null | boolean; defaultShippingFlag?: null | boolean; entityType?: { _info?: {}; id?: null | number; name?: string }; expenseReimbursement?: null | number; faxNumber?: string; id?: number; inactiveFlag?: null | boolean; mobileGuid?: null | string; name: string; phoneNumber?: string; primaryAddressFlag?: null | boolean; stateReference?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string }; zip?: string }): Promise<{ _info?: {}; addressFormat?: string; addressLine1?: string; addressLine2?: string; billSeparateFlag?: null | boolean; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultBillingFlag?: null | boolean; defaultMailingFlag?: null | boolean; defaultShippingFlag?: null | boolean; entityType?: { _info?: {}; id?: null | number; name?: string }; expenseReimbursement?: null | number; faxNumber?: string; id?: number; inactiveFlag?: null | boolean; mobileGuid?: null | string; name: string; phoneNumber?: string; primaryAddressFlag?: null | boolean; stateReference?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string }; zip?: string }>

  • Parameters

    • id: number
    • parentId: number
    • site: { _info?: {}; addressFormat?: string; addressLine1?: string; addressLine2?: string; billSeparateFlag?: null | boolean; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultBillingFlag?: null | boolean; defaultMailingFlag?: null | boolean; defaultShippingFlag?: null | boolean; entityType?: { _info?: {}; id?: null | number; name?: string }; expenseReimbursement?: null | number; faxNumber?: string; id?: number; inactiveFlag?: null | boolean; mobileGuid?: null | string; name: string; phoneNumber?: string; primaryAddressFlag?: null | boolean; stateReference?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string }; zip?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addressFormat?: string
      • Optional addressLine1?: string
        description

        Max length: 50;

      • Optional addressLine2?: string
        description

        Max length: 50;

      • Optional billSeparateFlag?: null | boolean
      • Optional calendar?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional city?: string
        description

        Max length: 50;

      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional defaultBillingFlag?: null | boolean
      • Optional defaultMailingFlag?: null | boolean
      • Optional defaultShippingFlag?: null | boolean
      • Optional entityType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional expenseReimbursement?: null | number

        Format: double

      • Optional faxNumber?: string
        description

        Max length: 30;

      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • Optional mobileGuid?: null | string

        Format: uuid

      • name: string
        description

        Max length: 50;

      • Optional phoneNumber?: string
        description

        Max length: 30;

      • Optional primaryAddressFlag?: null | boolean
      • Optional stateReference?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional taxCode?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional timeZone?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional zip?: string
        description

        Max length: 12;

    Returns Promise<{ _info?: {}; addressFormat?: string; addressLine1?: string; addressLine2?: string; billSeparateFlag?: null | boolean; calendar?: { _info?: {}; id?: null | number; name?: string }; city?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultBillingFlag?: null | boolean; defaultMailingFlag?: null | boolean; defaultShippingFlag?: null | boolean; entityType?: { _info?: {}; id?: null | number; name?: string }; expenseReimbursement?: null | number; faxNumber?: string; id?: number; inactiveFlag?: null | boolean; mobileGuid?: null | string; name: string; phoneNumber?: string; primaryAddressFlag?: null | boolean; stateReference?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string }; zip?: string }>

putCompanyCompaniesByParentIdTeamsById

  • putCompanyCompaniesByParentIdTeamsById(id: number, parentId: number, companyTeam: { _info?: {}; accountManagerFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; salesFlag?: null | boolean; teamRole?: { _info?: {}; id?: null | number; name?: string }; techFlag?: null | boolean }): Promise<{ _info?: {}; accountManagerFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; salesFlag?: null | boolean; teamRole?: { _info?: {}; id?: null | number; name?: string }; techFlag?: null | boolean }>

  • Parameters

    • id: number
    • parentId: number
    • companyTeam: { _info?: {}; accountManagerFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; salesFlag?: null | boolean; teamRole?: { _info?: {}; id?: null | number; name?: string }; techFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional accountManagerFlag?: null | boolean
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional contact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional location?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional salesFlag?: null | boolean
      • Optional teamRole?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional techFlag?: null | boolean

    Returns Promise<{ _info?: {}; accountManagerFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; salesFlag?: null | boolean; teamRole?: { _info?: {}; id?: null | number; name?: string }; techFlag?: null | boolean }>

putCompanyCompaniesByParentIdTypeAssociationsById

  • putCompanyCompaniesByParentIdTypeAssociationsById(id: number, parentId: number, companyTypeAssociation: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • companyTypeAssociation: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

putCompanyCompaniesStatusesById

  • putCompanyCompaniesStatusesById(id: number, companyStatus: { _info?: {}; cancelOpenTracksFlag?: null | boolean; customNoteFlag?: null | boolean; defaultFlag?: null | boolean; disallowSavingFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; notificationMessage?: string; notifyFlag?: null | boolean; track?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; cancelOpenTracksFlag?: null | boolean; customNoteFlag?: null | boolean; defaultFlag?: null | boolean; disallowSavingFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; notificationMessage?: string; notifyFlag?: null | boolean; track?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • companyStatus: { _info?: {}; cancelOpenTracksFlag?: null | boolean; customNoteFlag?: null | boolean; defaultFlag?: null | boolean; disallowSavingFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; notificationMessage?: string; notifyFlag?: null | boolean; track?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional cancelOpenTracksFlag?: null | boolean
      • Optional customNoteFlag?: null | boolean
      • Optional defaultFlag?: null | boolean
      • Optional disallowSavingFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • name: string
        description

        Max length: 50;

      • Optional notificationMessage?: string
        description

        Max length: 500;

      • Optional notifyFlag?: null | boolean
      • Optional track?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; cancelOpenTracksFlag?: null | boolean; customNoteFlag?: null | boolean; defaultFlag?: null | boolean; disallowSavingFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; notificationMessage?: string; notifyFlag?: null | boolean; track?: { _info?: {}; id?: null | number; name?: string } }>

putCompanyCompaniesTypesById

  • putCompanyCompaniesTypesById(id: number, companyType: { _info?: {}; defaultFlag?: null | boolean; id?: number; name: string; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string; vendorFlag?: null | boolean }): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string; vendorFlag?: null | boolean }>

  • Parameters

    • id: number
    • companyType: { _info?: {}; defaultFlag?: null | boolean; id?: number; name: string; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string; vendorFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional defaultFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 50;

      • Optional serviceAlertFlag?: null | boolean
      • Optional serviceAlertMessage?: string
        description

        Max length: 150;

      • Optional vendorFlag?: null | boolean

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; name: string; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string; vendorFlag?: null | boolean }>

putCompanyCompanyFinanceById

  • putCompanyCompanyFinanceById(id: number, CompanyFinance: { _info?: {}; billCompletePmFlag?: null | boolean; billCompleteSrFlag?: null | boolean; billOverrideFlag?: null | boolean; billRestrictPmFlag?: null | boolean; billSrFlag?: null | boolean; billUnapprovedPmFlag?: null | boolean; billUnapprovedSrFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number }): Promise<{ _info?: {}; billCompletePmFlag?: null | boolean; billCompleteSrFlag?: null | boolean; billOverrideFlag?: null | boolean; billRestrictPmFlag?: null | boolean; billSrFlag?: null | boolean; billUnapprovedPmFlag?: null | boolean; billUnapprovedSrFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number }>

  • Parameters

    • id: number
    • CompanyFinance: { _info?: {}; billCompletePmFlag?: null | boolean; billCompleteSrFlag?: null | boolean; billOverrideFlag?: null | boolean; billRestrictPmFlag?: null | boolean; billSrFlag?: null | boolean; billUnapprovedPmFlag?: null | boolean; billUnapprovedSrFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional billCompletePmFlag?: null | boolean
      • Optional billCompleteSrFlag?: null | boolean
      • Optional billOverrideFlag?: null | boolean
      • Optional billRestrictPmFlag?: null | boolean
      • Optional billSrFlag?: null | boolean
      • Optional billUnapprovedPmFlag?: null | boolean
      • Optional billUnapprovedSrFlag?: null | boolean
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
      • Optional emailTemplate?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

    Returns Promise<{ _info?: {}; billCompletePmFlag?: null | boolean; billCompleteSrFlag?: null | boolean; billOverrideFlag?: null | boolean; billRestrictPmFlag?: null | boolean; billSrFlag?: null | boolean; billUnapprovedPmFlag?: null | boolean; billUnapprovedSrFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number }>

putCompanyCompanyTypeAssociationsById

  • putCompanyCompanyTypeAssociationsById(id: number, companyTypeAssociation: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • companyTypeAssociation: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

putCompanyConfigurationsBulk

  • putCompanyConfigurationsBulk(companyConfigurations: { _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }[]): Promise<{ _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }>

  • Parameters

    • companyConfigurations: { _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }[]

    Returns Promise<{ _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }>

putCompanyConfigurationsById

  • putCompanyConfigurationsById(id: number, configuration: { _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }, params?: CommonParameters): Promise<{ _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }>

  • Parameters

    • id: number
    • configuration: { _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional activeFlag?: null | boolean
      • Optional backupBillableSpaceGb?: null | number

        Format: double

      • Optional backupFailed?: null | number

        Format: int32

      • Optional backupIncomplete?: null | number

        Format: int32

      • Optional backupMonth?: null | number

        Format: int32

      • Optional backupProtectedDeviceList?: string
      • Optional backupRestores?: null | number

        Format: int32

      • Optional backupServerName?: string
        description

        Max length: 50;

      • Optional backupSuccesses?: null | number

        Format: int32

      • Optional backupYear?: null | number

        Format: int32

      • Optional billFlag?: null | boolean
      • Optional businessUnitId?: null | number

        Format: int32

      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional companyLocationId?: null | number

        Format: int32

      • Optional contact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional cpuSpeed?: string
        description

        Max length: 100;

      • Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
      • Optional defaultGateway?: string
        description

        Max length: 50;

      • Optional deviceIdentifier?: string
        description

        Max length: 100;

      • Optional displayVendorFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional installationDate?: string

        Format: date-time

      • Optional installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional ipAddress?: string
        description

        Max length: 50;

      • Optional lastBackupDate?: string

        Format: date-time

      • Optional lastLoginName?: string
        description

        Max length: 100;

      • Optional localHardDrives?: string
      • Optional locationId?: null | number

        Format: int32

      • Optional macAddress?: string
        description

        Max length: 25;

      • Optional managementLink?: string
        description

        Max length: 1000;

      • Optional manufacturer?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional manufacturerPartNumber?: string
        description

        Max length: 50;

      • Optional mobileGuid?: null | string

        Format: uuid

      • Optional modelNumber?: string
        description

        Max length: 50;

      • name: string
        description

        Max length: 100;

      • Optional needsRenewalFlag?: null | boolean
      • Optional notes?: string
      • Optional osInfo?: string
        description

        Max length: 250;

      • Optional osType?: string
        description

        Max length: 250;

      • Optional parentConfigurationId?: null | number

        Format: int32

      • Optional purchaseDate?: string

        Format: date-time

      • Optional questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]
      • Optional ram?: string
        description

        Max length: 25;

      • Optional remoteLink?: string
        description

        Max length: 1000;

      • Optional serialNumber?: string
        description

        Max length: 250;

      • Optional showAutomateFlag?: null | boolean
      • Optional showRemoteFlag?: null | boolean
      • Optional site?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional sla?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional status?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional tagNumber?: string
        description

        Max length: 50;

      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional vendorNotes?: string
      • Optional warrantyExpirationDate?: string

        Format: date-time

    • params: CommonParameters = {}

    Returns Promise<{ _info?: {}; activeFlag?: null | boolean; backupBillableSpaceGb?: null | number; backupFailed?: null | number; backupIncomplete?: null | number; backupMonth?: null | number; backupProtectedDeviceList?: string; backupRestores?: null | number; backupServerName?: string; backupSuccesses?: null | number; backupYear?: null | number; billFlag?: null | boolean; businessUnitId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; cpuSpeed?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultGateway?: string; deviceIdentifier?: string; displayVendorFlag?: null | boolean; id?: number; installationDate?: string; installedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ipAddress?: string; lastBackupDate?: string; lastLoginName?: string; localHardDrives?: string; locationId?: null | number; macAddress?: string; managementLink?: string; manufacturer?: { _info?: {}; id?: null | number; name?: string }; manufacturerPartNumber?: string; mobileGuid?: null | string; modelNumber?: string; name: string; needsRenewalFlag?: null | boolean; notes?: string; osInfo?: string; osType?: string; parentConfigurationId?: null | number; purchaseDate?: string; questions?: { answer?: {}; answerId?: null | number; fieldType?: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; numberOfDecimals?: null | number; question?: string; questionId?: null | number; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]; ram?: string; remoteLink?: string; serialNumber?: string; showAutomateFlag?: null | boolean; showRemoteFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; tagNumber?: string; type?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNotes?: string; warrantyExpirationDate?: string }>

putCompanyConfigurationsStatusesById

  • putCompanyConfigurationsStatusesById(id: number, configurationStatus: { _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; description: string; id?: number }): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; description: string; id?: number }>

  • Parameters

    • id: number
    • configurationStatus: { _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; description: string; id?: number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional closedFlag?: null | boolean
      • Optional defaultFlag?: null | boolean
      • description: string
        description

        Max length: 50;

      • Optional id?: number

        Format: int32

    Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; description: string; id?: number }>

putCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesById

  • putCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesById(id: number, parentId: number, grandparentId: number, configurationTypeQuestionValue: { _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; question?: { _info?: {}; id?: null | number; question?: string }; value: string }): Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; question?: { _info?: {}; id?: null | number; question?: string }; value: string }>

  • Parameters

    • id: number
    • parentId: number
    • grandparentId: number
    • configurationTypeQuestionValue: { _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; question?: { _info?: {}; id?: null | number; question?: string }; value: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional configurationType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional defaultFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • Optional question?: { _info?: {}; id?: null | number; question?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional question?: string
      • value: string
        description

        Max length: 1000;

    Returns Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; question?: { _info?: {}; id?: null | number; question?: string }; value: string }>

putCompanyConfigurationsTypesById

  • putCompanyConfigurationsTypesById(id: number, configurationType: { _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; systemFlag?: null | boolean }): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; systemFlag?: null | boolean }>

  • Parameters

    • id: number
    • configurationType: { _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; systemFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • name: string
        description

        Max length: 50;

      • Optional systemFlag?: null | boolean

    Returns Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; systemFlag?: null | boolean }>

putCompanyConfigurationsTypesByParentIdQuestionsById

  • putCompanyConfigurationsTypesByParentIdQuestionsById(id: number, parentId: number, configurationTypeQuestion: { _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question: string; requiredFlag?: null | boolean; sequenceNumber: null | number }): Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question: string; requiredFlag?: null | boolean; sequenceNumber: null | number }>

  • Parameters

    • id: number
    • parentId: number
    • configurationTypeQuestion: { _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question: string; requiredFlag?: null | boolean; sequenceNumber: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional configurationType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • entryType: null | "Date" | "EntryField" | "List" | "Option"
      • fieldType: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • Optional numberOfDecimals?: null | number

        Format: int32

      • question: string
        description

        Max length: 1000;

      • Optional requiredFlag?: null | boolean
      • sequenceNumber: null | number

        Format: double

    Returns Promise<{ _info?: {}; configurationType?: { _info?: {}; id?: null | number; name?: string }; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; id?: number; inactiveFlag?: null | boolean; numberOfDecimals?: null | number; question: string; requiredFlag?: null | boolean; sequenceNumber: null | number }>

putCompanyContactTypeAssociationsById

  • putCompanyContactTypeAssociationsById(id: number, contactTypeAssociation: { _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • contactTypeAssociation: { _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional contact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

putCompanyContactsById

  • putCompanyContactsById(id: number, contact: { _info?: {}; addressLine1?: string; addressLine2?: string; anniversary?: string; assistantContact?: { _info?: {}; id?: null | number; name?: string }; birthDay?: string; children?: string; childrenFlag?: null | boolean; city?: string; communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultBillingFlag?: null | boolean; defaultFlag?: null | boolean; defaultMergeContactId?: null | number; defaultPhoneExtension?: string; defaultPhoneNbr?: string; defaultPhoneType?: string; department?: { _info?: {}; id?: null | number; name?: string }; disablePortalLoginFlag?: null | boolean; facebookUrl?: string; firstName?: string; gender?: null | "Female" | "Male"; id?: number; ignoreDuplicates?: boolean; inactiveFlag?: null | boolean; integratorTags?: string[]; lastName?: string; linkedInUrl?: string; managerContact?: { _info?: {}; id?: null | number; name?: string }; marriedFlag?: null | boolean; mobileGuid?: null | string; nickName?: string; photo?: { _info?: {}; id?: null | number; name?: string }; portalPassword?: string; portalSecurityLevel?: null | number; presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"; relationship?: { _info?: {}; id?: null | number; name?: string }; relationshipOverride?: string; school?: string; securityIdentifier?: string; significantOther?: string; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; title?: string; twitterUrl?: string; typeIds?: number[]; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; zip?: string }): Promise<{ _info?: {}; addressLine1?: string; addressLine2?: string; anniversary?: string; assistantContact?: { _info?: {}; id?: null | number; name?: string }; birthDay?: string; children?: string; childrenFlag?: null | boolean; city?: string; communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultBillingFlag?: null | boolean; defaultFlag?: null | boolean; defaultMergeContactId?: null | number; defaultPhoneExtension?: string; defaultPhoneNbr?: string; defaultPhoneType?: string; department?: { _info?: {}; id?: null | number; name?: string }; disablePortalLoginFlag?: null | boolean; facebookUrl?: string; firstName?: string; gender?: null | "Female" | "Male"; id?: number; ignoreDuplicates?: boolean; inactiveFlag?: null | boolean; integratorTags?: string[]; lastName?: string; linkedInUrl?: string; managerContact?: { _info?: {}; id?: null | number; name?: string }; marriedFlag?: null | boolean; mobileGuid?: null | string; nickName?: string; photo?: { _info?: {}; id?: null | number; name?: string }; portalPassword?: string; portalSecurityLevel?: null | number; presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"; relationship?: { _info?: {}; id?: null | number; name?: string }; relationshipOverride?: string; school?: string; securityIdentifier?: string; significantOther?: string; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; title?: string; twitterUrl?: string; typeIds?: number[]; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; zip?: string }>

  • Parameters

    • id: number
    • contact: { _info?: {}; addressLine1?: string; addressLine2?: string; anniversary?: string; assistantContact?: { _info?: {}; id?: null | number; name?: string }; birthDay?: string; children?: string; childrenFlag?: null | boolean; city?: string; communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultBillingFlag?: null | boolean; defaultFlag?: null | boolean; defaultMergeContactId?: null | number; defaultPhoneExtension?: string; defaultPhoneNbr?: string; defaultPhoneType?: string; department?: { _info?: {}; id?: null | number; name?: string }; disablePortalLoginFlag?: null | boolean; facebookUrl?: string; firstName?: string; gender?: null | "Female" | "Male"; id?: number; ignoreDuplicates?: boolean; inactiveFlag?: null | boolean; integratorTags?: string[]; lastName?: string; linkedInUrl?: string; managerContact?: { _info?: {}; id?: null | number; name?: string }; marriedFlag?: null | boolean; mobileGuid?: null | string; nickName?: string; photo?: { _info?: {}; id?: null | number; name?: string }; portalPassword?: string; portalSecurityLevel?: null | number; presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"; relationship?: { _info?: {}; id?: null | number; name?: string }; relationshipOverride?: string; school?: string; securityIdentifier?: string; significantOther?: string; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; title?: string; twitterUrl?: string; typeIds?: number[]; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; zip?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addressLine1?: string
      • Optional addressLine2?: string
      • Optional anniversary?: string
      • Optional assistantContact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional birthDay?: string
      • Optional children?: string
      • Optional childrenFlag?: null | boolean
      • Optional city?: string
      • Optional communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional companyLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
      • Optional defaultBillingFlag?: null | boolean
      • Optional defaultFlag?: null | boolean
      • Optional defaultMergeContactId?: null | number

        Format: int32

      • Optional defaultPhoneExtension?: string
      • Optional defaultPhoneNbr?: string
      • Optional defaultPhoneType?: string
      • Optional department?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional disablePortalLoginFlag?: null | boolean
      • Optional facebookUrl?: string
      • Optional firstName?: string
      • Optional gender?: null | "Female" | "Male"
      • Optional id?: number

        Format: int32

      • Optional ignoreDuplicates?: boolean
      • Optional inactiveFlag?: null | boolean
      • Optional integratorTags?: string[]
      • Optional lastName?: string
      • Optional linkedInUrl?: string
      • Optional managerContact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional marriedFlag?: null | boolean
      • Optional mobileGuid?: null | string

        Format: uuid

      • Optional nickName?: string
      • Optional photo?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional portalPassword?: string
      • Optional portalSecurityLevel?: null | number

        Format: int32

      • Optional presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"
      • Optional relationship?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional relationshipOverride?: string
      • Optional school?: string
      • Optional securityIdentifier?: string
      • Optional significantOther?: string
      • Optional site?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional state?: string
      • Optional title?: string
      • Optional twitterUrl?: string
      • Optional typeIds?: number[]
        description

        Integrer array of Contact_Type_Recids to be assigned to contact that can be passed in only during new contact creation (post) To update existing contacts type, use the /company/contactTypeAssociations or /company/contacts/{ID}/typeAssociations endpoints

      • Optional types?: { _info?: {}; id?: null | number; name?: string }[]
      • Optional unsubscribeFlag?: null | boolean
      • Optional userDefinedField1?: string
        description

        Max length: 50;

      • Optional userDefinedField10?: string
        description

        Max length: 50;

      • Optional userDefinedField2?: string
        description

        Max length: 50;

      • Optional userDefinedField3?: string
        description

        Max length: 50;

      • Optional userDefinedField4?: string
        description

        Max length: 50;

      • Optional userDefinedField5?: string
        description

        Max length: 50;

      • Optional userDefinedField6?: string
        description

        Max length: 50;

      • Optional userDefinedField7?: string
        description

        Max length: 50;

      • Optional userDefinedField8?: string
        description

        Max length: 50;

      • Optional userDefinedField9?: string
        description

        Max length: 50;

      • Optional zip?: string

    Returns Promise<{ _info?: {}; addressLine1?: string; addressLine2?: string; anniversary?: string; assistantContact?: { _info?: {}; id?: null | number; name?: string }; birthDay?: string; children?: string; childrenFlag?: null | boolean; city?: string; communicationItems?: { communicationType?: null | "Email" | "Fax" | "Phone"; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; value?: string }[]; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; defaultBillingFlag?: null | boolean; defaultFlag?: null | boolean; defaultMergeContactId?: null | number; defaultPhoneExtension?: string; defaultPhoneNbr?: string; defaultPhoneType?: string; department?: { _info?: {}; id?: null | number; name?: string }; disablePortalLoginFlag?: null | boolean; facebookUrl?: string; firstName?: string; gender?: null | "Female" | "Male"; id?: number; ignoreDuplicates?: boolean; inactiveFlag?: null | boolean; integratorTags?: string[]; lastName?: string; linkedInUrl?: string; managerContact?: { _info?: {}; id?: null | number; name?: string }; marriedFlag?: null | boolean; mobileGuid?: null | string; nickName?: string; photo?: { _info?: {}; id?: null | number; name?: string }; portalPassword?: string; portalSecurityLevel?: null | number; presence?: null | "NoAgent" | "Online" | "DoNotDisturb" | "Away" | "Offline"; relationship?: { _info?: {}; id?: null | number; name?: string }; relationshipOverride?: string; school?: string; securityIdentifier?: string; significantOther?: string; site?: { _info?: {}; id?: null | number; name?: string }; state?: string; title?: string; twitterUrl?: string; typeIds?: number[]; types?: { _info?: {}; id?: null | number; name?: string }[]; unsubscribeFlag?: null | boolean; userDefinedField1?: string; userDefinedField10?: string; userDefinedField2?: string; userDefinedField3?: string; userDefinedField4?: string; userDefinedField5?: string; userDefinedField6?: string; userDefinedField7?: string; userDefinedField8?: string; userDefinedField9?: string; zip?: string }>

putCompanyContactsByParentIdCommunicationsById

  • putCompanyContactsByParentIdCommunicationsById(id: number, parentId: number, contactCommunication: { _info?: {}; communicationType?: null | "Email" | "Fax" | "Phone"; contactId?: null | number; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; mobileGuid?: null | string; type?: { _info?: {}; id?: null | number; name?: string }; value: string }): Promise<{ _info?: {}; communicationType?: null | "Email" | "Fax" | "Phone"; contactId?: null | number; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; mobileGuid?: null | string; type?: { _info?: {}; id?: null | number; name?: string }; value: string }>

  • Parameters

    • id: number
    • parentId: number
    • contactCommunication: { _info?: {}; communicationType?: null | "Email" | "Fax" | "Phone"; contactId?: null | number; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; mobileGuid?: null | string; type?: { _info?: {}; id?: null | number; name?: string }; value: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional communicationType?: null | "Email" | "Fax" | "Phone"
      • Optional contactId?: null | number

        Format: int32

      • Optional defaultFlag?: null | boolean
      • Optional domain?: string
      • Optional extension?: string
        description

        Max length: 15;

      • Optional id?: number

        Format: int32

      • Optional mobileGuid?: null | string

        Format: uuid

      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • value: string
        description

        Max length: 250;

    Returns Promise<{ _info?: {}; communicationType?: null | "Email" | "Fax" | "Phone"; contactId?: null | number; defaultFlag?: null | boolean; domain?: string; extension?: string; id?: number; mobileGuid?: null | string; type?: { _info?: {}; id?: null | number; name?: string }; value: string }>

putCompanyContactsByParentIdGroupsById

  • putCompanyContactsByParentIdGroupsById(id: number, parentId: number, contactGroup: { _info?: {}; companyGroupUnsubscribedEmailMessage?: string; companyUnsubcribedEmailMessage?: string; contact?: { _info?: {}; id?: null | number; name?: string }; contactGroupUnsubscribedEmailMessage?: string; contactUnsubscribedEmailMessage?: string; description?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; unsubscribeFlag?: null | boolean }): Promise<{ _info?: {}; companyGroupUnsubscribedEmailMessage?: string; companyUnsubcribedEmailMessage?: string; contact?: { _info?: {}; id?: null | number; name?: string }; contactGroupUnsubscribedEmailMessage?: string; contactUnsubscribedEmailMessage?: string; description?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; unsubscribeFlag?: null | boolean }>

  • Parameters

    • id: number
    • parentId: number
    • contactGroup: { _info?: {}; companyGroupUnsubscribedEmailMessage?: string; companyUnsubcribedEmailMessage?: string; contact?: { _info?: {}; id?: null | number; name?: string }; contactGroupUnsubscribedEmailMessage?: string; contactUnsubscribedEmailMessage?: string; description?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; unsubscribeFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional companyGroupUnsubscribedEmailMessage?: string
      • Optional companyUnsubcribedEmailMessage?: string
      • Optional contact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional contactGroupUnsubscribedEmailMessage?: string
      • Optional contactUnsubscribedEmailMessage?: string
      • Optional description?: string
        description

        Max length: 50;

      • Optional group?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional unsubscribeFlag?: null | boolean

    Returns Promise<{ _info?: {}; companyGroupUnsubscribedEmailMessage?: string; companyUnsubcribedEmailMessage?: string; contact?: { _info?: {}; id?: null | number; name?: string }; contactGroupUnsubscribedEmailMessage?: string; contactUnsubscribedEmailMessage?: string; description?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; unsubscribeFlag?: null | boolean }>

putCompanyContactsByParentIdNotesById

  • putCompanyContactsByParentIdNotesById(id: number, parentId: number, contactNote: { _info?: {}; contactId?: null | number; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; contactId?: null | number; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • contactNote: { _info?: {}; contactId?: null | number; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional contactId?: null | number

        Format: int32

      • Optional enteredBy?: string
      • Optional flagged?: null | boolean
      • Optional id?: number

        Format: int32

      • text: string
      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; contactId?: null | number; enteredBy?: string; flagged?: null | boolean; id?: number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

putCompanyContactsByParentIdTypeAssociationsById

  • putCompanyContactsByParentIdTypeAssociationsById(id: number, parentId: number, contactTypeAssociation: { _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • contactTypeAssociation: { _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional contact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; contact?: { _info?: {}; id?: null | number; name?: string }; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }>

putCompanyContactsDepartmentsById

  • putCompanyContactsDepartmentsById(id: number, contactDepartment: { _info?: {}; id?: number; name: string }): Promise<{ _info?: {}; id?: number; name: string }>

  • Parameters

    • id: number
    • contactDepartment: { _info?: {}; id?: number; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 30;

    Returns Promise<{ _info?: {}; id?: number; name: string }>

putCompanyContactsRelationshipsById

  • putCompanyContactsRelationshipsById(id: number, contactRelationship: { _info?: {}; id?: number; name: string }): Promise<{ _info?: {}; id?: number; name: string }>

  • Parameters

    • id: number
    • contactRelationship: { _info?: {}; id?: number; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; id?: number; name: string }>

putCompanyContactsTypesById

  • putCompanyContactsTypesById(id: number, contactType: { _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }): Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }>

  • Parameters

    • id: number
    • contactType: { _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional defaultFlag?: null | boolean
      • description: string
        description

        Max length: 50;

      • Optional id?: number

        Format: int32

      • Optional serviceAlertFlag?: null | boolean
      • Optional serviceAlertMessage?: string
        description

        Max length: 150;

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; serviceAlertFlag?: null | boolean; serviceAlertMessage?: string }>

putCompanyCountriesById

  • putCompanyCountriesById(id: number, country: { _info?: {}; addressFormat?: { _info?: {}; id?: null | number; name?: string }; cityCaption?: string; countryCode?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; localizationValueOne?: string; name: string; stateCaption?: string; zipCaption?: string; zipMinimumLength?: null | number }): Promise<{ _info?: {}; addressFormat?: { _info?: {}; id?: null | number; name?: string }; cityCaption?: string; countryCode?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; localizationValueOne?: string; name: string; stateCaption?: string; zipCaption?: string; zipMinimumLength?: null | number }>

  • Parameters

    • id: number
    • country: { _info?: {}; addressFormat?: { _info?: {}; id?: null | number; name?: string }; cityCaption?: string; countryCode?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; localizationValueOne?: string; name: string; stateCaption?: string; zipCaption?: string; zipMinimumLength?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addressFormat?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional cityCaption?: string
        description

        Max length: 25;

      • Optional countryCode?: string
        description

        Max length: 2;

      • Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional currencyCode?: string
        • Optional currencyIdentifier?: string
        • Optional decimalSeparator?: string
        • Optional displayIdFlag?: boolean
        • Optional displaySymbolFlag?: boolean
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional negativeParenthesesFlag?: boolean
        • Optional numberOfDecimals?: number

          Format: int32

        • Optional rightAlign?: boolean
        • Optional symbol?: string
        • Optional thousandsSeparator?: string
      • Optional defaultFlag?: null | boolean
      • Optional dialingPrefix?: string
        description

        Max length: 5;

      • Optional id?: number

        Format: int32

      • Optional localizationCaptionOne?: string
        description

        Max length: 25;

      • Optional localizationValueOne?: string
        description

        Max length: 50;

      • name: string
        description

        Max length: 50;

      • Optional stateCaption?: string
        description

        Max length: 25;

      • Optional zipCaption?: string
        description

        Max length: 25;

      • Optional zipMinimumLength?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; addressFormat?: { _info?: {}; id?: null | number; name?: string }; cityCaption?: string; countryCode?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; defaultFlag?: null | boolean; dialingPrefix?: string; id?: number; localizationCaptionOne?: string; localizationValueOne?: string; name: string; stateCaption?: string; zipCaption?: string; zipMinimumLength?: null | number }>

putCompanyManagedDevicesIntegrationsById

  • putCompanyManagedDevicesIntegrationsById(id: number, managedDevicesIntegration: { _info?: {}; configBillCustomerFlag?: null | boolean; defaultBillingLevel: null | "Detail" | "Summary"; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; disableNewCrossReferencesFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; loginBy: null | "Global" | "Member"; managementItSetupType?: string; matchOnSerialNumberFlag?: null | boolean; name: string; portalUrl?: string; solution: string }): Promise<{ _info?: {}; configBillCustomerFlag?: null | boolean; defaultBillingLevel: null | "Detail" | "Summary"; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; disableNewCrossReferencesFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; loginBy: null | "Global" | "Member"; managementItSetupType?: string; matchOnSerialNumberFlag?: null | boolean; name: string; portalUrl?: string; solution: string }>

  • Parameters

    • id: number
    • managedDevicesIntegration: { _info?: {}; configBillCustomerFlag?: null | boolean; defaultBillingLevel: null | "Detail" | "Summary"; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; disableNewCrossReferencesFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; loginBy: null | "Global" | "Member"; managementItSetupType?: string; matchOnSerialNumberFlag?: null | boolean; name: string; portalUrl?: string; solution: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional configBillCustomerFlag?: null | boolean
      • defaultBillingLevel: null | "Detail" | "Summary"
      • Optional defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional defaultLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional disableNewCrossReferencesFlag?: null | boolean
      • Optional globalLoginPassword?: string
        description

        This is only required when globalLoginFlag = true Max length: 50;

      • Optional globalLoginUsername?: string
        description

        This is only required when globalLoginFlag = true Max length: 50;

      • Optional id?: number

        Format: int32

      • Optional integratorLogin?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • loginBy: null | "Global" | "Member"
      • Optional managementItSetupType?: string
      • Optional matchOnSerialNumberFlag?: null | boolean
      • name: string
        description

        Max length: 30;

      • Optional portalUrl?: string
        description

        Max length: 200;

      • solution: string
        description

        Max length: 30;

    Returns Promise<{ _info?: {}; configBillCustomerFlag?: null | boolean; defaultBillingLevel: null | "Detail" | "Summary"; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; disableNewCrossReferencesFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; loginBy: null | "Global" | "Member"; managementItSetupType?: string; matchOnSerialNumberFlag?: null | boolean; name: string; portalUrl?: string; solution: string }>

putCompanyManagedDevicesIntegrationsByParentIdCrossReferencesById

  • putCompanyManagedDevicesIntegrationsByParentIdCrossReferencesById(id: number, parentId: number, crossReference: { _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; vendorLevel?: string; vendorType?: string }): Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; vendorLevel?: string; vendorType?: string }>

  • Parameters

    • id: number
    • parentId: number
    • crossReference: { _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; vendorLevel?: string; vendorType?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional configurationType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • Optional managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional serializedFlag?: null | boolean
      • Optional vendorLevel?: string
        description

        Max length: 255;

      • Optional vendorType?: string
        description

        Max length: 255;

    Returns Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; vendorLevel?: string; vendorType?: string }>

putCompanyManagedDevicesIntegrationsByParentIdLoginsById

  • putCompanyManagedDevicesIntegrationsByParentIdLoginsById(id: number, parentId: number, login: { _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; password?: string; username: string }): Promise<{ _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; password?: string; username: string }>

  • Parameters

    • id: number
    • parentId: number
    • login: { _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; password?: string; username: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional password?: string
        description

        Max length: 50;

      • username: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; password?: string; username: string }>

putCompanyManagedDevicesIntegrationsByParentIdNotificationsById

  • putCompanyManagedDevicesIntegrationsByParentIdNotificationsById(id: number, parentId: number, notification: { _info?: {}; id?: number; logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; id?: number; logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • notification: { _info?: {}; id?: number; logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"
      • Optional managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string

    Returns Promise<{ _info?: {}; id?: number; logType: null | "All" | "Error" | "NewManagedSolution" | "NewDeviceType" | "NewConfiguration" | "NewAddition" | "Info"; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

putCompanyManagementBackupsById

  • putCompanyManagementBackupsById(id: number, managementBackup: { _info?: {}; billingLevel: null | "Detail" | "Summary"; id?: number; item?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; billingLevel: null | "Detail" | "Summary"; id?: number; item?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • managementBackup: { _info?: {}; billingLevel: null | "Detail" | "Summary"; id?: number; item?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • billingLevel: null | "Detail" | "Summary"
      • Optional id?: number

        Format: int32

      • Optional item?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; billingLevel: null | "Detail" | "Summary"; id?: number; item?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

putCompanyManagementById

  • putCompanyManagementById(id: number, management: { _info?: {}; addedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; deletedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; executiveSummaryReportScheduleDay?: null | number; executiveSummaryReportScheduleHour?: null | number; executiveSummaryReportScheduleMinute?: null | number; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; runTime?: string; scheduleExecutiveSummaryReportFlag: null | boolean }): Promise<{ _info?: {}; addedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; deletedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; executiveSummaryReportScheduleDay?: null | number; executiveSummaryReportScheduleHour?: null | number; executiveSummaryReportScheduleMinute?: null | number; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; runTime?: string; scheduleExecutiveSummaryReportFlag: null | boolean }>

  • Parameters

    • id: number
    • management: { _info?: {}; addedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; deletedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; executiveSummaryReportScheduleDay?: null | number; executiveSummaryReportScheduleHour?: null | number; executiveSummaryReportScheduleMinute?: null | number; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; runTime?: string; scheduleExecutiveSummaryReportFlag: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional deletedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional executiveSummaryReportScheduleDay?: null | number

        Format: int32

        description

        This is only required when scheduleExecutiveSummaryReportFlag = true

      • Optional executiveSummaryReportScheduleHour?: null | number

        Format: int32

        description

        This is only required when scheduleExecutiveSummaryReportFlag = true. Input should be in 24 hour format, ie 2pm is 14

      • Optional executiveSummaryReportScheduleMinute?: null | number

        Format: int32

        description

        This is only required when scheduleExecutiveSummaryReportFlag = true

      • Optional id?: number

        Format: int32

      • Optional integratorLogin?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional runTime?: string

        Format: date-time

      • scheduleExecutiveSummaryReportFlag: null | boolean

    Returns Promise<{ _info?: {}; addedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; deletedConfigurationStatus?: { _info?: {}; id?: null | number; name?: string }; executiveSummaryReportScheduleDay?: null | number; executiveSummaryReportScheduleHour?: null | number; executiveSummaryReportScheduleMinute?: null | number; id?: number; integratorLogin?: { _info?: {}; id?: null | number; name?: string }; runTime?: string; scheduleExecutiveSummaryReportFlag: null | boolean }>

putCompanyManagementByParentIdManagementReportNotificationsById

  • putCompanyManagementByParentIdManagementReportNotificationsById(id: number, parentId: number, managementReportNotification: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • managementReportNotification: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional email?: string
        description

        Max length: 50;

      • Optional globalFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string

    Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; email?: string; globalFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

putCompanyManagementItSolutionsById

  • putCompanyManagementItSolutionsById(id: number, managementItSolution: { _info?: {}; continuumApiPassword?: string; continuumApiUsername?: string; globalLoginFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; levelApiPassword?: string; levelApiUsername?: string; levelVarDomain?: string; managementItSolutionType: null | "LevelPlatforms" | "NAble" | "Continuum" | "Custom"; managementServerUrl?: string; managementSolutionName?: string; nAblePassword?: string; nAbleUsername?: string; name: string; noDisplayFlag?: null | boolean; overrideLoginLocationFlag?: null | boolean; overrideWebServiceLocationFlag?: null | boolean; portalOverrideLoginUrl?: string; usingSslFlag?: null | boolean; webserviceOverrideUrl?: string }): Promise<{ _info?: {}; continuumApiPassword?: string; continuumApiUsername?: string; globalLoginFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; levelApiPassword?: string; levelApiUsername?: string; levelVarDomain?: string; managementItSolutionType: null | "LevelPlatforms" | "NAble" | "Continuum" | "Custom"; managementServerUrl?: string; managementSolutionName?: string; nAblePassword?: string; nAbleUsername?: string; name: string; noDisplayFlag?: null | boolean; overrideLoginLocationFlag?: null | boolean; overrideWebServiceLocationFlag?: null | boolean; portalOverrideLoginUrl?: string; usingSslFlag?: null | boolean; webserviceOverrideUrl?: string }>

  • Parameters

    • id: number
    • managementItSolution: { _info?: {}; continuumApiPassword?: string; continuumApiUsername?: string; globalLoginFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; levelApiPassword?: string; levelApiUsername?: string; levelVarDomain?: string; managementItSolutionType: null | "LevelPlatforms" | "NAble" | "Continuum" | "Custom"; managementServerUrl?: string; managementSolutionName?: string; nAblePassword?: string; nAbleUsername?: string; name: string; noDisplayFlag?: null | boolean; overrideLoginLocationFlag?: null | boolean; overrideWebServiceLocationFlag?: null | boolean; portalOverrideLoginUrl?: string; usingSslFlag?: null | boolean; webserviceOverrideUrl?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional continuumApiPassword?: string
        description

        This is only required for Continuum solution Max length: 100;

      • Optional continuumApiUsername?: string
        description

        This is only required for Continuum solution Max length: 100;

      • Optional globalLoginFlag?: null | boolean
      • Optional globalLoginPassword?: string
        description

        This is only required when globalLoginFlag = true Max length: 50;

      • Optional globalLoginUsername?: string
        description

        This is only required when globalLoginFlag = true Max length: 50;

      • Optional id?: number

        Format: int32

      • Optional levelApiPassword?: string
        description

        This is only required for Level Platforms solution Max length: 100;

      • Optional levelApiUsername?: string
        description

        This is only required for Level Platforms solution Max length: 100;

      • Optional levelVarDomain?: string
        description

        This is only required for Level Platforms solution Max length: 100;

      • managementItSolutionType: null | "LevelPlatforms" | "NAble" | "Continuum" | "Custom"
      • Optional managementServerUrl?: string
        description

        This is only required for Level Platforms Max length: 200;

      • Optional managementSolutionName?: string
        description

        This is only required when managementItSolutionType is Custom Max length: 30;

      • Optional nAblePassword?: string
        description

        This is only required for N-Able solution Max length: 50;

      • Optional nAbleUsername?: string
        description

        This is only required for N-Able solution Max length: 50;

      • name: string
        description

        Max length: 30;

      • Optional noDisplayFlag?: null | boolean
      • Optional overrideLoginLocationFlag?: null | boolean
      • Optional overrideWebServiceLocationFlag?: null | boolean
      • Optional portalOverrideLoginUrl?: string
        description

        This is only required for Level Platforms when overrideLoginLocationFlag is true Max length: 200;

      • Optional usingSslFlag?: null | boolean
      • Optional webserviceOverrideUrl?: string
        description

        This is only required for Level Platforms when overrideWebServiceLocationFlag is true Max length: 200;

    Returns Promise<{ _info?: {}; continuumApiPassword?: string; continuumApiUsername?: string; globalLoginFlag?: null | boolean; globalLoginPassword?: string; globalLoginUsername?: string; id?: number; levelApiPassword?: string; levelApiUsername?: string; levelVarDomain?: string; managementItSolutionType: null | "LevelPlatforms" | "NAble" | "Continuum" | "Custom"; managementServerUrl?: string; managementSolutionName?: string; nAblePassword?: string; nAbleUsername?: string; name: string; noDisplayFlag?: null | boolean; overrideLoginLocationFlag?: null | boolean; overrideWebServiceLocationFlag?: null | boolean; portalOverrideLoginUrl?: string; usingSslFlag?: null | boolean; webserviceOverrideUrl?: string }>

putCompanyManagementItSolutionsByParentIdManagementProductsById

  • putCompanyManagementItSolutionsByParentIdManagementProductsById(id: number, parentId: number, managementProduct: { _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean } }): Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean } }>

  • Parameters

    • id: number
    • parentId: number
    • managementProduct: { _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional serializedFlag?: null | boolean
      • Optional spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional serializedFlag?: null | boolean
      • Optional workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional serializedFlag?: null | boolean

    Returns Promise<{ _info?: {}; agreementType?: { _info?: {}; id?: null | number; name?: string }; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; serverProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; spamStatsProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; workstationProduct?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean } }>

putCompanyMarketDescriptionsById

  • putCompanyMarketDescriptionsById(id: number, marketDescription: { _info?: {}; id?: number; name: string }): Promise<{ _info?: {}; id?: number; name: string }>

  • Parameters

    • id: number
    • marketDescription: { _info?: {}; id?: number; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; id?: number; name: string }>

putCompanyNoteTypesById

  • putCompanyNoteTypesById(id: number, noteType: { _info?: {}; defaultFlag?: null | boolean; id?: number; identifier?: string; importFlag?: null | boolean; name: string }): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; identifier?: string; importFlag?: null | boolean; name: string }>

  • Parameters

    • id: number
    • noteType: { _info?: {}; defaultFlag?: null | boolean; id?: number; identifier?: string; importFlag?: null | boolean; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional defaultFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional identifier?: string
        description

        Max length: 15;

      • Optional importFlag?: null | boolean
      • name: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; identifier?: string; importFlag?: null | boolean; name: string }>

putCompanyOwnershipTypesById

  • putCompanyOwnershipTypesById(id: number, ownershipType: { _info?: {}; id?: number; name: string }): Promise<{ _info?: {}; id?: number; name: string }>

  • Parameters

    • id: number
    • ownershipType: { _info?: {}; id?: number; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 200;

    Returns Promise<{ _info?: {}; id?: number; name: string }>

putCompanyPortalConfigurationsById

  • putCompanyPortalConfigurationsById(id: number, portalConfiguration: { _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }): Promise<{ _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }>

  • Parameters

    • id: number
    • portalConfiguration: { _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementTypeIds?: number[]
      • Optional boardIds?: number[]
      • Optional buttonColor?: string
        description

        Max length: 7;

      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional configTypeIds?: number[]
      • Optional defaultFlag?: null | boolean
      • Optional displayVendorFlag?: null | boolean
      • Optional headerColor?: string
        description

        Max length: 7;

      • Optional id?: number

        Format: int32

        description

        An existing Portal Configuration id is required when copying a Portal Configuration.

      • Optional language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"
      • Optional locationIds?: number[]
      • Optional loginBackgroundColor?: string
        description

        Max length: 7;

      • Optional menuColor?: string
        description

        Max length: 7;

      • name: string
        description

        Max length: 150;

      • Optional portalBackgroundColor?: string
        description

        Max length: 7;

      • Optional portalImageCopySuccessFlag?: null | boolean
      • Optional url?: string
        description

        Max length: 1000;

      • Optional welcomeText?: string
        description

        Max length: 4000;

    Returns Promise<{ _info?: {}; agreementTypeIds?: number[]; boardIds?: number[]; buttonColor?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; configTypeIds?: number[]; defaultFlag?: null | boolean; displayVendorFlag?: null | boolean; headerColor?: string; id?: number; language?: null | "English" | "Spanish" | "French" | "British" | "Australian" | "BrazilianPortuguese" | "CanadianFrench" | "German" | "NewZealand" | "Dutch"; locationIds?: number[]; loginBackgroundColor?: string; menuColor?: string; name: string; portalBackgroundColor?: string; portalImageCopySuccessFlag?: null | boolean; url?: string; welcomeText?: string }>

putCompanyPortalConfigurationsByParentIdInvoiceSetupsById

  • putCompanyPortalConfigurationsByParentIdInvoiceSetupsById(id: number, parentId: number, portalConfigurationInvoiceSetup: { _info?: {}; addAllStatuses?: null | boolean; allowInvPmtFlag?: null | boolean; billingStatusIds?: number[]; displayInvPmtFlag?: null | boolean; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; login?: string; password?: string; paymentProcessor?: { _info?: {}; id?: null | number; name?: string }; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; removeAllStatuses?: null | boolean; urlOverride?: string }): Promise<{ _info?: {}; addAllStatuses?: null | boolean; allowInvPmtFlag?: null | boolean; billingStatusIds?: number[]; displayInvPmtFlag?: null | boolean; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; login?: string; password?: string; paymentProcessor?: { _info?: {}; id?: null | number; name?: string }; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; removeAllStatuses?: null | boolean; urlOverride?: string }>

  • Parameters

    • id: number
    • parentId: number
    • portalConfigurationInvoiceSetup: { _info?: {}; addAllStatuses?: null | boolean; allowInvPmtFlag?: null | boolean; billingStatusIds?: number[]; displayInvPmtFlag?: null | boolean; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; login?: string; password?: string; paymentProcessor?: { _info?: {}; id?: null | number; name?: string }; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; removeAllStatuses?: null | boolean; urlOverride?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addAllStatuses?: null | boolean
      • Optional allowInvPmtFlag?: null | boolean
      • Optional billingStatusIds?: number[]
      • Optional displayInvPmtFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional location?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional login?: string
      • Optional password?: string
      • Optional paymentProcessor?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional portalConfiguration?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional removeAllStatuses?: null | boolean
      • Optional urlOverride?: string

    Returns Promise<{ _info?: {}; addAllStatuses?: null | boolean; allowInvPmtFlag?: null | boolean; billingStatusIds?: number[]; displayInvPmtFlag?: null | boolean; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; login?: string; password?: string; paymentProcessor?: { _info?: {}; id?: null | number; name?: string }; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; removeAllStatuses?: null | boolean; urlOverride?: string }>

putCompanyPortalConfigurationsByParentIdOpportunitySetups

  • putCompanyPortalConfigurationsByParentIdOpportunitySetups(parentId: number, opportunitySetup: { _info?: {}; acceptanceChangeStatusFlag?: null | boolean; acceptanceCreateActivityFlag?: null | boolean; acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; acceptanceEmailBody?: string; acceptanceEmailFromFirstName?: string; acceptanceEmailFromLastName?: string; acceptanceEmailSubject?: string; acceptanceFromEmail?: string; acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; acceptanceSendEmailFlag?: null | boolean; addAllOpportunityStatuses?: null | boolean; addAllOpportunityTypes?: null | boolean; confirmationEmailBody?: string; confirmationEmailFromFirstName?: string; confirmationEmailFromLastName?: string; confirmationEmailSubject?: string; confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean; confirmationFromEmail?: string; confirmationSendEmailFlag?: null | boolean; id?: number; opportunityStatusRecIDs?: number[]; opportunityTypeRecIDs?: number[]; rejectionChangeStatusFlag?: null | boolean; rejectionCreateActivityFlag?: null | boolean; rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; rejectionEmailBody?: string; rejectionEmailFromFirstName?: string; rejectionEmailFromLastName?: string; rejectionEmailSubject?: string; rejectionFromEmail?: string; rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; rejectionSendEmailFlag?: null | boolean; removeAllOpportunityStatuses?: null | boolean; removeAllOpportunityTypes?: null | boolean; restrictViewByOpportunityStatusFlag?: null | boolean; restrictViewByOpportunityTypeFlag?: null | boolean }): Promise<{ _info?: {}; acceptanceChangeStatusFlag?: null | boolean; acceptanceCreateActivityFlag?: null | boolean; acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; acceptanceEmailBody?: string; acceptanceEmailFromFirstName?: string; acceptanceEmailFromLastName?: string; acceptanceEmailSubject?: string; acceptanceFromEmail?: string; acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; acceptanceSendEmailFlag?: null | boolean; addAllOpportunityStatuses?: null | boolean; addAllOpportunityTypes?: null | boolean; confirmationEmailBody?: string; confirmationEmailFromFirstName?: string; confirmationEmailFromLastName?: string; confirmationEmailSubject?: string; confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean; confirmationFromEmail?: string; confirmationSendEmailFlag?: null | boolean; id?: number; opportunityStatusRecIDs?: number[]; opportunityTypeRecIDs?: number[]; rejectionChangeStatusFlag?: null | boolean; rejectionCreateActivityFlag?: null | boolean; rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; rejectionEmailBody?: string; rejectionEmailFromFirstName?: string; rejectionEmailFromLastName?: string; rejectionEmailSubject?: string; rejectionFromEmail?: string; rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; rejectionSendEmailFlag?: null | boolean; removeAllOpportunityStatuses?: null | boolean; removeAllOpportunityTypes?: null | boolean; restrictViewByOpportunityStatusFlag?: null | boolean; restrictViewByOpportunityTypeFlag?: null | boolean }>

  • Parameters

    • parentId: number
    • opportunitySetup: { _info?: {}; acceptanceChangeStatusFlag?: null | boolean; acceptanceCreateActivityFlag?: null | boolean; acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; acceptanceEmailBody?: string; acceptanceEmailFromFirstName?: string; acceptanceEmailFromLastName?: string; acceptanceEmailSubject?: string; acceptanceFromEmail?: string; acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; acceptanceSendEmailFlag?: null | boolean; addAllOpportunityStatuses?: null | boolean; addAllOpportunityTypes?: null | boolean; confirmationEmailBody?: string; confirmationEmailFromFirstName?: string; confirmationEmailFromLastName?: string; confirmationEmailSubject?: string; confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean; confirmationFromEmail?: string; confirmationSendEmailFlag?: null | boolean; id?: number; opportunityStatusRecIDs?: number[]; opportunityTypeRecIDs?: number[]; rejectionChangeStatusFlag?: null | boolean; rejectionCreateActivityFlag?: null | boolean; rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; rejectionEmailBody?: string; rejectionEmailFromFirstName?: string; rejectionEmailFromLastName?: string; rejectionEmailSubject?: string; rejectionFromEmail?: string; rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; rejectionSendEmailFlag?: null | boolean; removeAllOpportunityStatuses?: null | boolean; removeAllOpportunityTypes?: null | boolean; restrictViewByOpportunityStatusFlag?: null | boolean; restrictViewByOpportunityTypeFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional acceptanceChangeStatusFlag?: null | boolean
      • Optional acceptanceCreateActivityFlag?: null | boolean
      • Optional acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional acceptanceEmailBody?: string
      • Optional acceptanceEmailFromFirstName?: string
      • Optional acceptanceEmailFromLastName?: string
      • Optional acceptanceEmailSubject?: string
      • Optional acceptanceFromEmail?: string
        description

        Required when acceptanceSendEmailFlag is true

      • Optional acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional acceptanceSendEmailFlag?: null | boolean
      • Optional addAllOpportunityStatuses?: null | boolean
      • Optional addAllOpportunityTypes?: null | boolean
      • Optional confirmationEmailBody?: string
      • Optional confirmationEmailFromFirstName?: string
      • Optional confirmationEmailFromLastName?: string
      • Optional confirmationEmailSubject?: string
      • Optional confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean
      • Optional confirmationFromEmail?: string
        description

        Required when confirmationSendEmailFlag is true

      • Optional confirmationSendEmailFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional opportunityStatusRecIDs?: number[]
      • Optional opportunityTypeRecIDs?: number[]
      • Optional rejectionChangeStatusFlag?: null | boolean
      • Optional rejectionCreateActivityFlag?: null | boolean
      • Optional rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional rejectionEmailBody?: string
      • Optional rejectionEmailFromFirstName?: string
      • Optional rejectionEmailFromLastName?: string
      • Optional rejectionEmailSubject?: string
      • Optional rejectionFromEmail?: string
        description

        Required when rejectionSendEmailFlag is true

      • Optional rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional rejectionSendEmailFlag?: null | boolean
      • Optional removeAllOpportunityStatuses?: null | boolean
      • Optional removeAllOpportunityTypes?: null | boolean
      • Optional restrictViewByOpportunityStatusFlag?: null | boolean
      • Optional restrictViewByOpportunityTypeFlag?: null | boolean

    Returns Promise<{ _info?: {}; acceptanceChangeStatusFlag?: null | boolean; acceptanceCreateActivityFlag?: null | boolean; acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; acceptanceEmailBody?: string; acceptanceEmailFromFirstName?: string; acceptanceEmailFromLastName?: string; acceptanceEmailSubject?: string; acceptanceFromEmail?: string; acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; acceptanceSendEmailFlag?: null | boolean; addAllOpportunityStatuses?: null | boolean; addAllOpportunityTypes?: null | boolean; confirmationEmailBody?: string; confirmationEmailFromFirstName?: string; confirmationEmailFromLastName?: string; confirmationEmailSubject?: string; confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean; confirmationFromEmail?: string; confirmationSendEmailFlag?: null | boolean; id?: number; opportunityStatusRecIDs?: number[]; opportunityTypeRecIDs?: number[]; rejectionChangeStatusFlag?: null | boolean; rejectionCreateActivityFlag?: null | boolean; rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; rejectionEmailBody?: string; rejectionEmailFromFirstName?: string; rejectionEmailFromLastName?: string; rejectionEmailSubject?: string; rejectionFromEmail?: string; rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; rejectionSendEmailFlag?: null | boolean; removeAllOpportunityStatuses?: null | boolean; removeAllOpportunityTypes?: null | boolean; restrictViewByOpportunityStatusFlag?: null | boolean; restrictViewByOpportunityTypeFlag?: null | boolean }>

putCompanyPortalConfigurationsByParentIdOpportunitySetupsById

  • putCompanyPortalConfigurationsByParentIdOpportunitySetupsById(id: number, parentId: number, opportunitySetup: { _info?: {}; acceptanceChangeStatusFlag?: null | boolean; acceptanceCreateActivityFlag?: null | boolean; acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; acceptanceEmailBody?: string; acceptanceEmailFromFirstName?: string; acceptanceEmailFromLastName?: string; acceptanceEmailSubject?: string; acceptanceFromEmail?: string; acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; acceptanceSendEmailFlag?: null | boolean; addAllOpportunityStatuses?: null | boolean; addAllOpportunityTypes?: null | boolean; confirmationEmailBody?: string; confirmationEmailFromFirstName?: string; confirmationEmailFromLastName?: string; confirmationEmailSubject?: string; confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean; confirmationFromEmail?: string; confirmationSendEmailFlag?: null | boolean; id?: number; opportunityStatusRecIDs?: number[]; opportunityTypeRecIDs?: number[]; rejectionChangeStatusFlag?: null | boolean; rejectionCreateActivityFlag?: null | boolean; rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; rejectionEmailBody?: string; rejectionEmailFromFirstName?: string; rejectionEmailFromLastName?: string; rejectionEmailSubject?: string; rejectionFromEmail?: string; rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; rejectionSendEmailFlag?: null | boolean; removeAllOpportunityStatuses?: null | boolean; removeAllOpportunityTypes?: null | boolean; restrictViewByOpportunityStatusFlag?: null | boolean; restrictViewByOpportunityTypeFlag?: null | boolean }): Promise<{ _info?: {}; acceptanceChangeStatusFlag?: null | boolean; acceptanceCreateActivityFlag?: null | boolean; acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; acceptanceEmailBody?: string; acceptanceEmailFromFirstName?: string; acceptanceEmailFromLastName?: string; acceptanceEmailSubject?: string; acceptanceFromEmail?: string; acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; acceptanceSendEmailFlag?: null | boolean; addAllOpportunityStatuses?: null | boolean; addAllOpportunityTypes?: null | boolean; confirmationEmailBody?: string; confirmationEmailFromFirstName?: string; confirmationEmailFromLastName?: string; confirmationEmailSubject?: string; confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean; confirmationFromEmail?: string; confirmationSendEmailFlag?: null | boolean; id?: number; opportunityStatusRecIDs?: number[]; opportunityTypeRecIDs?: number[]; rejectionChangeStatusFlag?: null | boolean; rejectionCreateActivityFlag?: null | boolean; rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; rejectionEmailBody?: string; rejectionEmailFromFirstName?: string; rejectionEmailFromLastName?: string; rejectionEmailSubject?: string; rejectionFromEmail?: string; rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; rejectionSendEmailFlag?: null | boolean; removeAllOpportunityStatuses?: null | boolean; removeAllOpportunityTypes?: null | boolean; restrictViewByOpportunityStatusFlag?: null | boolean; restrictViewByOpportunityTypeFlag?: null | boolean }>

  • Parameters

    • id: number
    • parentId: number
    • opportunitySetup: { _info?: {}; acceptanceChangeStatusFlag?: null | boolean; acceptanceCreateActivityFlag?: null | boolean; acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; acceptanceEmailBody?: string; acceptanceEmailFromFirstName?: string; acceptanceEmailFromLastName?: string; acceptanceEmailSubject?: string; acceptanceFromEmail?: string; acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; acceptanceSendEmailFlag?: null | boolean; addAllOpportunityStatuses?: null | boolean; addAllOpportunityTypes?: null | boolean; confirmationEmailBody?: string; confirmationEmailFromFirstName?: string; confirmationEmailFromLastName?: string; confirmationEmailSubject?: string; confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean; confirmationFromEmail?: string; confirmationSendEmailFlag?: null | boolean; id?: number; opportunityStatusRecIDs?: number[]; opportunityTypeRecIDs?: number[]; rejectionChangeStatusFlag?: null | boolean; rejectionCreateActivityFlag?: null | boolean; rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; rejectionEmailBody?: string; rejectionEmailFromFirstName?: string; rejectionEmailFromLastName?: string; rejectionEmailSubject?: string; rejectionFromEmail?: string; rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; rejectionSendEmailFlag?: null | boolean; removeAllOpportunityStatuses?: null | boolean; removeAllOpportunityTypes?: null | boolean; restrictViewByOpportunityStatusFlag?: null | boolean; restrictViewByOpportunityTypeFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional acceptanceChangeStatusFlag?: null | boolean
      • Optional acceptanceCreateActivityFlag?: null | boolean
      • Optional acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional acceptanceEmailBody?: string
      • Optional acceptanceEmailFromFirstName?: string
      • Optional acceptanceEmailFromLastName?: string
      • Optional acceptanceEmailSubject?: string
      • Optional acceptanceFromEmail?: string
        description

        Required when acceptanceSendEmailFlag is true

      • Optional acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional acceptanceSendEmailFlag?: null | boolean
      • Optional addAllOpportunityStatuses?: null | boolean
      • Optional addAllOpportunityTypes?: null | boolean
      • Optional confirmationEmailBody?: string
      • Optional confirmationEmailFromFirstName?: string
      • Optional confirmationEmailFromLastName?: string
      • Optional confirmationEmailSubject?: string
      • Optional confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean
      • Optional confirmationFromEmail?: string
        description

        Required when confirmationSendEmailFlag is true

      • Optional confirmationSendEmailFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional opportunityStatusRecIDs?: number[]
      • Optional opportunityTypeRecIDs?: number[]
      • Optional rejectionChangeStatusFlag?: null | boolean
      • Optional rejectionCreateActivityFlag?: null | boolean
      • Optional rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional rejectionEmailBody?: string
      • Optional rejectionEmailFromFirstName?: string
      • Optional rejectionEmailFromLastName?: string
      • Optional rejectionEmailSubject?: string
      • Optional rejectionFromEmail?: string
        description

        Required when rejectionSendEmailFlag is true

      • Optional rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional rejectionSendEmailFlag?: null | boolean
      • Optional removeAllOpportunityStatuses?: null | boolean
      • Optional removeAllOpportunityTypes?: null | boolean
      • Optional restrictViewByOpportunityStatusFlag?: null | boolean
      • Optional restrictViewByOpportunityTypeFlag?: null | boolean

    Returns Promise<{ _info?: {}; acceptanceChangeStatusFlag?: null | boolean; acceptanceCreateActivityFlag?: null | boolean; acceptanceEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; acceptanceEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; acceptanceEmailBody?: string; acceptanceEmailFromFirstName?: string; acceptanceEmailFromLastName?: string; acceptanceEmailSubject?: string; acceptanceFromEmail?: string; acceptanceOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; acceptanceSendEmailFlag?: null | boolean; addAllOpportunityStatuses?: null | boolean; addAllOpportunityTypes?: null | boolean; confirmationEmailBody?: string; confirmationEmailFromFirstName?: string; confirmationEmailFromLastName?: string; confirmationEmailSubject?: string; confirmationEmailUseDefaultCompanyEmailAddressFlag?: null | boolean; confirmationFromEmail?: string; confirmationSendEmailFlag?: null | boolean; id?: number; opportunityStatusRecIDs?: number[]; opportunityTypeRecIDs?: number[]; rejectionChangeStatusFlag?: null | boolean; rejectionCreateActivityFlag?: null | boolean; rejectionEmailActivityType?: { _info?: {}; id?: null | number; name?: string }; rejectionEmailAssignedByMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; rejectionEmailBody?: string; rejectionEmailFromFirstName?: string; rejectionEmailFromLastName?: string; rejectionEmailSubject?: string; rejectionFromEmail?: string; rejectionOpportunityStatus?: { _info?: {}; id?: null | number; name?: string }; rejectionSendEmailFlag?: null | boolean; removeAllOpportunityStatuses?: null | boolean; removeAllOpportunityTypes?: null | boolean; restrictViewByOpportunityStatusFlag?: null | boolean; restrictViewByOpportunityTypeFlag?: null | boolean }>

putCompanyPortalConfigurationsByParentIdPasswordEmailSetupsById

  • putCompanyPortalConfigurationsByParentIdPasswordEmailSetupsById(id: number, parentId: number, passwordEmailSetup: { _info?: {}; id?: number; invalidPasswordEmailBody?: string; invalidPasswordEmailFromEmail?: string; invalidPasswordEmailFromFirstName?: string; invalidPasswordEmailFromLastName?: string; invalidPasswordEmailSubject?: string; invalidPasswordEmailUseCustomEmailFlag?: null | boolean; validPasswordEmailBody?: string; validPasswordEmailFromEmail?: string; validPasswordEmailFromFirstName?: string; validPasswordEmailFromLastName?: string; validPasswordEmailSubject?: string; validPasswordEmailUseCustomEmailFlag?: null | boolean }): Promise<{ _info?: {}; id?: number; invalidPasswordEmailBody?: string; invalidPasswordEmailFromEmail?: string; invalidPasswordEmailFromFirstName?: string; invalidPasswordEmailFromLastName?: string; invalidPasswordEmailSubject?: string; invalidPasswordEmailUseCustomEmailFlag?: null | boolean; validPasswordEmailBody?: string; validPasswordEmailFromEmail?: string; validPasswordEmailFromFirstName?: string; validPasswordEmailFromLastName?: string; validPasswordEmailSubject?: string; validPasswordEmailUseCustomEmailFlag?: null | boolean }>

  • Parameters

    • id: number
    • parentId: number
    • passwordEmailSetup: { _info?: {}; id?: number; invalidPasswordEmailBody?: string; invalidPasswordEmailFromEmail?: string; invalidPasswordEmailFromFirstName?: string; invalidPasswordEmailFromLastName?: string; invalidPasswordEmailSubject?: string; invalidPasswordEmailUseCustomEmailFlag?: null | boolean; validPasswordEmailBody?: string; validPasswordEmailFromEmail?: string; validPasswordEmailFromFirstName?: string; validPasswordEmailFromLastName?: string; validPasswordEmailSubject?: string; validPasswordEmailUseCustomEmailFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional invalidPasswordEmailBody?: string
      • Optional invalidPasswordEmailFromEmail?: string
        description

        Required when invalidPasswordEmailUseCustomEmailFlag is true

      • Optional invalidPasswordEmailFromFirstName?: string
      • Optional invalidPasswordEmailFromLastName?: string
      • Optional invalidPasswordEmailSubject?: string
      • Optional invalidPasswordEmailUseCustomEmailFlag?: null | boolean
      • Optional validPasswordEmailBody?: string
      • Optional validPasswordEmailFromEmail?: string
        description

        Required when validPasswordEmailUseCustomEmailFlag is true

      • Optional validPasswordEmailFromFirstName?: string
      • Optional validPasswordEmailFromLastName?: string
      • Optional validPasswordEmailSubject?: string
      • Optional validPasswordEmailUseCustomEmailFlag?: null | boolean

    Returns Promise<{ _info?: {}; id?: number; invalidPasswordEmailBody?: string; invalidPasswordEmailFromEmail?: string; invalidPasswordEmailFromFirstName?: string; invalidPasswordEmailFromLastName?: string; invalidPasswordEmailSubject?: string; invalidPasswordEmailUseCustomEmailFlag?: null | boolean; validPasswordEmailBody?: string; validPasswordEmailFromEmail?: string; validPasswordEmailFromFirstName?: string; validPasswordEmailFromLastName?: string; validPasswordEmailSubject?: string; validPasswordEmailUseCustomEmailFlag?: null | boolean }>

putCompanyPortalConfigurationsByParentIdProjectSetupsById

  • putCompanyPortalConfigurationsByParentIdProjectSetupsById(id: number, parentId: number, portalConfigurationProjectSetup: { _info?: {}; billingMethodFlag?: null | boolean; contactFlag?: null | boolean; descriptionFlag?: null | boolean; estimatedEndFlag?: null | boolean; estimatedStartFlag?: null | boolean; fixedFeeActualFinishFlag?: null | boolean; fixedFeeActualHrsFlag?: null | boolean; fixedFeeActualStartFlag?: null | boolean; fixedFeeAssignedFlag?: null | boolean; fixedFeeBillFlag?: null | boolean; fixedFeeBudgetHrsFlag?: null | boolean; fixedFeeScheduledFinishFlag?: null | boolean; fixedFeeScheduledHrsFlag?: null | boolean; fixedFeeScheduledStartFlag?: null | boolean; fixedFeeStatusFlag?: null | boolean; id?: number; lastUpdatedFlag?: null | boolean; onlyDisplay: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; portalConfig?: { _info?: {}; id?: null | number; name?: string }; projectDetailTotalHoursFlag?: null | boolean; projectIssueActualFinishFlag?: null | boolean; projectIssueActualHrsFlag?: null | boolean; projectIssueActualStartFlag?: null | boolean; projectIssueAssignedFlag?: null | boolean; projectIssueBillFlag?: null | boolean; projectIssueBudgetHrsFlag?: null | boolean; projectIssueScheduledFinishFlag?: null | boolean; projectIssueScheduledHrsFlag?: null | boolean; projectIssueScheduledStartFlag?: null | boolean; projectIssueStatusFlag?: null | boolean; projectManagerFlag?: null | boolean; projectNameFlag?: null | boolean; projectTypeFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialActualFinishFlag?: null | boolean; timeMaterialActualHrsFlag?: null | boolean; timeMaterialActualStartFlag?: null | boolean; timeMaterialAssignedFlag?: null | boolean; timeMaterialBillFlag?: null | boolean; timeMaterialBudgetHrsFlag?: null | boolean; timeMaterialScheduledFinishFlag?: null | boolean; timeMaterialScheduledHrsFlag?: null | boolean; timeMaterialScheduledStartFlag?: null | boolean; timeMaterialStatusFlag?: null | boolean }): Promise<{ _info?: {}; billingMethodFlag?: null | boolean; contactFlag?: null | boolean; descriptionFlag?: null | boolean; estimatedEndFlag?: null | boolean; estimatedStartFlag?: null | boolean; fixedFeeActualFinishFlag?: null | boolean; fixedFeeActualHrsFlag?: null | boolean; fixedFeeActualStartFlag?: null | boolean; fixedFeeAssignedFlag?: null | boolean; fixedFeeBillFlag?: null | boolean; fixedFeeBudgetHrsFlag?: null | boolean; fixedFeeScheduledFinishFlag?: null | boolean; fixedFeeScheduledHrsFlag?: null | boolean; fixedFeeScheduledStartFlag?: null | boolean; fixedFeeStatusFlag?: null | boolean; id?: number; lastUpdatedFlag?: null | boolean; onlyDisplay: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; portalConfig?: { _info?: {}; id?: null | number; name?: string }; projectDetailTotalHoursFlag?: null | boolean; projectIssueActualFinishFlag?: null | boolean; projectIssueActualHrsFlag?: null | boolean; projectIssueActualStartFlag?: null | boolean; projectIssueAssignedFlag?: null | boolean; projectIssueBillFlag?: null | boolean; projectIssueBudgetHrsFlag?: null | boolean; projectIssueScheduledFinishFlag?: null | boolean; projectIssueScheduledHrsFlag?: null | boolean; projectIssueScheduledStartFlag?: null | boolean; projectIssueStatusFlag?: null | boolean; projectManagerFlag?: null | boolean; projectNameFlag?: null | boolean; projectTypeFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialActualFinishFlag?: null | boolean; timeMaterialActualHrsFlag?: null | boolean; timeMaterialActualStartFlag?: null | boolean; timeMaterialAssignedFlag?: null | boolean; timeMaterialBillFlag?: null | boolean; timeMaterialBudgetHrsFlag?: null | boolean; timeMaterialScheduledFinishFlag?: null | boolean; timeMaterialScheduledHrsFlag?: null | boolean; timeMaterialScheduledStartFlag?: null | boolean; timeMaterialStatusFlag?: null | boolean }>

  • Parameters

    • id: number
    • parentId: number
    • portalConfigurationProjectSetup: { _info?: {}; billingMethodFlag?: null | boolean; contactFlag?: null | boolean; descriptionFlag?: null | boolean; estimatedEndFlag?: null | boolean; estimatedStartFlag?: null | boolean; fixedFeeActualFinishFlag?: null | boolean; fixedFeeActualHrsFlag?: null | boolean; fixedFeeActualStartFlag?: null | boolean; fixedFeeAssignedFlag?: null | boolean; fixedFeeBillFlag?: null | boolean; fixedFeeBudgetHrsFlag?: null | boolean; fixedFeeScheduledFinishFlag?: null | boolean; fixedFeeScheduledHrsFlag?: null | boolean; fixedFeeScheduledStartFlag?: null | boolean; fixedFeeStatusFlag?: null | boolean; id?: number; lastUpdatedFlag?: null | boolean; onlyDisplay: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; portalConfig?: { _info?: {}; id?: null | number; name?: string }; projectDetailTotalHoursFlag?: null | boolean; projectIssueActualFinishFlag?: null | boolean; projectIssueActualHrsFlag?: null | boolean; projectIssueActualStartFlag?: null | boolean; projectIssueAssignedFlag?: null | boolean; projectIssueBillFlag?: null | boolean; projectIssueBudgetHrsFlag?: null | boolean; projectIssueScheduledFinishFlag?: null | boolean; projectIssueScheduledHrsFlag?: null | boolean; projectIssueScheduledStartFlag?: null | boolean; projectIssueStatusFlag?: null | boolean; projectManagerFlag?: null | boolean; projectNameFlag?: null | boolean; projectTypeFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialActualFinishFlag?: null | boolean; timeMaterialActualHrsFlag?: null | boolean; timeMaterialActualStartFlag?: null | boolean; timeMaterialAssignedFlag?: null | boolean; timeMaterialBillFlag?: null | boolean; timeMaterialBudgetHrsFlag?: null | boolean; timeMaterialScheduledFinishFlag?: null | boolean; timeMaterialScheduledHrsFlag?: null | boolean; timeMaterialScheduledStartFlag?: null | boolean; timeMaterialStatusFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional billingMethodFlag?: null | boolean
      • Optional contactFlag?: null | boolean
      • Optional descriptionFlag?: null | boolean
      • Optional estimatedEndFlag?: null | boolean
      • Optional estimatedStartFlag?: null | boolean
      • Optional fixedFeeActualFinishFlag?: null | boolean
      • Optional fixedFeeActualHrsFlag?: null | boolean
      • Optional fixedFeeActualStartFlag?: null | boolean
      • Optional fixedFeeAssignedFlag?: null | boolean
      • Optional fixedFeeBillFlag?: null | boolean
      • Optional fixedFeeBudgetHrsFlag?: null | boolean
      • Optional fixedFeeScheduledFinishFlag?: null | boolean
      • Optional fixedFeeScheduledHrsFlag?: null | boolean
      • Optional fixedFeeScheduledStartFlag?: null | boolean
      • Optional fixedFeeStatusFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional lastUpdatedFlag?: null | boolean
      • onlyDisplay: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"
      • Optional portalConfig?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional projectDetailTotalHoursFlag?: null | boolean
      • Optional projectIssueActualFinishFlag?: null | boolean
      • Optional projectIssueActualHrsFlag?: null | boolean
      • Optional projectIssueActualStartFlag?: null | boolean
      • Optional projectIssueAssignedFlag?: null | boolean
      • Optional projectIssueBillFlag?: null | boolean
      • Optional projectIssueBudgetHrsFlag?: null | boolean
      • Optional projectIssueScheduledFinishFlag?: null | boolean
      • Optional projectIssueScheduledHrsFlag?: null | boolean
      • Optional projectIssueScheduledStartFlag?: null | boolean
      • Optional projectIssueStatusFlag?: null | boolean
      • Optional projectManagerFlag?: null | boolean
      • Optional projectNameFlag?: null | boolean
      • Optional projectTypeFlag?: null | boolean
      • Optional statusFlag?: null | boolean
      • Optional timeMaterialActualFinishFlag?: null | boolean
      • Optional timeMaterialActualHrsFlag?: null | boolean
      • Optional timeMaterialActualStartFlag?: null | boolean
      • Optional timeMaterialAssignedFlag?: null | boolean
      • Optional timeMaterialBillFlag?: null | boolean
      • Optional timeMaterialBudgetHrsFlag?: null | boolean
      • Optional timeMaterialScheduledFinishFlag?: null | boolean
      • Optional timeMaterialScheduledHrsFlag?: null | boolean
      • Optional timeMaterialScheduledStartFlag?: null | boolean
      • Optional timeMaterialStatusFlag?: null | boolean

    Returns Promise<{ _info?: {}; billingMethodFlag?: null | boolean; contactFlag?: null | boolean; descriptionFlag?: null | boolean; estimatedEndFlag?: null | boolean; estimatedStartFlag?: null | boolean; fixedFeeActualFinishFlag?: null | boolean; fixedFeeActualHrsFlag?: null | boolean; fixedFeeActualStartFlag?: null | boolean; fixedFeeAssignedFlag?: null | boolean; fixedFeeBillFlag?: null | boolean; fixedFeeBudgetHrsFlag?: null | boolean; fixedFeeScheduledFinishFlag?: null | boolean; fixedFeeScheduledHrsFlag?: null | boolean; fixedFeeScheduledStartFlag?: null | boolean; fixedFeeStatusFlag?: null | boolean; id?: number; lastUpdatedFlag?: null | boolean; onlyDisplay: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; portalConfig?: { _info?: {}; id?: null | number; name?: string }; projectDetailTotalHoursFlag?: null | boolean; projectIssueActualFinishFlag?: null | boolean; projectIssueActualHrsFlag?: null | boolean; projectIssueActualStartFlag?: null | boolean; projectIssueAssignedFlag?: null | boolean; projectIssueBillFlag?: null | boolean; projectIssueBudgetHrsFlag?: null | boolean; projectIssueScheduledFinishFlag?: null | boolean; projectIssueScheduledHrsFlag?: null | boolean; projectIssueScheduledStartFlag?: null | boolean; projectIssueStatusFlag?: null | boolean; projectManagerFlag?: null | boolean; projectNameFlag?: null | boolean; projectTypeFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialActualFinishFlag?: null | boolean; timeMaterialActualHrsFlag?: null | boolean; timeMaterialActualStartFlag?: null | boolean; timeMaterialAssignedFlag?: null | boolean; timeMaterialBillFlag?: null | boolean; timeMaterialBudgetHrsFlag?: null | boolean; timeMaterialScheduledFinishFlag?: null | boolean; timeMaterialScheduledHrsFlag?: null | boolean; timeMaterialScheduledStartFlag?: null | boolean; timeMaterialStatusFlag?: null | boolean }>

putCompanyPortalConfigurationsByParentIdServiceSetupsById

  • putCompanyPortalConfigurationsByParentIdServiceSetupsById(id: number, parentId: number, portalConfigurationServiceSetup: { _info?: {}; actualHoursFlag?: null | boolean; approvalStatusFlag?: null | boolean; assignedResourcesFlag?: null | boolean; budgetHoursFlag?: null | boolean; closedTasksFlag?: null | boolean; contactFlag?: null | boolean; displayClosedTicketsOption: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; enableChatAssistFlag?: null | boolean; enteredDateFlag?: null | boolean; fixedFeeTicketTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; lastUpdateFlag?: null | boolean; openTasksFlag?: null | boolean; requiredDateFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceSubTypeFlag?: null | boolean; serviceSubTypeItemFlag?: null | boolean; serviceTypeFlag?: null | boolean; siteNameFlag?: null | boolean; slaInfoFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialsTicketTemplate?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; actualHoursFlag?: null | boolean; approvalStatusFlag?: null | boolean; assignedResourcesFlag?: null | boolean; budgetHoursFlag?: null | boolean; closedTasksFlag?: null | boolean; contactFlag?: null | boolean; displayClosedTicketsOption: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; enableChatAssistFlag?: null | boolean; enteredDateFlag?: null | boolean; fixedFeeTicketTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; lastUpdateFlag?: null | boolean; openTasksFlag?: null | boolean; requiredDateFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceSubTypeFlag?: null | boolean; serviceSubTypeItemFlag?: null | boolean; serviceTypeFlag?: null | boolean; siteNameFlag?: null | boolean; slaInfoFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialsTicketTemplate?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • portalConfigurationServiceSetup: { _info?: {}; actualHoursFlag?: null | boolean; approvalStatusFlag?: null | boolean; assignedResourcesFlag?: null | boolean; budgetHoursFlag?: null | boolean; closedTasksFlag?: null | boolean; contactFlag?: null | boolean; displayClosedTicketsOption: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; enableChatAssistFlag?: null | boolean; enteredDateFlag?: null | boolean; fixedFeeTicketTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; lastUpdateFlag?: null | boolean; openTasksFlag?: null | boolean; requiredDateFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceSubTypeFlag?: null | boolean; serviceSubTypeItemFlag?: null | boolean; serviceTypeFlag?: null | boolean; siteNameFlag?: null | boolean; slaInfoFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialsTicketTemplate?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional actualHoursFlag?: null | boolean
      • Optional approvalStatusFlag?: null | boolean
      • Optional assignedResourcesFlag?: null | boolean
      • Optional budgetHoursFlag?: null | boolean
      • Optional closedTasksFlag?: null | boolean
      • Optional contactFlag?: null | boolean
      • displayClosedTicketsOption: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"
      • Optional enableChatAssistFlag?: null | boolean
      • Optional enteredDateFlag?: null | boolean
      • Optional fixedFeeTicketTemplate?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional lastUpdateFlag?: null | boolean
      • Optional openTasksFlag?: null | boolean
      • Optional requiredDateFlag?: null | boolean
      • Optional serviceBoardFlag?: null | boolean
      • Optional serviceSubTypeFlag?: null | boolean
      • Optional serviceSubTypeItemFlag?: null | boolean
      • Optional serviceTypeFlag?: null | boolean
      • Optional siteNameFlag?: null | boolean
      • Optional slaInfoFlag?: null | boolean
      • Optional statusFlag?: null | boolean
      • Optional timeMaterialsTicketTemplate?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; actualHoursFlag?: null | boolean; approvalStatusFlag?: null | boolean; assignedResourcesFlag?: null | boolean; budgetHoursFlag?: null | boolean; closedTasksFlag?: null | boolean; contactFlag?: null | boolean; displayClosedTicketsOption: null | "DoNotDisplay" | "Closed30Days" | "Closed60Days" | "Closed90Days" | "Closed120Days" | "AllClosed"; enableChatAssistFlag?: null | boolean; enteredDateFlag?: null | boolean; fixedFeeTicketTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; lastUpdateFlag?: null | boolean; openTasksFlag?: null | boolean; requiredDateFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceSubTypeFlag?: null | boolean; serviceSubTypeItemFlag?: null | boolean; serviceTypeFlag?: null | boolean; siteNameFlag?: null | boolean; slaInfoFlag?: null | boolean; statusFlag?: null | boolean; timeMaterialsTicketTemplate?: { _info?: {}; id?: null | number; name?: string } }>

putCompanyPortalSecurityLevelsById

  • putCompanyPortalSecurityLevelsById(id: number, _portalSecurityLevel: { _info?: {}; caption?: string; captionIdentifier?: string; id?: number; isDefaultFlag?: null | boolean }): Promise<{ _info?: {}; caption?: string; captionIdentifier?: string; id?: number; isDefaultFlag?: null | boolean }>

  • Parameters

    • id: number
    • _portalSecurityLevel: { _info?: {}; caption?: string; captionIdentifier?: string; id?: number; isDefaultFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional caption?: string
        description

        Max length: 50;

      • Optional captionIdentifier?: string
      • Optional id?: number

        Format: int32

      • Optional isDefaultFlag?: null | boolean

    Returns Promise<{ _info?: {}; caption?: string; captionIdentifier?: string; id?: number; isDefaultFlag?: null | boolean }>

putCompanyPortalSecuritySettingsById

  • putCompanyPortalSecuritySettingsById(id: number, portalSecurity: { _info?: {}; functionDescription?: string; functionIdentifier?: string; id?: number; levelFive?: null | boolean; levelFour?: null | boolean; levelOne?: null | boolean; levelSix?: null | boolean; levelThree?: null | boolean; levelTwo?: null | boolean }): Promise<{ _info?: {}; functionDescription?: string; functionIdentifier?: string; id?: number; levelFive?: null | boolean; levelFour?: null | boolean; levelOne?: null | boolean; levelSix?: null | boolean; levelThree?: null | boolean; levelTwo?: null | boolean }>

  • Parameters

    • id: number
    • portalSecurity: { _info?: {}; functionDescription?: string; functionIdentifier?: string; id?: number; levelFive?: null | boolean; levelFour?: null | boolean; levelOne?: null | boolean; levelSix?: null | boolean; levelThree?: null | boolean; levelTwo?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional functionDescription?: string
      • Optional functionIdentifier?: string
      • Optional id?: number

        Format: int32

      • Optional levelFive?: null | boolean
      • Optional levelFour?: null | boolean
      • Optional levelOne?: null | boolean
      • Optional levelSix?: null | boolean
      • Optional levelThree?: null | boolean
      • Optional levelTwo?: null | boolean

    Returns Promise<{ _info?: {}; functionDescription?: string; functionIdentifier?: string; id?: number; levelFive?: null | boolean; levelFour?: null | boolean; levelOne?: null | boolean; levelSix?: null | boolean; levelThree?: null | boolean; levelTwo?: null | boolean }>

putCompanyStatesById

  • putCompanyStatesById(id: number, state: { _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier: string; name: string }): Promise<{ _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier: string; name: string }>

  • Parameters

    • id: number
    • state: { _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier: string; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional id?: number

        Format: int32

      • identifier: string
        description

        Max length: 50;

      • name: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; identifier: string; name: string }>

putCompanyTeamRolesById

  • putCompanyTeamRolesById(id: number, teamRole: { _info?: {}; accountManagerFlag?: null | boolean; id?: number; name: string; salesFlag?: null | boolean; techFlag?: null | boolean }): Promise<{ _info?: {}; accountManagerFlag?: null | boolean; id?: number; name: string; salesFlag?: null | boolean; techFlag?: null | boolean }>

  • Parameters

    • id: number
    • teamRole: { _info?: {}; accountManagerFlag?: null | boolean; id?: number; name: string; salesFlag?: null | boolean; techFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional accountManagerFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 20;

      • Optional salesFlag?: null | boolean
      • Optional techFlag?: null | boolean

    Returns Promise<{ _info?: {}; accountManagerFlag?: null | boolean; id?: number; name: string; salesFlag?: null | boolean; techFlag?: null | boolean }>

putCompanyTracksById

  • putCompanyTracksById(id: number, track: { _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; notifyActionIds?: number[] }): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; notifyActionIds?: number[] }>

  • Parameters

    • id: number
    • track: { _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; notifyActionIds?: number[] }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • name: string
        description

        Max length: 100;

      • Optional notifyActionIds?: number[]

    Returns Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string; notifyActionIds?: number[] }>

putCompanyTracksByParentIdActionsById

  • putCompanyTracksByParentIdActionsById(id: number, parentId: number, trackAction: { _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: "CreateActivity" | "SendEmail" | "AddToGroup" | "AttachTrack" | "ChangeCompanyStatus" | "CreateServiceTicket"; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subject?: string; track?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: "CreateActivity" | "SendEmail" | "AddToGroup" | "AttachTrack" | "ChangeCompanyStatus" | "CreateServiceTicket"; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subject?: string; track?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • trackAction: { _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: "CreateActivity" | "SendEmail" | "AddToGroup" | "AttachTrack" | "ChangeCompanyStatus" | "CreateServiceTicket"; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subject?: string; track?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional activityStatus?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional activityType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional attachedTrack?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional bccContact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional ccContact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional companyStatus?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional daysToExecute?: null | number

        Format: int32

      • Optional emailFrom?: string
        description

        Max length: 250;

      • Optional emailRecipient?: string
        description

        Max length: 250;

      • Optional group?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional notes?: string
      • Optional notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • notifyType: "CreateActivity" | "SendEmail" | "AddToGroup" | "AttachTrack" | "ChangeCompanyStatus" | "CreateServiceTicket"
      • Optional notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional summary?: string
      • Optional specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional subject?: string
        description

        Max length: 100;

      • Optional track?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: "CreateActivity" | "SendEmail" | "AddToGroup" | "AttachTrack" | "ChangeCompanyStatus" | "CreateServiceTicket"; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subject?: string; track?: { _info?: {}; id?: null | number; name?: string } }>

Generated using TypeDoc