Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SystemAPI

System module

Hierarchy

  • default
    • SystemAPI

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

deleteSystemAllowedfiletypesById

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

deleteSystemAllowedoriginsById

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

deleteSystemAutoSyncTimeById

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

deleteSystemCallbacksById

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

deleteSystemCertificationsById

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

deleteSystemConnectwisehostedsetupsById

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

deleteSystemCustomReportsById

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

deleteSystemCustomReportsByParentIdParametersById

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

deleteSystemDepartmentsById

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

deleteSystemDepartmentsByParentIdLocationsById

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

deleteSystemDocumentsById

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

deleteSystemEPayConfigurationsById

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

deleteSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRulesById

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

deleteSystemEmailConnectorsById

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

deleteSystemEmailConnectorsByParentIdParsingStylesById

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

deleteSystemEmailExclusionsById

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

deleteSystemGoogleemailsetupById

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

deleteSystemImapsById

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

deleteSystemInOutBoardsById

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

deleteSystemInOutTypesById

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

deleteSystemIntegratorTagsById

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

deleteSystemIntegratorloginsById

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

deleteSystemLdapConfigurationsById

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

deleteSystemLinksById

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

deleteSystemLocationsById

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

deleteSystemManagementNetworkSecuritiesById

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

deleteSystemMembersByIdUnusedTimeSheets

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

deleteSystemMembersByParentIdAccrualsById

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

deleteSystemMembersByParentIdCertificationsById

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

deleteSystemMembersByParentIdDelegationsById

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

deleteSystemMembersByParentIdManagedDeviceAccountsBulk

  • deleteSystemMembersByParentIdManagedDeviceAccountsBulk(parentId: number, managedDeviceAccounts: { ids?: number[] }): 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 }[] }>

  • Parameters

    • parentId: number
    • managedDeviceAccounts: { ids?: number[] }
      • Optional ids?: number[]

    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 }[] }>

deleteSystemMembersByParentIdMycertificationsById

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

deleteSystemMembersByParentIdNotificationSettingsById

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

deleteSystemMembersByParentIdSkillsById

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

deleteSystemMembersTypesById

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

deleteSystemMenuEntriesByParentIdLocationsById

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

deleteSystemMenuentriesById

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

deleteSystemMyAccountByParentIdDelegationsById

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

deleteSystemMyAccountByParentIdSkillsById

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

deleteSystemOffice365EmailSetupsById

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

deleteSystemPortalReportsById

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

deleteSystemQuoteLinkSetupById

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

deleteSystemReportCardsById

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

deleteSystemReportCardsByParentIdDetailsById

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

deleteSystemSecurityrolesById

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

deleteSystemSkillCategoriesById

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

deleteSystemSkillsById

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

deleteSystemSsoConfigurationsById

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

deleteSystemStandardNotesById

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

deleteSystemSurveysByGrandparentIdQuestionsByParentIdValuesById

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

deleteSystemSurveysById

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

deleteSystemSurveysByParentIdQuestionsById

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

deleteSystemTimeZoneSetupsById

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

deleteSystemTodayPageCategoriesById

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

deleteSystemUserDefinedFieldsById

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

deleteSystemWorkflowActionsByParentIdAutomateParametersById

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

deleteSystemWorkflowsByGrandparentIdEventsByParentIdActionsById

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

deleteSystemWorkflowsById

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

deleteSystemWorkflowsByParentIdEventsById

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

deleteSystemWorkflowsUserdefinedfieldsActionsByParentId

  • deleteSystemWorkflowsUserdefinedfieldsActionsByParentId(parentId: number): Promise<undefined>

getSystemAllowedfiletypes

  • getSystemAllowedfiletypes(params?: CommonParameters): Promise<{ _info?: {}; fileType: string; id?: number; sizeLimit?: null | number }[]>

getSystemAllowedfiletypesById

  • getSystemAllowedfiletypesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; fileType: string; id?: number; sizeLimit?: null | number }>

getSystemAllowedfiletypesCount

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

getSystemAllowedorigins

  • getSystemAllowedorigins(params?: CommonParameters): Promise<{ _info?: {}; description: string; id?: number; lastUpdateUtc?: string; origin: string; updatedBy?: string }[]>

getSystemAllowedoriginsById

  • getSystemAllowedoriginsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; description: string; id?: number; lastUpdateUtc?: string; origin: string; updatedBy?: string }>

getSystemAllowedoriginsCount

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

getSystemApiMembers

  • getSystemApiMembers(params?: CommonParameters): Promise<{ _info?: {}; blockCostFlag?: null | boolean; blockPriceFlag?: null | boolean; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; excludedServiceBoardIds?: number[]; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; name?: string; notes?: string; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; blockCostFlag?: null | boolean; blockPriceFlag?: null | boolean; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; excludedServiceBoardIds?: number[]; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; name?: string; notes?: string; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string } }[]>

getSystemApiMembersById

  • getSystemApiMembersById(id: number, params?: CommonParameters): Promise<{ _info?: {}; blockCostFlag?: null | boolean; blockPriceFlag?: null | boolean; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; excludedServiceBoardIds?: number[]; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; name?: string; notes?: string; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; blockCostFlag?: null | boolean; blockPriceFlag?: null | boolean; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; excludedServiceBoardIds?: number[]; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; name?: string; notes?: string; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

getSystemApiMembersCount

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

getSystemApiMembersDefault

  • getSystemApiMembersDefault(params?: CommonParameters): Promise<{ _info?: {}; blockCostFlag?: null | boolean; blockPriceFlag?: null | boolean; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; excludedServiceBoardIds?: number[]; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; name?: string; notes?: string; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; blockCostFlag?: null | boolean; blockPriceFlag?: null | boolean; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; excludedServiceBoardIds?: number[]; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; name?: string; notes?: string; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

getSystemAudittrail

  • getSystemAudittrail(params?: CommonParameters): Promise<{ auditSource?: string; auditSubType?: string; auditType?: string; enteredBy?: string; enteredDate?: string; text?: string }[]>

  • Parameters

    Returns Promise<{ auditSource?: string; auditSubType?: string; auditType?: string; enteredBy?: string; enteredDate?: string; text?: string }[]>

getSystemAudittrailCount

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

getSystemAuthAnvils

  • getSystemAuthAnvils(params?: CommonParameters): Promise<{ _info?: {}; id?: number; serverLocationUrl: string; siteId: null | number }[]>

getSystemAuthAnvilsById

  • getSystemAuthAnvilsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; serverLocationUrl: string; siteId: null | number }>

getSystemAuthAnvilsCount

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

getSystemAuthAnvilsTestConnection

  • getSystemAuthAnvilsTestConnection(params?: CommonParameters): Promise<{ message?: string; success?: boolean }>

getSystemAutoSyncTime

  • getSystemAutoSyncTime(params?: CommonParameters): Promise<{ _info?: {}; id?: number; syncTime: string; timeZone?: { _info?: {}; id?: null | number; name?: string } }[]>

getSystemAutoSyncTimeById

  • getSystemAutoSyncTimeById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; syncTime: string; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

getSystemAutoSyncTimeCount

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

getSystemCallbacks

  • getSystemCallbacks(params?: CommonParameters): Promise<{ _info?: {}; description?: string; id?: number; inactiveFlag?: null | boolean; isSelfSuppressedFlag?: null | boolean; isSoapCallbackFlag?: null | boolean; level?: string; memberId?: null | number; objectId?: null | number; payloadVersion?: string; type?: string; url?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; description?: string; id?: number; inactiveFlag?: null | boolean; isSelfSuppressedFlag?: null | boolean; isSoapCallbackFlag?: null | boolean; level?: string; memberId?: null | number; objectId?: null | number; payloadVersion?: string; type?: string; url?: string }[]>

getSystemCallbacksById

  • getSystemCallbacksById(id: number, params?: CommonParameters): Promise<{ _info?: {}; description?: string; id?: number; inactiveFlag?: null | boolean; isSelfSuppressedFlag?: null | boolean; isSoapCallbackFlag?: null | boolean; level?: string; memberId?: null | number; objectId?: null | number; payloadVersion?: string; type?: string; url?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; description?: string; id?: number; inactiveFlag?: null | boolean; isSelfSuppressedFlag?: null | boolean; isSoapCallbackFlag?: null | boolean; level?: string; memberId?: null | number; objectId?: null | number; payloadVersion?: string; type?: string; url?: string }>

getSystemCallbacksCount

getSystemCertifications

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

  • Parameters

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

getSystemCertificationsById

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

  • Parameters

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

getSystemCertificationsByIdUsages

  • getSystemCertificationsByIdUsages(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 }[]>

getSystemCertificationsByIdUsagesList

  • getSystemCertificationsByIdUsagesList(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 }[]>

getSystemCertificationsCount

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

getSystemConnectWiseHostedScreens

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

getSystemConnectWiseHostedScreensById

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

getSystemConnectWiseHostedScreensCount

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

getSystemConnectwisehostedsetups

  • getSystemConnectwisehostedsetups(params?: CommonParameters): Promise<{ _info?: {}; clientId?: string; createdBy?: string; dateCreated?: string; description: string; disabledFlag?: null | boolean; id?: number; locationIds?: number[]; locationsEnabledFlag?: null | boolean; origin?: string; podHeight?: null | number; screenId: null | number; toolbarButtonDialogHeight?: null | number; toolbarButtonDialogWidth?: null | number; toolbarButtonIconDocumentId?: null | number; toolbarButtonText?: string; toolbarButtonToolTip?: string; type: null | "Tab" | "Pod" | "ToolbarButton"; url: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; clientId?: string; createdBy?: string; dateCreated?: string; description: string; disabledFlag?: null | boolean; id?: number; locationIds?: number[]; locationsEnabledFlag?: null | boolean; origin?: string; podHeight?: null | number; screenId: null | number; toolbarButtonDialogHeight?: null | number; toolbarButtonDialogWidth?: null | number; toolbarButtonIconDocumentId?: null | number; toolbarButtonText?: string; toolbarButtonToolTip?: string; type: null | "Tab" | "Pod" | "ToolbarButton"; url: string }[]>

getSystemConnectwisehostedsetupsById

  • getSystemConnectwisehostedsetupsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; clientId?: string; createdBy?: string; dateCreated?: string; description: string; disabledFlag?: null | boolean; id?: number; locationIds?: number[]; locationsEnabledFlag?: null | boolean; origin?: string; podHeight?: null | number; screenId: null | number; toolbarButtonDialogHeight?: null | number; toolbarButtonDialogWidth?: null | number; toolbarButtonIconDocumentId?: null | number; toolbarButtonText?: string; toolbarButtonToolTip?: string; type: null | "Tab" | "Pod" | "ToolbarButton"; url: string }>

  • Parameters

    Returns Promise<{ _info?: {}; clientId?: string; createdBy?: string; dateCreated?: string; description: string; disabledFlag?: null | boolean; id?: number; locationIds?: number[]; locationsEnabledFlag?: null | boolean; origin?: string; podHeight?: null | number; screenId: null | number; toolbarButtonDialogHeight?: null | number; toolbarButtonDialogWidth?: null | number; toolbarButtonIconDocumentId?: null | number; toolbarButtonText?: string; toolbarButtonToolTip?: string; type: null | "Tab" | "Pod" | "ToolbarButton"; url: string }>

getSystemConnectwisehostedsetupsCount

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

getSystemCustomReports

  • getSystemCustomReports(params?: CommonParameters): Promise<{ _info?: {}; agreementFlag?: null | boolean; agreementOverride?: string; agreementParamId?: null | number; agreementTypeFlag?: null | boolean; agreementTypeOverride?: string; agreementTypeParamId?: null | number; companyFlag?: null | boolean; companyOverride?: string; companyParamId?: null | number; departmentDefaultFlag?: null | boolean; departmentFlag?: null | boolean; departmentOverride?: string; departmentParamId?: null | number; description: string; endDateFlag?: null | boolean; endDateOverride?: string; endDateParamId?: null | number; generatedFlag?: null | boolean; id?: number; invoiceFlag?: null | boolean; invoiceOverride?: string; invoiceParamId?: null | number; locationDefaultFlag?: null | boolean; locationFlag?: null | boolean; locationOverride?: string; locationParamId?: null | number; marketingCampaignFlag?: null | boolean; marketingCampaignOverride?: string; marketingCampaignParamId?: null | number; memberFlag?: null | boolean; memberOverride?: string; memberParamId?: null | number; module: null | "Project" | "Finance" | "Sales" | "Companies" | "Marketing" | "Procurement" | "ServiceDesk" | "TimeExpense"; name: string; oppTypeFlag?: null | boolean; oppTypeOverride?: string; oppTypeParamId?: null | number; opportunityFlag?: null | boolean; opportunityOverride?: string; opportunityParamId?: null | number; parameterNameSeparator?: string; parameterPrefix?: string; parameterSeparator?: string; parameterSuffix?: string; projectFlag?: null | boolean; projectOverride?: string; projectParamId?: null | number; projectTypeFlag?: null | boolean; projectTypeOverride?: string; projectTypeParamId?: null | number; reportLink: string; serviceBoardDefaultFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceBoardOverride?: string; serviceBoardParamId?: null | number; serviceStatusFlag?: null | boolean; serviceStatusOverride?: string; serviceStatusParamId?: null | number; serviceTypeFlag?: null | boolean; serviceTypeOverride?: string; serviceTypeParamId?: null | number; startDateFlag?: null | boolean; startDateOverride?: string; startDateParamId?: null | number; territoryDefaultFlag?: null | boolean; territoryFlag?: null | boolean; territoryOverride?: string; territoryParamId?: null | number; workRoleFlag?: null | boolean; workRoleOverride?: string; workRoleParamId?: null | number; workTypeFlag?: null | boolean; workTypeOverride?: string; workTypeParamId?: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; agreementFlag?: null | boolean; agreementOverride?: string; agreementParamId?: null | number; agreementTypeFlag?: null | boolean; agreementTypeOverride?: string; agreementTypeParamId?: null | number; companyFlag?: null | boolean; companyOverride?: string; companyParamId?: null | number; departmentDefaultFlag?: null | boolean; departmentFlag?: null | boolean; departmentOverride?: string; departmentParamId?: null | number; description: string; endDateFlag?: null | boolean; endDateOverride?: string; endDateParamId?: null | number; generatedFlag?: null | boolean; id?: number; invoiceFlag?: null | boolean; invoiceOverride?: string; invoiceParamId?: null | number; locationDefaultFlag?: null | boolean; locationFlag?: null | boolean; locationOverride?: string; locationParamId?: null | number; marketingCampaignFlag?: null | boolean; marketingCampaignOverride?: string; marketingCampaignParamId?: null | number; memberFlag?: null | boolean; memberOverride?: string; memberParamId?: null | number; module: null | "Project" | "Finance" | "Sales" | "Companies" | "Marketing" | "Procurement" | "ServiceDesk" | "TimeExpense"; name: string; oppTypeFlag?: null | boolean; oppTypeOverride?: string; oppTypeParamId?: null | number; opportunityFlag?: null | boolean; opportunityOverride?: string; opportunityParamId?: null | number; parameterNameSeparator?: string; parameterPrefix?: string; parameterSeparator?: string; parameterSuffix?: string; projectFlag?: null | boolean; projectOverride?: string; projectParamId?: null | number; projectTypeFlag?: null | boolean; projectTypeOverride?: string; projectTypeParamId?: null | number; reportLink: string; serviceBoardDefaultFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceBoardOverride?: string; serviceBoardParamId?: null | number; serviceStatusFlag?: null | boolean; serviceStatusOverride?: string; serviceStatusParamId?: null | number; serviceTypeFlag?: null | boolean; serviceTypeOverride?: string; serviceTypeParamId?: null | number; startDateFlag?: null | boolean; startDateOverride?: string; startDateParamId?: null | number; territoryDefaultFlag?: null | boolean; territoryFlag?: null | boolean; territoryOverride?: string; territoryParamId?: null | number; workRoleFlag?: null | boolean; workRoleOverride?: string; workRoleParamId?: null | number; workTypeFlag?: null | boolean; workTypeOverride?: string; workTypeParamId?: null | number }[]>

getSystemCustomReportsById

  • getSystemCustomReportsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; agreementFlag?: null | boolean; agreementOverride?: string; agreementParamId?: null | number; agreementTypeFlag?: null | boolean; agreementTypeOverride?: string; agreementTypeParamId?: null | number; companyFlag?: null | boolean; companyOverride?: string; companyParamId?: null | number; departmentDefaultFlag?: null | boolean; departmentFlag?: null | boolean; departmentOverride?: string; departmentParamId?: null | number; description: string; endDateFlag?: null | boolean; endDateOverride?: string; endDateParamId?: null | number; generatedFlag?: null | boolean; id?: number; invoiceFlag?: null | boolean; invoiceOverride?: string; invoiceParamId?: null | number; locationDefaultFlag?: null | boolean; locationFlag?: null | boolean; locationOverride?: string; locationParamId?: null | number; marketingCampaignFlag?: null | boolean; marketingCampaignOverride?: string; marketingCampaignParamId?: null | number; memberFlag?: null | boolean; memberOverride?: string; memberParamId?: null | number; module: null | "Project" | "Finance" | "Sales" | "Companies" | "Marketing" | "Procurement" | "ServiceDesk" | "TimeExpense"; name: string; oppTypeFlag?: null | boolean; oppTypeOverride?: string; oppTypeParamId?: null | number; opportunityFlag?: null | boolean; opportunityOverride?: string; opportunityParamId?: null | number; parameterNameSeparator?: string; parameterPrefix?: string; parameterSeparator?: string; parameterSuffix?: string; projectFlag?: null | boolean; projectOverride?: string; projectParamId?: null | number; projectTypeFlag?: null | boolean; projectTypeOverride?: string; projectTypeParamId?: null | number; reportLink: string; serviceBoardDefaultFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceBoardOverride?: string; serviceBoardParamId?: null | number; serviceStatusFlag?: null | boolean; serviceStatusOverride?: string; serviceStatusParamId?: null | number; serviceTypeFlag?: null | boolean; serviceTypeOverride?: string; serviceTypeParamId?: null | number; startDateFlag?: null | boolean; startDateOverride?: string; startDateParamId?: null | number; territoryDefaultFlag?: null | boolean; territoryFlag?: null | boolean; territoryOverride?: string; territoryParamId?: null | number; workRoleFlag?: null | boolean; workRoleOverride?: string; workRoleParamId?: null | number; workTypeFlag?: null | boolean; workTypeOverride?: string; workTypeParamId?: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; agreementFlag?: null | boolean; agreementOverride?: string; agreementParamId?: null | number; agreementTypeFlag?: null | boolean; agreementTypeOverride?: string; agreementTypeParamId?: null | number; companyFlag?: null | boolean; companyOverride?: string; companyParamId?: null | number; departmentDefaultFlag?: null | boolean; departmentFlag?: null | boolean; departmentOverride?: string; departmentParamId?: null | number; description: string; endDateFlag?: null | boolean; endDateOverride?: string; endDateParamId?: null | number; generatedFlag?: null | boolean; id?: number; invoiceFlag?: null | boolean; invoiceOverride?: string; invoiceParamId?: null | number; locationDefaultFlag?: null | boolean; locationFlag?: null | boolean; locationOverride?: string; locationParamId?: null | number; marketingCampaignFlag?: null | boolean; marketingCampaignOverride?: string; marketingCampaignParamId?: null | number; memberFlag?: null | boolean; memberOverride?: string; memberParamId?: null | number; module: null | "Project" | "Finance" | "Sales" | "Companies" | "Marketing" | "Procurement" | "ServiceDesk" | "TimeExpense"; name: string; oppTypeFlag?: null | boolean; oppTypeOverride?: string; oppTypeParamId?: null | number; opportunityFlag?: null | boolean; opportunityOverride?: string; opportunityParamId?: null | number; parameterNameSeparator?: string; parameterPrefix?: string; parameterSeparator?: string; parameterSuffix?: string; projectFlag?: null | boolean; projectOverride?: string; projectParamId?: null | number; projectTypeFlag?: null | boolean; projectTypeOverride?: string; projectTypeParamId?: null | number; reportLink: string; serviceBoardDefaultFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceBoardOverride?: string; serviceBoardParamId?: null | number; serviceStatusFlag?: null | boolean; serviceStatusOverride?: string; serviceStatusParamId?: null | number; serviceTypeFlag?: null | boolean; serviceTypeOverride?: string; serviceTypeParamId?: null | number; startDateFlag?: null | boolean; startDateOverride?: string; startDateParamId?: null | number; territoryDefaultFlag?: null | boolean; territoryFlag?: null | boolean; territoryOverride?: string; territoryParamId?: null | number; workRoleFlag?: null | boolean; workRoleOverride?: string; workRoleParamId?: null | number; workTypeFlag?: null | boolean; workTypeOverride?: string; workTypeParamId?: null | number }>

getSystemCustomReportsByParentIdParameters

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

  • Parameters

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

getSystemCustomReportsByParentIdParametersById

  • getSystemCustomReportsByParentIdParametersById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; captionName?: string; customReport?: { _info?: {}; id?: null | number; name?: string }; id?: number; name?: string }>

  • Parameters

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

getSystemCustomReportsByParentIdParametersCount

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

getSystemCustomReportsCount

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

getSystemCwTimeZones

  • getSystemCwTimeZones(params?: CommonParameters): Promise<{ _info?: {}; daylightSavingsFlag?: null | boolean; endDate?: string; id?: number; name?: string; offset?: number; startDate?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; daylightSavingsFlag?: null | boolean; endDate?: string; id?: number; name?: string; offset?: number; startDate?: string }[]>

getSystemCwTimeZonesById

  • getSystemCwTimeZonesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; daylightSavingsFlag?: null | boolean; endDate?: string; id?: number; name?: string; offset?: number; startDate?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; daylightSavingsFlag?: null | boolean; endDate?: string; id?: number; name?: string; offset?: number; startDate?: string }>

getSystemCwTimeZonesCount

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

getSystemDepartments

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

getSystemDepartmentsById

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

getSystemDepartmentsByIdUsages

  • getSystemDepartmentsByIdUsages(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 }[]>

getSystemDepartmentsByIdUsagesList

  • getSystemDepartmentsByIdUsagesList(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 }[]>

getSystemDepartmentsByParentIdLocations

  • getSystemDepartmentsByParentIdLocations(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; addAllLocations?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; departmentManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatch?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; ldapConfig?: { _info?: {}; id?: null | number; name?: string; server?: string }; location?: { _info?: {}; id?: null | number; name?: string }; removeAllLocations?: null | boolean; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; addAllLocations?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; departmentManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatch?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; ldapConfig?: { _info?: {}; id?: null | number; name?: string; server?: string }; location?: { _info?: {}; id?: null | number; name?: string }; removeAllLocations?: null | boolean; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

getSystemDepartmentsByParentIdLocationsById

  • getSystemDepartmentsByParentIdLocationsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; addAllLocations?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; departmentManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatch?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; ldapConfig?: { _info?: {}; id?: null | number; name?: string; server?: string }; location?: { _info?: {}; id?: null | number; name?: string }; removeAllLocations?: null | boolean; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; addAllLocations?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; departmentManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatch?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; ldapConfig?: { _info?: {}; id?: null | number; name?: string; server?: string }; location?: { _info?: {}; id?: null | number; name?: string }; removeAllLocations?: null | boolean; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

getSystemDepartmentsByParentIdLocationsCount

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

getSystemDepartmentsCount

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

getSystemDocuments

  • getSystemDocuments(params?: CommonParameters): Promise<{ _info?: {}; fileName?: string; guid?: string; htmlTemplateFlag?: null | boolean; id?: number; imageFlag?: null | boolean; linkFlag?: null | boolean; owner?: string; publicFlag?: null | boolean; readOnlyFlag?: null | boolean; serverFileName?: string; size?: null | number; title?: string; urlFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; fileName?: string; guid?: string; htmlTemplateFlag?: null | boolean; id?: number; imageFlag?: null | boolean; linkFlag?: null | boolean; owner?: string; publicFlag?: null | boolean; readOnlyFlag?: null | boolean; serverFileName?: string; size?: null | number; title?: string; urlFlag?: null | boolean }[]>

getSystemDocumentsById

  • getSystemDocumentsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; fileName?: string; guid?: string; htmlTemplateFlag?: null | boolean; id?: number; imageFlag?: null | boolean; linkFlag?: null | boolean; owner?: string; publicFlag?: null | boolean; readOnlyFlag?: null | boolean; serverFileName?: string; size?: null | number; title?: string; urlFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; fileName?: string; guid?: string; htmlTemplateFlag?: null | boolean; id?: number; imageFlag?: null | boolean; linkFlag?: null | boolean; owner?: string; publicFlag?: null | boolean; readOnlyFlag?: null | boolean; serverFileName?: string; size?: null | number; title?: string; urlFlag?: null | boolean }>

getSystemDocumentsByIdDownload

  • getSystemDocumentsByIdDownload(id: number, params?: CommonParameters): Promise<string>

getSystemDocumentsByIdThumbnail

  • getSystemDocumentsByIdThumbnail(id: number, params?: CommonParameters): Promise<string>

getSystemDocumentsCount

getSystemDocumentsUploadsample

getSystemEPayConfigurations

  • getSystemEPayConfigurations(params?: CommonParameters): Promise<{ _info?: {}; 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 }; encryptionKey?: string; id?: number; initializationVector?: string; location?: { _info?: {}; id?: null | number; name?: string }; storeIdentifier: string; url: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; 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 }; encryptionKey?: string; id?: number; initializationVector?: string; location?: { _info?: {}; id?: null | number; name?: string }; storeIdentifier: string; url: string }[]>

getSystemEPayConfigurationsById

  • getSystemEPayConfigurationsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; 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 }; encryptionKey?: string; id?: number; initializationVector?: string; location?: { _info?: {}; id?: null | number; name?: string }; storeIdentifier: string; url: string }>

  • Parameters

    Returns Promise<{ _info?: {}; 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 }; encryptionKey?: string; id?: number; initializationVector?: string; location?: { _info?: {}; id?: null | number; name?: string }; storeIdentifier: string; url: string }>

getSystemEPayConfigurationsCount

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

getSystemEmailConnectors

  • getSystemEmailConnectors(params?: CommonParameters): Promise<{ _info?: {}; addCcFlag?: null | boolean; bccEmailTo?: string; createContactFlag?: null | boolean; defaultCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; discardDuplicatesFlag?: null | boolean; emailErrorsTo: string; emailNotifyFrom?: string; emailServerType?: null | "IMAP" | "Office365" | "Google"; googleEmailSetup?: { _info?: {}; id?: null | number; name?: string }; id?: number; imapSetup?: { _info?: {}; id?: null | number; name?: string }; itemOverride?: { _info?: {}; id?: null | number; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; neverRespondFlag?: null | boolean; noResponseFlag?: null | boolean; office365EmailSetup?: { _info?: {}; id?: null | number; name?: string }; postRepliesToTicketFlag?: null | boolean; priorityOverride?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; responseEmailForExisting?: string; responseEmailForNew?: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; setEmailToDefaultContactFlag?: null | boolean; sourceOverride?: { _info?: {}; id?: null | number; name?: string }; statusOverride?: { _info?: {}; id?: null | number; name?: string }; subTypeOverride?: { _info?: {}; id?: null | number; name?: string }; typeOverride?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; addCcFlag?: null | boolean; bccEmailTo?: string; createContactFlag?: null | boolean; defaultCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; discardDuplicatesFlag?: null | boolean; emailErrorsTo: string; emailNotifyFrom?: string; emailServerType?: null | "IMAP" | "Office365" | "Google"; googleEmailSetup?: { _info?: {}; id?: null | number; name?: string }; id?: number; imapSetup?: { _info?: {}; id?: null | number; name?: string }; itemOverride?: { _info?: {}; id?: null | number; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; neverRespondFlag?: null | boolean; noResponseFlag?: null | boolean; office365EmailSetup?: { _info?: {}; id?: null | number; name?: string }; postRepliesToTicketFlag?: null | boolean; priorityOverride?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; responseEmailForExisting?: string; responseEmailForNew?: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; setEmailToDefaultContactFlag?: null | boolean; sourceOverride?: { _info?: {}; id?: null | number; name?: string }; statusOverride?: { _info?: {}; id?: null | number; name?: string }; subTypeOverride?: { _info?: {}; id?: null | number; name?: string }; typeOverride?: { _info?: {}; id?: null | number; name?: string } }[]>

getSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRules

  • getSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRules(parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; parsingStyle?: { _info?: {}; id?: null | number; name?: string }; parsingVariable?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority: null | number; searchTerm: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceStatus?: { _info?: {}; id?: null | number; name?: string }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; parsingStyle?: { _info?: {}; id?: null | number; name?: string }; parsingVariable?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority: null | number; searchTerm: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceStatus?: { _info?: {}; id?: null | number; name?: string }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string } }[]>

getSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRulesById

  • getSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRulesById(id: number, parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; parsingStyle?: { _info?: {}; id?: null | number; name?: string }; parsingVariable?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority: null | number; searchTerm: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceStatus?: { _info?: {}; id?: null | number; name?: string }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; parsingStyle?: { _info?: {}; id?: null | number; name?: string }; parsingVariable?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority: null | number; searchTerm: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceStatus?: { _info?: {}; id?: null | number; name?: string }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string } }>

getSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRulesCount

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

getSystemEmailConnectorsById

  • getSystemEmailConnectorsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; addCcFlag?: null | boolean; bccEmailTo?: string; createContactFlag?: null | boolean; defaultCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; discardDuplicatesFlag?: null | boolean; emailErrorsTo: string; emailNotifyFrom?: string; emailServerType?: null | "IMAP" | "Office365" | "Google"; googleEmailSetup?: { _info?: {}; id?: null | number; name?: string }; id?: number; imapSetup?: { _info?: {}; id?: null | number; name?: string }; itemOverride?: { _info?: {}; id?: null | number; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; neverRespondFlag?: null | boolean; noResponseFlag?: null | boolean; office365EmailSetup?: { _info?: {}; id?: null | number; name?: string }; postRepliesToTicketFlag?: null | boolean; priorityOverride?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; responseEmailForExisting?: string; responseEmailForNew?: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; setEmailToDefaultContactFlag?: null | boolean; sourceOverride?: { _info?: {}; id?: null | number; name?: string }; statusOverride?: { _info?: {}; id?: null | number; name?: string }; subTypeOverride?: { _info?: {}; id?: null | number; name?: string }; typeOverride?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; addCcFlag?: null | boolean; bccEmailTo?: string; createContactFlag?: null | boolean; defaultCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; discardDuplicatesFlag?: null | boolean; emailErrorsTo: string; emailNotifyFrom?: string; emailServerType?: null | "IMAP" | "Office365" | "Google"; googleEmailSetup?: { _info?: {}; id?: null | number; name?: string }; id?: number; imapSetup?: { _info?: {}; id?: null | number; name?: string }; itemOverride?: { _info?: {}; id?: null | number; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; neverRespondFlag?: null | boolean; noResponseFlag?: null | boolean; office365EmailSetup?: { _info?: {}; id?: null | number; name?: string }; postRepliesToTicketFlag?: null | boolean; priorityOverride?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; responseEmailForExisting?: string; responseEmailForNew?: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; setEmailToDefaultContactFlag?: null | boolean; sourceOverride?: { _info?: {}; id?: null | number; name?: string }; statusOverride?: { _info?: {}; id?: null | number; name?: string }; subTypeOverride?: { _info?: {}; id?: null | number; name?: string }; typeOverride?: { _info?: {}; id?: null | number; name?: string } }>

getSystemEmailConnectorsByIdInfo

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

getSystemEmailConnectorsByParentIdParsingStyles

  • getSystemEmailConnectorsByParentIdParsingStyles(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; parseRule: string; parsingType?: { _info?: {}; id?: null | number; name?: string }; priority: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; parseRule: string; parsingType?: { _info?: {}; id?: null | number; name?: string }; priority: null | number }[]>

getSystemEmailConnectorsByParentIdParsingStylesById

  • getSystemEmailConnectorsByParentIdParsingStylesById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; parseRule: string; parsingType?: { _info?: {}; id?: null | number; name?: string }; priority: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; parseRule: string; parsingType?: { _info?: {}; id?: null | number; name?: string }; priority: null | number }>

getSystemEmailConnectorsByParentIdParsingStylesCount

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

getSystemEmailConnectorsCount

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

getSystemEmailConnectorsInfo

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

getSystemEmailConnectorsInfoCount

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

getSystemEmailExclusions

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

getSystemEmailExclusionsById

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

getSystemEmailExclusionsCount

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

getSystemEmailTokens

  • getSystemEmailTokens(params?: CommonParameters): Promise<{ addressFlag?: null | boolean; agreementFlag?: null | boolean; companyFlag?: null | boolean; configFlag?: null | boolean; contactFlag?: null | boolean; description?: string; id?: number; invoiceFlag?: null | boolean; portalPasswordFlag?: null | boolean; purchaseOrderFlag?: null | boolean; purchaseOrderStatusFlag?: null | boolean; rmaFlag?: null | boolean; salesFlag?: null | boolean; serviceFlag?: null | boolean; token?: string; tracksFlag?: null | boolean; workflowFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ addressFlag?: null | boolean; agreementFlag?: null | boolean; companyFlag?: null | boolean; configFlag?: null | boolean; contactFlag?: null | boolean; description?: string; id?: number; invoiceFlag?: null | boolean; portalPasswordFlag?: null | boolean; purchaseOrderFlag?: null | boolean; purchaseOrderStatusFlag?: null | boolean; rmaFlag?: null | boolean; salesFlag?: null | boolean; serviceFlag?: null | boolean; token?: string; tracksFlag?: null | boolean; workflowFlag?: null | boolean }[]>

getSystemEmailTokensById

  • getSystemEmailTokensById(id: number, params?: CommonParameters): Promise<{ addressFlag?: null | boolean; agreementFlag?: null | boolean; companyFlag?: null | boolean; configFlag?: null | boolean; contactFlag?: null | boolean; description?: string; id?: number; invoiceFlag?: null | boolean; portalPasswordFlag?: null | boolean; purchaseOrderFlag?: null | boolean; purchaseOrderStatusFlag?: null | boolean; rmaFlag?: null | boolean; salesFlag?: null | boolean; serviceFlag?: null | boolean; token?: string; tracksFlag?: null | boolean; workflowFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ addressFlag?: null | boolean; agreementFlag?: null | boolean; companyFlag?: null | boolean; configFlag?: null | boolean; contactFlag?: null | boolean; description?: string; id?: number; invoiceFlag?: null | boolean; portalPasswordFlag?: null | boolean; purchaseOrderFlag?: null | boolean; purchaseOrderStatusFlag?: null | boolean; rmaFlag?: null | boolean; salesFlag?: null | boolean; serviceFlag?: null | boolean; token?: string; tracksFlag?: null | boolean; workflowFlag?: null | boolean }>

getSystemEmailTokensCount

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

getSystemExperiments

  • getSystemExperiments(params?: CommonParameters): Promise<{ _info?: {}; description?: string; experimentId?: string; id?: number; inactiveFlag?: boolean; memberInactiveFlag?: boolean; name?: string; properties?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; description?: string; experimentId?: string; id?: number; inactiveFlag?: boolean; memberInactiveFlag?: boolean; name?: string; properties?: string }[]>

getSystemExperimentsById

  • getSystemExperimentsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; description?: string; experimentId?: string; id?: number; inactiveFlag?: boolean; memberInactiveFlag?: boolean; name?: string; properties?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; description?: string; experimentId?: string; id?: number; inactiveFlag?: boolean; memberInactiveFlag?: boolean; name?: string; properties?: string }>

getSystemExperimentsCount

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

getSystemFileuploadsettings

  • getSystemFileuploadsettings(params?: CommonParameters): Promise<{ _info?: {}; globalFileSizeLimit?: null | number; id?: number; restrictFileTypesFlag: null | boolean }[]>

getSystemFileuploadsettingsById

  • getSystemFileuploadsettingsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; globalFileSizeLimit?: null | number; id?: number; restrictFileTypesFlag: null | boolean }>

getSystemFileuploadsettingsCount

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

getSystemGoogleemailsetup

  • getSystemGoogleemailsetup(params?: CommonParameters): Promise<{ _info?: {}; clientId?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; privateKey?: string; processedFolder: string; username: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; clientId?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; privateKey?: string; processedFolder: string; username: string }[]>

getSystemGoogleemailsetupById

  • getSystemGoogleemailsetupById(id: number, params?: CommonParameters): Promise<{ _info?: {}; clientId?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; privateKey?: string; processedFolder: string; username: string }>

  • Parameters

    Returns Promise<{ _info?: {}; clientId?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; privateKey?: string; processedFolder: string; username: string }>

getSystemGoogleemailsetupCount

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

getSystemImaps

  • getSystemImaps(params?: CommonParameters): Promise<{ _info?: {}; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; imapName: string; name: string; password?: string; port: null | number; processedName: string; server: string; sslFlag?: null | boolean; userName: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; imapName: string; name: string; password?: string; port: null | number; processedName: string; server: string; sslFlag?: null | boolean; userName: string }[]>

getSystemImapsById

  • getSystemImapsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; imapName: string; name: string; password?: string; port: null | number; processedName: string; server: string; sslFlag?: null | boolean; userName: string }>

  • Parameters

    Returns Promise<{ _info?: {}; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; imapName: string; name: string; password?: string; port: null | number; processedName: string; server: string; sslFlag?: null | boolean; userName: string }>

getSystemImapsByIdInfo

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

getSystemImapsCount

getSystemImapsInfo

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

getSystemImapsInfoCount

getSystemInOutBoards

  • getSystemInOutBoards(params?: CommonParameters): Promise<{ _info?: {}; additionalInfo?: string; dateBack: string; id?: number; inOutType?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; additionalInfo?: string; dateBack: string; id?: number; inOutType?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

getSystemInOutBoardsById

  • getSystemInOutBoardsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; additionalInfo?: string; dateBack: string; id?: number; inOutType?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; additionalInfo?: string; dateBack: string; id?: number; inOutType?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

getSystemInOutBoardsCount

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

getSystemInOutTypes

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

getSystemInOutTypesById

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

getSystemInOutTypesByIdInfo

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

getSystemInOutTypesCount

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

getSystemInOutTypesCountInfo

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

getSystemInOutTypesInfo

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

getSystemInfo

  • getSystemInfo(params?: CommonParameters): Promise<{ cloudRegion?: string; isCloud?: boolean; licenseBits?: { activeFlag?: boolean; name?: string }[]; serverTimeZone?: string; version?: string }>

  • Parameters

    Returns Promise<{ cloudRegion?: string; isCloud?: boolean; licenseBits?: { activeFlag?: boolean; name?: string }[]; serverTimeZone?: string; version?: string }>

getSystemInfoDepartmentlocations

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

  • Parameters

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

getSystemInfoDepartmentlocationsById

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

  • Parameters

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

getSystemInfoDepartmentlocationsCount

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

getSystemInfoDepartments

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

getSystemInfoDepartmentsById

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

getSystemInfoDepartmentsCount

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

getSystemInfoLinks

  • getSystemInfoLinks(params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service" }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; name?: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service" }[]>

getSystemInfoLinksById

  • getSystemInfoLinksById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service" }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; name?: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service" }>

getSystemInfoLinksCount

getSystemInfoLocales

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

getSystemInfoLocalesById

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

getSystemInfoLocalesCount

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

getSystemInfoLocations

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

  • Parameters

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

getSystemInfoLocationsById

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

  • Parameters

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

getSystemInfoLocationsCount

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

getSystemInfoMembers

  • getSystemInfoMembers(params?: CommonParameters): Promise<{ _info?: {}; defaultEmail?: string; firstName?: string; fullName?: string; id?: number; identifier?: string; inactiveFlag?: null | boolean; lastName?: string; licenseClass?: null | "A" | "C" | "F" | "X"; middleInitial?: string; photo?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; defaultEmail?: string; firstName?: string; fullName?: string; id?: number; identifier?: string; inactiveFlag?: null | boolean; lastName?: string; licenseClass?: null | "A" | "C" | "F" | "X"; middleInitial?: string; photo?: { _info?: {}; id?: null | number; name?: string } }[]>

getSystemInfoMembersById

  • getSystemInfoMembersById(id: number, params?: CommonParameters): Promise<{ _info?: {}; defaultEmail?: string; firstName?: string; fullName?: string; id?: number; identifier?: string; inactiveFlag?: null | boolean; lastName?: string; licenseClass?: null | "A" | "C" | "F" | "X"; middleInitial?: string; photo?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; defaultEmail?: string; firstName?: string; fullName?: string; id?: number; identifier?: string; inactiveFlag?: null | boolean; lastName?: string; licenseClass?: null | "A" | "C" | "F" | "X"; middleInitial?: string; photo?: { _info?: {}; id?: null | number; name?: string } }>

getSystemInfoMembersCount

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

getSystemInfoMembersmemberIdentifierregextypes

  • getSystemInfoMembersmemberIdentifierregextypes(params?: CommonParameters): Promise<{ _info?: {}; defaultEmail?: string; firstName?: string; fullName?: string; id?: number; identifier?: string; inactiveFlag?: null | boolean; lastName?: string; licenseClass?: null | "A" | "C" | "F" | "X"; middleInitial?: string; photo?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; defaultEmail?: string; firstName?: string; fullName?: string; id?: number; identifier?: string; inactiveFlag?: null | boolean; lastName?: string; licenseClass?: null | "A" | "C" | "F" | "X"; middleInitial?: string; photo?: { _info?: {}; id?: null | number; name?: string } }>

getSystemInfoPersonas

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

getSystemInfoPersonasById

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

getSystemInfoPersonasCount

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

getSystemInfoStandardNotes

  • getSystemInfoStandardNotes(params?: CommonParameters): Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; contents?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; contents?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name?: string }[]>

getSystemInfoStandardNotesById

  • getSystemInfoStandardNotesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; contents?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; contents?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name?: string }>

getSystemInfoStandardNotesCount

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

getSystemIntegratorTags

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

getSystemIntegratorTagsById

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

getSystemIntegratorTagsCount

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

getSystemIntegratorlogins

  • getSystemIntegratorlogins(params?: CommonParameters): Promise<{ _info?: {}; activityApiFlag?: null | boolean; activityCallbackUrl?: string; activityLegacyCallbackFlag?: null | boolean; agreementApiFlag?: null | boolean; agreementCallbackLegacyFlag?: null | boolean; agreementCallbackUrl?: string; board?: { _info?: {}; id?: null | number; name?: string }; canAccessAllApisFlag?: null | boolean; canAccessAllRecordsFlag?: null | boolean; companyApiFlag?: null | boolean; companyCallbackUrl?: string; companyLegacyCallbackFlag?: null | boolean; configurationApiFlag?: null | boolean; configurationAutoChildFlag?: null | boolean; configurationCallbackUrl?: string; configurationChildlingFlag?: null | boolean; configurationLegacyCallbackFlag?: null | boolean; contactApiFlag?: null | boolean; contactCallbackUrl?: string; contactLegacyCallbackFlag?: null | boolean; dateInactivated?: string; documentApiFlag?: null | boolean; id?: number; inactivatedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; inactiveFlag?: null | boolean; invoiceApiFlag?: null | boolean; managedServicesApiFlag?: null | boolean; managedServicesAutoChildFlag?: null | boolean; managedServicesChildingFlag?: null | boolean; marketingApiFlag?: null | boolean; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memberApiFlag?: null | boolean; opportunityApiFlag?: null | boolean; opportunityCallbackUrl?: string; opportunityConversionApiFlag?: null | boolean; opportunityLegacyCallbackFlag?: null | boolean; password?: string; productApiFlag?: null | boolean; productCallbackUrl?: string; productLegacyCallbackFlag?: null | boolean; projectApiFlag?: null | boolean; projectCallbackUrl?: string; projectLegacyCallbackFlag?: null | boolean; purchasingApiFlag?: null | boolean; purchasingCallbackUrl?: string; purchasingLegacyCallbackFlag?: null | boolean; reportingApiFlag?: null | boolean; scheduleApiFlag?: null | boolean; scheduleCallbackUrl?: string; scheduleLegacyCallbackFlag?: null | boolean; serviceBoardCallbackUrl?: string; serviceBoardLegacyCallbackFlag?: null | boolean; serviceTicketApiFlag?: null | boolean; systemApiFlag?: null | boolean; timeEntryApiFlag?: null | boolean; timeEntryCallbackUrl?: string; timeEntryLegacyCallbackFlag?: null | boolean; username: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; activityApiFlag?: null | boolean; activityCallbackUrl?: string; activityLegacyCallbackFlag?: null | boolean; agreementApiFlag?: null | boolean; agreementCallbackLegacyFlag?: null | boolean; agreementCallbackUrl?: string; board?: { _info?: {}; id?: null | number; name?: string }; canAccessAllApisFlag?: null | boolean; canAccessAllRecordsFlag?: null | boolean; companyApiFlag?: null | boolean; companyCallbackUrl?: string; companyLegacyCallbackFlag?: null | boolean; configurationApiFlag?: null | boolean; configurationAutoChildFlag?: null | boolean; configurationCallbackUrl?: string; configurationChildlingFlag?: null | boolean; configurationLegacyCallbackFlag?: null | boolean; contactApiFlag?: null | boolean; contactCallbackUrl?: string; contactLegacyCallbackFlag?: null | boolean; dateInactivated?: string; documentApiFlag?: null | boolean; id?: number; inactivatedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; inactiveFlag?: null | boolean; invoiceApiFlag?: null | boolean; managedServicesApiFlag?: null | boolean; managedServicesAutoChildFlag?: null | boolean; managedServicesChildingFlag?: null | boolean; marketingApiFlag?: null | boolean; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memberApiFlag?: null | boolean; opportunityApiFlag?: null | boolean; opportunityCallbackUrl?: string; opportunityConversionApiFlag?: null | boolean; opportunityLegacyCallbackFlag?: null | boolean; password?: string; productApiFlag?: null | boolean; productCallbackUrl?: string; productLegacyCallbackFlag?: null | boolean; projectApiFlag?: null | boolean; projectCallbackUrl?: string; projectLegacyCallbackFlag?: null | boolean; purchasingApiFlag?: null | boolean; purchasingCallbackUrl?: string; purchasingLegacyCallbackFlag?: null | boolean; reportingApiFlag?: null | boolean; scheduleApiFlag?: null | boolean; scheduleCallbackUrl?: string; scheduleLegacyCallbackFlag?: null | boolean; serviceBoardCallbackUrl?: string; serviceBoardLegacyCallbackFlag?: null | boolean; serviceTicketApiFlag?: null | boolean; systemApiFlag?: null | boolean; timeEntryApiFlag?: null | boolean; timeEntryCallbackUrl?: string; timeEntryLegacyCallbackFlag?: null | boolean; username: string }[]>

getSystemIntegratorloginsById

  • getSystemIntegratorloginsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; activityApiFlag?: null | boolean; activityCallbackUrl?: string; activityLegacyCallbackFlag?: null | boolean; agreementApiFlag?: null | boolean; agreementCallbackLegacyFlag?: null | boolean; agreementCallbackUrl?: string; board?: { _info?: {}; id?: null | number; name?: string }; canAccessAllApisFlag?: null | boolean; canAccessAllRecordsFlag?: null | boolean; companyApiFlag?: null | boolean; companyCallbackUrl?: string; companyLegacyCallbackFlag?: null | boolean; configurationApiFlag?: null | boolean; configurationAutoChildFlag?: null | boolean; configurationCallbackUrl?: string; configurationChildlingFlag?: null | boolean; configurationLegacyCallbackFlag?: null | boolean; contactApiFlag?: null | boolean; contactCallbackUrl?: string; contactLegacyCallbackFlag?: null | boolean; dateInactivated?: string; documentApiFlag?: null | boolean; id?: number; inactivatedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; inactiveFlag?: null | boolean; invoiceApiFlag?: null | boolean; managedServicesApiFlag?: null | boolean; managedServicesAutoChildFlag?: null | boolean; managedServicesChildingFlag?: null | boolean; marketingApiFlag?: null | boolean; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memberApiFlag?: null | boolean; opportunityApiFlag?: null | boolean; opportunityCallbackUrl?: string; opportunityConversionApiFlag?: null | boolean; opportunityLegacyCallbackFlag?: null | boolean; password?: string; productApiFlag?: null | boolean; productCallbackUrl?: string; productLegacyCallbackFlag?: null | boolean; projectApiFlag?: null | boolean; projectCallbackUrl?: string; projectLegacyCallbackFlag?: null | boolean; purchasingApiFlag?: null | boolean; purchasingCallbackUrl?: string; purchasingLegacyCallbackFlag?: null | boolean; reportingApiFlag?: null | boolean; scheduleApiFlag?: null | boolean; scheduleCallbackUrl?: string; scheduleLegacyCallbackFlag?: null | boolean; serviceBoardCallbackUrl?: string; serviceBoardLegacyCallbackFlag?: null | boolean; serviceTicketApiFlag?: null | boolean; systemApiFlag?: null | boolean; timeEntryApiFlag?: null | boolean; timeEntryCallbackUrl?: string; timeEntryLegacyCallbackFlag?: null | boolean; username: string }>

  • Parameters

    Returns Promise<{ _info?: {}; activityApiFlag?: null | boolean; activityCallbackUrl?: string; activityLegacyCallbackFlag?: null | boolean; agreementApiFlag?: null | boolean; agreementCallbackLegacyFlag?: null | boolean; agreementCallbackUrl?: string; board?: { _info?: {}; id?: null | number; name?: string }; canAccessAllApisFlag?: null | boolean; canAccessAllRecordsFlag?: null | boolean; companyApiFlag?: null | boolean; companyCallbackUrl?: string; companyLegacyCallbackFlag?: null | boolean; configurationApiFlag?: null | boolean; configurationAutoChildFlag?: null | boolean; configurationCallbackUrl?: string; configurationChildlingFlag?: null | boolean; configurationLegacyCallbackFlag?: null | boolean; contactApiFlag?: null | boolean; contactCallbackUrl?: string; contactLegacyCallbackFlag?: null | boolean; dateInactivated?: string; documentApiFlag?: null | boolean; id?: number; inactivatedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; inactiveFlag?: null | boolean; invoiceApiFlag?: null | boolean; managedServicesApiFlag?: null | boolean; managedServicesAutoChildFlag?: null | boolean; managedServicesChildingFlag?: null | boolean; marketingApiFlag?: null | boolean; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memberApiFlag?: null | boolean; opportunityApiFlag?: null | boolean; opportunityCallbackUrl?: string; opportunityConversionApiFlag?: null | boolean; opportunityLegacyCallbackFlag?: null | boolean; password?: string; productApiFlag?: null | boolean; productCallbackUrl?: string; productLegacyCallbackFlag?: null | boolean; projectApiFlag?: null | boolean; projectCallbackUrl?: string; projectLegacyCallbackFlag?: null | boolean; purchasingApiFlag?: null | boolean; purchasingCallbackUrl?: string; purchasingLegacyCallbackFlag?: null | boolean; reportingApiFlag?: null | boolean; scheduleApiFlag?: null | boolean; scheduleCallbackUrl?: string; scheduleLegacyCallbackFlag?: null | boolean; serviceBoardCallbackUrl?: string; serviceBoardLegacyCallbackFlag?: null | boolean; serviceTicketApiFlag?: null | boolean; systemApiFlag?: null | boolean; timeEntryApiFlag?: null | boolean; timeEntryCallbackUrl?: string; timeEntryLegacyCallbackFlag?: null | boolean; username: string }>

getSystemIntegratorloginsCount

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

getSystemKpiCategories

  • getSystemKpiCategories(params?: CommonParameters): Promise<{ id?: number; name?: string; sortOrder?: null | number }[]>

getSystemKpiCategoriesById

  • getSystemKpiCategoriesById(id: number, params?: CommonParameters): Promise<{ id?: number; name?: string; sortOrder?: null | number }>

getSystemKpiCategoriesCount

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

getSystemKpis

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

  • Parameters

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

getSystemKpisById

  • getSystemKpisById(id: number, params?: CommonParameters): Promise<{ category?: { _info?: {}; id?: null | number; name?: string }; dateFilter?: string; id?: number; inactiveFlag?: null | boolean; name?: string; sortOrder?: null | number }>

  • Parameters

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

getSystemKpisCount

getSystemLdapConfigurations

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

getSystemLdapConfigurationsById

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

getSystemLdapConfigurationsByIdInfo

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

getSystemLdapConfigurationsCount

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

getSystemLdapConfigurationsInfo

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

getSystemLdapConfigurationsInfoCount

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

getSystemLinks

  • getSystemLinks(params?: CommonParameters): Promise<{ _info?: {}; id?: number; name: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service"; tableReferenceId?: null | number; url?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; name: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service"; tableReferenceId?: null | number; url?: string }[]>

getSystemLinksById

  • getSystemLinksById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service"; tableReferenceId?: null | number; url?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; name: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service"; tableReferenceId?: null | number; url?: string }>

getSystemLinksCount

getSystemLocations

  • getSystemLocations(params?: CommonParameters): Promise<{ _info?: {}; calendar?: { _info?: {}; id?: null | number; name?: string }; clientFlag?: null | boolean; departmentIds?: number[]; id?: number; locationFlag?: null | boolean; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; overrideAddressLine1?: string; overrideAddressLine2?: string; overrideCity?: string; overrideCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; overrideFaxNumber?: string; overridePhoneNumber?: string; overrideState?: string; overrideZip?: string; owaUrl?: string; ownerLevelId?: null | number; payrollXref?: string; reportsTo?: { _info?: {}; id?: null | number; name?: string }; salesRep?: string; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; workRoleIds?: number[] }[]>

  • Parameters

    Returns Promise<{ _info?: {}; calendar?: { _info?: {}; id?: null | number; name?: string }; clientFlag?: null | boolean; departmentIds?: number[]; id?: number; locationFlag?: null | boolean; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; overrideAddressLine1?: string; overrideAddressLine2?: string; overrideCity?: string; overrideCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; overrideFaxNumber?: string; overridePhoneNumber?: string; overrideState?: string; overrideZip?: string; owaUrl?: string; ownerLevelId?: null | number; payrollXref?: string; reportsTo?: { _info?: {}; id?: null | number; name?: string }; salesRep?: string; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; workRoleIds?: number[] }[]>

getSystemLocationsById

  • getSystemLocationsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; calendar?: { _info?: {}; id?: null | number; name?: string }; clientFlag?: null | boolean; departmentIds?: number[]; id?: number; locationFlag?: null | boolean; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; overrideAddressLine1?: string; overrideAddressLine2?: string; overrideCity?: string; overrideCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; overrideFaxNumber?: string; overridePhoneNumber?: string; overrideState?: string; overrideZip?: string; owaUrl?: string; ownerLevelId?: null | number; payrollXref?: string; reportsTo?: { _info?: {}; id?: null | number; name?: string }; salesRep?: string; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; workRoleIds?: number[] }>

  • Parameters

    Returns Promise<{ _info?: {}; calendar?: { _info?: {}; id?: null | number; name?: string }; clientFlag?: null | boolean; departmentIds?: number[]; id?: number; locationFlag?: null | boolean; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; overrideAddressLine1?: string; overrideAddressLine2?: string; overrideCity?: string; overrideCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; overrideFaxNumber?: string; overridePhoneNumber?: string; overrideState?: string; overrideZip?: string; owaUrl?: string; ownerLevelId?: null | number; payrollXref?: string; reportsTo?: { _info?: {}; id?: null | number; name?: string }; salesRep?: string; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; workRoleIds?: number[] }>

getSystemLocationsByIdUsages

  • getSystemLocationsByIdUsages(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 }[]>

getSystemLocationsByIdUsagesList

  • getSystemLocationsByIdUsagesList(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 }[]>

getSystemLocationsByParentIdDepartments

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

  • Parameters

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

getSystemLocationsByParentIdDepartmentsById

  • getSystemLocationsByParentIdDepartmentsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

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

getSystemLocationsByParentIdDepartmentsCount

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

getSystemLocationsByParentIdWorkRoles

  • getSystemLocationsByParentIdWorkRoles(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workRoleInactiveFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workRoleInactiveFlag?: null | boolean }[]>

getSystemLocationsByParentIdWorkRolesById

  • getSystemLocationsByParentIdWorkRolesById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workRoleInactiveFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workRoleInactiveFlag?: null | boolean }>

getSystemLocationsByParentIdWorkRolesCount

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

getSystemLocationsCount

getSystemManagementNetworkSecurities

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

getSystemManagementNetworkSecuritiesById

  • getSystemManagementNetworkSecuritiesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name: string; password?: string; site: string; username?: string }>

getSystemManagementNetworkSecuritiesByIdTestCredentials

  • getSystemManagementNetworkSecuritiesByIdTestCredentials(id: number, params?: CommonParameters): Promise<{ message?: string; success?: boolean }>

getSystemManagementNetworkSecuritiesCount

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

getSystemMarketplaceimportGetdefinitionById

  • getSystemMarketplaceimportGetdefinitionById(id: number, params?: CommonParameters): Promise<{ id?: number; marketplaceImportType?: "Products" | "Agreements" | "Configurations" | "CRMSurveys" | "CustomReports" | "CustomerPortalTypes" | "HTMLEmailTemplates" | "ProjectBoards" | "ProjectTemplates" | "ReportWriterReports" | "ServiceBoards" | "TicketTemplates" | "Views"; marketplaceObject?: unknown[]; requiredFields?: string[] }>

  • Parameters

    Returns Promise<{ id?: number; marketplaceImportType?: "Products" | "Agreements" | "Configurations" | "CRMSurveys" | "CustomReports" | "CustomerPortalTypes" | "HTMLEmailTemplates" | "ProjectBoards" | "ProjectTemplates" | "ReportWriterReports" | "ServiceBoards" | "TicketTemplates" | "Views"; marketplaceObject?: unknown[]; requiredFields?: string[] }>

getSystemMembers

  • getSystemMembers(params?: CommonParameters): Promise<{ _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }[]>

getSystemMembersById

  • getSystemMembersById(id: number, params?: CommonParameters): Promise<{ _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

getSystemMembersByIdImage

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

getSystemMembersByIdUsages

  • getSystemMembersByIdUsages(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 }[]>

getSystemMembersByIdUsagesList

  • getSystemMembersByIdUsagesList(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 }[]>

getSystemMembersByParentIdAccruals

  • getSystemMembersByParentIdAccruals(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; accrualType: null | "Holiday" | "PTO" | "Sick" | "Vacation"; hours: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; reason: string; year: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; accrualType: null | "Holiday" | "PTO" | "Sick" | "Vacation"; hours: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; reason: string; year: null | number }[]>

getSystemMembersByParentIdAccrualsById

  • getSystemMembersByParentIdAccrualsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; accrualType: null | "Holiday" | "PTO" | "Sick" | "Vacation"; hours: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; reason: string; year: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; accrualType: null | "Holiday" | "PTO" | "Sick" | "Vacation"; hours: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; reason: string; year: null | number }>

getSystemMembersByParentIdAccrualsCount

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

getSystemMembersByParentIdCertifications

  • getSystemMembersByParentIdCertifications(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }[]>

getSystemMembersByParentIdCertificationsById

  • getSystemMembersByParentIdCertificationsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }>

getSystemMembersByParentIdCertificationsCount

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

getSystemMembersByParentIdDelegations

  • getSystemMembersByParentIdDelegations(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

getSystemMembersByParentIdDelegationsById

  • getSystemMembersByParentIdDelegationsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

getSystemMembersByParentIdDelegationsCount

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

getSystemMembersByParentIdManagedDeviceAccounts

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

  • Parameters

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

getSystemMembersByParentIdMycertifications

  • getSystemMembersByParentIdMycertifications(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }[]>

getSystemMembersByParentIdMycertificationsById

  • getSystemMembersByParentIdMycertificationsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }>

getSystemMembersByParentIdMycertificationsCount

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

getSystemMembersByParentIdNotificationSettings

  • getSystemMembersByParentIdNotificationSettings(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; notificationTrigger: null | "ExpenseReport" | "ActivityStatusReq" | "CustomerUpdated" | "TicketStatusChange" | "TicketStatusRequest" | "TimeNagApprover" | "TimeNagMember" | "TimeSheet" | "WorkflowRules"; notificationType: null | "Email" | "Push" }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; notificationTrigger: null | "ExpenseReport" | "ActivityStatusReq" | "CustomerUpdated" | "TicketStatusChange" | "TicketStatusRequest" | "TimeNagApprover" | "TimeNagMember" | "TimeSheet" | "WorkflowRules"; notificationType: null | "Email" | "Push" }[]>

getSystemMembersByParentIdNotificationSettingsById

  • getSystemMembersByParentIdNotificationSettingsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; notificationTrigger: null | "ExpenseReport" | "ActivityStatusReq" | "CustomerUpdated" | "TicketStatusChange" | "TicketStatusRequest" | "TimeNagApprover" | "TimeNagMember" | "TimeSheet" | "WorkflowRules"; notificationType: null | "Email" | "Push" }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; notificationTrigger: null | "ExpenseReport" | "ActivityStatusReq" | "CustomerUpdated" | "TicketStatusChange" | "TicketStatusRequest" | "TimeNagApprover" | "TimeNagMember" | "TimeSheet" | "WorkflowRules"; notificationType: null | "Email" | "Push" }>

getSystemMembersByParentIdNotificationSettingsCount

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

getSystemMembersByParentIdPersonas

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

  • Parameters

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

getSystemMembersByParentIdPersonasById

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

  • Parameters

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

getSystemMembersByParentIdPersonasCount

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

getSystemMembersByParentIdSkills

  • getSystemMembersByParentIdSkills(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }[]>

getSystemMembersByParentIdSkillsById

  • getSystemMembersByParentIdSkillsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }>

getSystemMembersByParentIdSkillsCount

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

getSystemMembersCount

getSystemMembersTypes

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

getSystemMembersTypesById

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

getSystemMembersTypesByIdInfo

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

getSystemMembersTypesCount

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

getSystemMembersTypesInfo

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

getSystemMembersTypesInfoCount

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

getSystemMembersWithSso

  • getSystemMembersWithSso(params?: CommonParameters): Promise<{ _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }[]>

getSystemMembersmemberIdentifierregextypes

  • getSystemMembersmemberIdentifierregextypes(memberIdentifier: string, params?: CommonParameters): Promise<{ _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

getSystemMenuEntriesByParentIdLocations

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

  • Parameters

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

getSystemMenuEntriesByParentIdLocationsById

  • getSystemMenuEntriesByParentIdLocationsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; menuEntry?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

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

getSystemMenuEntriesByParentIdLocationsCount

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

getSystemMenuentries

  • getSystemMenuentries(params?: CommonParameters): Promise<{ _info?: {}; addAllLocations?: null | boolean; caption: string; clientId?: string; id?: number; largeMenuIconId?: null | number; link: string; locationIds?: number[]; menuLocation?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag: null | boolean; origin?: string; removeAllLocations?: null | boolean; smallMenuIconId?: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; addAllLocations?: null | boolean; caption: string; clientId?: string; id?: number; largeMenuIconId?: null | number; link: string; locationIds?: number[]; menuLocation?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag: null | boolean; origin?: string; removeAllLocations?: null | boolean; smallMenuIconId?: null | number }[]>

getSystemMenuentriesById

  • getSystemMenuentriesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; addAllLocations?: null | boolean; caption: string; clientId?: string; id?: number; largeMenuIconId?: null | number; link: string; locationIds?: number[]; menuLocation?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag: null | boolean; origin?: string; removeAllLocations?: null | boolean; smallMenuIconId?: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; addAllLocations?: null | boolean; caption: string; clientId?: string; id?: number; largeMenuIconId?: null | number; link: string; locationIds?: number[]; menuLocation?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag: null | boolean; origin?: string; removeAllLocations?: null | boolean; smallMenuIconId?: null | number }>

getSystemMenuentriesByIdImage

  • getSystemMenuentriesByIdImage(id: number, lastmodified: string, largeFlag: boolean, params?: CommonParameters): Promise<Buffer>

getSystemMenuentriesCount

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

getSystemMyAccountById

  • getSystemMyAccountById(id: number, params?: CommonParameters): Promise<{ _info?: {}; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

getSystemMyAccountByParentIdDelegations

  • getSystemMyAccountByParentIdDelegations(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

getSystemMyAccountByParentIdDelegationsById

  • getSystemMyAccountByParentIdDelegationsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

getSystemMyAccountByParentIdDelegationsCount

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

getSystemMyAccountByParentIdSkills

  • getSystemMyAccountByParentIdSkills(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }[]>

getSystemMyAccountByParentIdSkillsById

  • getSystemMyAccountByParentIdSkillsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }>

getSystemMyAccountByParentIdSkillsCount

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

getSystemMyCompanyCorporateStructure

  • getSystemMyCompanyCorporateStructure(params?: CommonParameters): Promise<{ _info?: {}; baseCurrency: { _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 }; chiefOperatingOfficer?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; controller?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatcher?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; fiscalYearStart: null | "January" | "February" | "March" | "April" | "May" | "June" | "July" | "August" | "September" | "October" | "November" | "December"; groupCaption: string; id?: number; level1Name?: string; level2Name?: string; level3Name?: string; level4Name?: string; level5Name?: string; levelCount?: null | "Level1" | "Level2" | "Level3" | "Level4" | "Level5"; locationCaption: string; president?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; baseCurrency: { _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 }; chiefOperatingOfficer?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; controller?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatcher?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; fiscalYearStart: null | "January" | "February" | "March" | "April" | "May" | "June" | "July" | "August" | "September" | "October" | "November" | "December"; groupCaption: string; id?: number; level1Name?: string; level2Name?: string; level3Name?: string; level4Name?: string; level5Name?: string; levelCount?: null | "Level1" | "Level2" | "Level3" | "Level4" | "Level5"; locationCaption: string; president?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

getSystemMyCompanyCorporateStructureById

  • getSystemMyCompanyCorporateStructureById(id: number, params?: CommonParameters): Promise<{ _info?: {}; baseCurrency: { _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 }; chiefOperatingOfficer?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; controller?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatcher?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; fiscalYearStart: null | "January" | "February" | "March" | "April" | "May" | "June" | "July" | "August" | "September" | "October" | "November" | "December"; groupCaption: string; id?: number; level1Name?: string; level2Name?: string; level3Name?: string; level4Name?: string; level5Name?: string; levelCount?: null | "Level1" | "Level2" | "Level3" | "Level4" | "Level5"; locationCaption: string; president?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; baseCurrency: { _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 }; chiefOperatingOfficer?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; controller?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatcher?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; fiscalYearStart: null | "January" | "February" | "March" | "April" | "May" | "June" | "July" | "August" | "September" | "October" | "November" | "December"; groupCaption: string; id?: number; level1Name?: string; level2Name?: string; level3Name?: string; level4Name?: string; level5Name?: string; levelCount?: null | "Level1" | "Level2" | "Level3" | "Level4" | "Level5"; locationCaption: string; president?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

getSystemMyCompanyCorporateStructureByIdInfo

  • getSystemMyCompanyCorporateStructureByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; baseCurrency?: { _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 }; groupCaption?: string; id?: number; locationCaption?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; baseCurrency?: { _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 }; groupCaption?: string; id?: number; locationCaption?: string }>

getSystemMyCompanyCorporateStructureCount

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

getSystemMyCompanyCorporateStructureInfo

  • getSystemMyCompanyCorporateStructureInfo(params?: CommonParameters): Promise<{ _info?: {}; baseCurrency?: { _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 }; groupCaption?: string; id?: number; locationCaption?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; baseCurrency?: { _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 }; groupCaption?: string; id?: number; locationCaption?: string }[]>

getSystemMyCompanyCorporateStructureInfoCount

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

getSystemMyCompanyCorporateStructureLevels

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

getSystemMyCompanyCorporateStructureLevelsById

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

getSystemMyCompanyCorporateStructureLevelsCount

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

getSystemMyCompanyCrm

  • getSystemMyCompanyCrm(params?: CommonParameters): Promise<{ _info?: {}; accountManagerRole?: { _info?: {}; id?: null | number; name?: string }; companyIdGenerationFlag?: null | boolean; companyListCount?: null | number; defaultYear?: null | boolean; excludeSpacesFlag?: null | boolean; field10Caption?: string; field1Caption?: string; field2Caption?: string; field3Caption?: string; field4Caption?: string; field5Caption?: string; field6Caption?: string; field7Caption?: string; field8Caption?: string; field9Caption?: string; id?: number; lockProbabilityFlag?: null | boolean; other1Caption?: string; other2Caption?: string; primaryRepCaption?: string; salesRepRole?: { _info?: {}; id?: null | number; name?: string }; secondaryRepCaption?: string; technicalContactRole?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; accountManagerRole?: { _info?: {}; id?: null | number; name?: string }; companyIdGenerationFlag?: null | boolean; companyListCount?: null | number; defaultYear?: null | boolean; excludeSpacesFlag?: null | boolean; field10Caption?: string; field1Caption?: string; field2Caption?: string; field3Caption?: string; field4Caption?: string; field5Caption?: string; field6Caption?: string; field7Caption?: string; field8Caption?: string; field9Caption?: string; id?: number; lockProbabilityFlag?: null | boolean; other1Caption?: string; other2Caption?: string; primaryRepCaption?: string; salesRepRole?: { _info?: {}; id?: null | number; name?: string }; secondaryRepCaption?: string; technicalContactRole?: { _info?: {}; id?: null | number; name?: string } }[]>

getSystemMyCompanyCrmById

  • getSystemMyCompanyCrmById(id: number, params?: CommonParameters): Promise<{ _info?: {}; accountManagerRole?: { _info?: {}; id?: null | number; name?: string }; companyIdGenerationFlag?: null | boolean; companyListCount?: null | number; defaultYear?: null | boolean; excludeSpacesFlag?: null | boolean; field10Caption?: string; field1Caption?: string; field2Caption?: string; field3Caption?: string; field4Caption?: string; field5Caption?: string; field6Caption?: string; field7Caption?: string; field8Caption?: string; field9Caption?: string; id?: number; lockProbabilityFlag?: null | boolean; other1Caption?: string; other2Caption?: string; primaryRepCaption?: string; salesRepRole?: { _info?: {}; id?: null | number; name?: string }; secondaryRepCaption?: string; technicalContactRole?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; accountManagerRole?: { _info?: {}; id?: null | number; name?: string }; companyIdGenerationFlag?: null | boolean; companyListCount?: null | number; defaultYear?: null | boolean; excludeSpacesFlag?: null | boolean; field10Caption?: string; field1Caption?: string; field2Caption?: string; field3Caption?: string; field4Caption?: string; field5Caption?: string; field6Caption?: string; field7Caption?: string; field8Caption?: string; field9Caption?: string; id?: number; lockProbabilityFlag?: null | boolean; other1Caption?: string; other2Caption?: string; primaryRepCaption?: string; salesRepRole?: { _info?: {}; id?: null | number; name?: string }; secondaryRepCaption?: string; technicalContactRole?: { _info?: {}; id?: null | number; name?: string } }>

getSystemMyCompanyCrmByIdInfo

  • getSystemMyCompanyCrmByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; accountManagerRole?: { _info?: {}; id?: null | number; name?: string }; field10Caption?: string; field1Caption?: string; field2Caption?: string; field3Caption?: string; field4Caption?: string; field5Caption?: string; field6Caption?: string; field7Caption?: string; field8Caption?: string; field9Caption?: string; id?: number; primaryRepCaption?: string; salesRepRole?: { _info?: {}; id?: null | number; name?: string }; secondaryRepCaption?: string; technicalContactRole?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; accountManagerRole?: { _info?: {}; id?: null | number; name?: string }; field10Caption?: string; field1Caption?: string; field2Caption?: string; field3Caption?: string; field4Caption?: string; field5Caption?: string; field6Caption?: string; field7Caption?: string; field8Caption?: string; field9Caption?: string; id?: number; primaryRepCaption?: string; salesRepRole?: { _info?: {}; id?: null | number; name?: string }; secondaryRepCaption?: string; technicalContactRole?: { _info?: {}; id?: null | number; name?: string } }>

getSystemMyCompanyCrmCount

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

getSystemMyCompanyCrmInfo

  • getSystemMyCompanyCrmInfo(params?: CommonParameters): Promise<{ _info?: {}; accountManagerRole?: { _info?: {}; id?: null | number; name?: string }; field10Caption?: string; field1Caption?: string; field2Caption?: string; field3Caption?: string; field4Caption?: string; field5Caption?: string; field6Caption?: string; field7Caption?: string; field8Caption?: string; field9Caption?: string; id?: number; primaryRepCaption?: string; salesRepRole?: { _info?: {}; id?: null | number; name?: string }; secondaryRepCaption?: string; technicalContactRole?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; accountManagerRole?: { _info?: {}; id?: null | number; name?: string }; field10Caption?: string; field1Caption?: string; field2Caption?: string; field3Caption?: string; field4Caption?: string; field5Caption?: string; field6Caption?: string; field7Caption?: string; field8Caption?: string; field9Caption?: string; id?: number; primaryRepCaption?: string; salesRepRole?: { _info?: {}; id?: null | number; name?: string }; secondaryRepCaption?: string; technicalContactRole?: { _info?: {}; id?: null | number; name?: string } }[]>

getSystemMyCompanyCrmInfoCount

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

getSystemMyCompanyOther

  • getSystemMyCompanyOther(params?: CommonParameters): Promise<{ _info?: {}; contactSync?: null | "FL" | "LF" | "CFL" | "CLF"; defaultAddressFormat?: { _info?: {}; id?: null | number; name?: string }; defaultCalendar?: { _info?: {}; id?: null | number; name?: string }; defaultFromAddress: string; defaultLdap?: { _info?: {}; id?: null | number; name?: string; server?: string }; disableZAdminLoginFlag?: null | boolean; id?: number; includePortalLinkFlag?: null | boolean; locale?: { _info?: {}; id?: null | number; name?: string }; logoPath?: string; portalUrlOverride: string; serverTimeZone?: { _info?: {}; id?: null | number; name?: string }; siteUrl: string; syncLeadsFlag?: null | boolean; updateMemberTimeZonesFlag?: null | boolean; useExpandedFormatActivityFlag?: null | boolean; useExpandedFormatTimeFlag?: null | boolean; useSslFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; contactSync?: null | "FL" | "LF" | "CFL" | "CLF"; defaultAddressFormat?: { _info?: {}; id?: null | number; name?: string }; defaultCalendar?: { _info?: {}; id?: null | number; name?: string }; defaultFromAddress: string; defaultLdap?: { _info?: {}; id?: null | number; name?: string; server?: string }; disableZAdminLoginFlag?: null | boolean; id?: number; includePortalLinkFlag?: null | boolean; locale?: { _info?: {}; id?: null | number; name?: string }; logoPath?: string; portalUrlOverride: string; serverTimeZone?: { _info?: {}; id?: null | number; name?: string }; siteUrl: string; syncLeadsFlag?: null | boolean; updateMemberTimeZonesFlag?: null | boolean; useExpandedFormatActivityFlag?: null | boolean; useExpandedFormatTimeFlag?: null | boolean; useSslFlag?: null | boolean }[]>

getSystemMyCompanyOtherById

  • getSystemMyCompanyOtherById(id: number, params?: CommonParameters): Promise<{ _info?: {}; contactSync?: null | "FL" | "LF" | "CFL" | "CLF"; defaultAddressFormat?: { _info?: {}; id?: null | number; name?: string }; defaultCalendar?: { _info?: {}; id?: null | number; name?: string }; defaultFromAddress: string; defaultLdap?: { _info?: {}; id?: null | number; name?: string; server?: string }; disableZAdminLoginFlag?: null | boolean; id?: number; includePortalLinkFlag?: null | boolean; locale?: { _info?: {}; id?: null | number; name?: string }; logoPath?: string; portalUrlOverride: string; serverTimeZone?: { _info?: {}; id?: null | number; name?: string }; siteUrl: string; syncLeadsFlag?: null | boolean; updateMemberTimeZonesFlag?: null | boolean; useExpandedFormatActivityFlag?: null | boolean; useExpandedFormatTimeFlag?: null | boolean; useSslFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; contactSync?: null | "FL" | "LF" | "CFL" | "CLF"; defaultAddressFormat?: { _info?: {}; id?: null | number; name?: string }; defaultCalendar?: { _info?: {}; id?: null | number; name?: string }; defaultFromAddress: string; defaultLdap?: { _info?: {}; id?: null | number; name?: string; server?: string }; disableZAdminLoginFlag?: null | boolean; id?: number; includePortalLinkFlag?: null | boolean; locale?: { _info?: {}; id?: null | number; name?: string }; logoPath?: string; portalUrlOverride: string; serverTimeZone?: { _info?: {}; id?: null | number; name?: string }; siteUrl: string; syncLeadsFlag?: null | boolean; updateMemberTimeZonesFlag?: null | boolean; useExpandedFormatActivityFlag?: null | boolean; useExpandedFormatTimeFlag?: null | boolean; useSslFlag?: null | boolean }>

getSystemMyCompanyOtherCount

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

getSystemMyCompanyTimeExpense

  • getSystemMyCompanyTimeExpense(params?: CommonParameters): Promise<{ _info?: {}; defaultSpecialInvoiceType?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; disableTimeEntryFlag?: null | boolean; id?: number; internalCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; invoiceStart?: null | number; requireExpenseNoteFlag?: null | boolean; requireTimeNoteFlag?: null | boolean; roundingFactor?: null | number; tier1ApprovalFlag?: null | boolean; tier2ApprovalFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; defaultSpecialInvoiceType?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; disableTimeEntryFlag?: null | boolean; id?: number; internalCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; invoiceStart?: null | number; requireExpenseNoteFlag?: null | boolean; requireTimeNoteFlag?: null | boolean; roundingFactor?: null | number; tier1ApprovalFlag?: null | boolean; tier2ApprovalFlag?: null | boolean }[]>

getSystemMyCompanyTimeExpenseById

  • getSystemMyCompanyTimeExpenseById(id: number, params?: CommonParameters): Promise<{ _info?: {}; defaultSpecialInvoiceType?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; disableTimeEntryFlag?: null | boolean; id?: number; internalCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; invoiceStart?: null | number; requireExpenseNoteFlag?: null | boolean; requireTimeNoteFlag?: null | boolean; roundingFactor?: null | number; tier1ApprovalFlag?: null | boolean; tier2ApprovalFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; defaultSpecialInvoiceType?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; disableTimeEntryFlag?: null | boolean; id?: number; internalCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; invoiceStart?: null | number; requireExpenseNoteFlag?: null | boolean; requireTimeNoteFlag?: null | boolean; roundingFactor?: null | number; tier1ApprovalFlag?: null | boolean; tier2ApprovalFlag?: null | boolean }>

getSystemMyCompanyTimeExpenseCount

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

getSystemMyMembers

  • getSystemMyMembers(params?: CommonParameters): Promise<{ _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions?: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; companyActivityTabFormat?: null | "SummaryList" | "DetailList"; corelyticsPassword?: string; corelyticsUsername?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail?: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone?: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName?: string; hideMemberInDispatchPortalFlag?: null | boolean; hireDate?: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier?: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat?: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat?: null | "SummaryList" | "DetailList"; invoicingDisplayOptions?: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName?: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass?: null | "A" | "C" | "F" | "X"; mapiName?: string; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; officeEmail?: string; officeExtension?: string; officePhone?: string; password?: string; photo?: { _info?: {}; id?: null | number; name?: string }; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; ssoClientId?: string; ssoSessionFlag?: null | boolean; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions?: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; companyActivityTabFormat?: null | "SummaryList" | "DetailList"; corelyticsPassword?: string; corelyticsUsername?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail?: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone?: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName?: string; hideMemberInDispatchPortalFlag?: null | boolean; hireDate?: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier?: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat?: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat?: null | "SummaryList" | "DetailList"; invoicingDisplayOptions?: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName?: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass?: null | "A" | "C" | "F" | "X"; mapiName?: string; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; officeEmail?: string; officeExtension?: string; officePhone?: string; password?: string; photo?: { _info?: {}; id?: null | number; name?: string }; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; ssoClientId?: string; ssoSessionFlag?: null | boolean; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

getSystemMyMembersInfo

  • getSystemMyMembersInfo(params?: CommonParameters): Promise<{ _info?: {}; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; dailyCapacity?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail?: string; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; firstName?: string; fullName?: string; id?: number; identifier?: string; inactiveFlag?: null | boolean; lastName?: string; licenseClass?: null | "A" | "C" | "F" | "X"; middleInitial?: string; photo?: { _info?: {}; id?: null | number; name?: string }; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; ssoClientId?: string; ssoSessionFlag?: null | boolean; timeZone?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; dailyCapacity?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail?: string; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; firstName?: string; fullName?: string; id?: number; identifier?: string; inactiveFlag?: null | boolean; lastName?: string; licenseClass?: null | "A" | "C" | "F" | "X"; middleInitial?: string; photo?: { _info?: {}; id?: null | number; name?: string }; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; ssoClientId?: string; ssoSessionFlag?: null | boolean; timeZone?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

getSystemMySecurity

  • getSystemMySecurity(params?: CommonParameters): Promise<{ _info?: {}; addLevel?: null | "All" | "None" | "My"; customFlag?: null | boolean; deleteLevel?: null | "All" | "None" | "My"; editLevel?: null | "All" | "None" | "My"; id?: number; inquireLevel?: null | "All" | "None" | "My"; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; moduleDescription?: string; moduleFunctionDescription?: string; moduleFunctionIdentifier?: string; moduleFunctionName?: string; moduleIdentifier?: string; moduleName?: string; myAllFlag?: null | boolean; reportFlag?: null | boolean; restrictFlag?: null | boolean; sortOrder?: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; addLevel?: null | "All" | "None" | "My"; customFlag?: null | boolean; deleteLevel?: null | "All" | "None" | "My"; editLevel?: null | "All" | "None" | "My"; id?: number; inquireLevel?: null | "All" | "None" | "My"; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; moduleDescription?: string; moduleFunctionDescription?: string; moduleFunctionIdentifier?: string; moduleFunctionName?: string; moduleIdentifier?: string; moduleName?: string; myAllFlag?: null | boolean; reportFlag?: null | boolean; restrictFlag?: null | boolean; sortOrder?: null | number }[]>

getSystemMySecurityCustomizeItems

  • getSystemMySecurityCustomizeItems(params?: CommonParameters): Promise<{ customizeIdentifier?: null | "CompanyReports" | "FinanceReports" | "MarketingReports" | "ProcurementReports" | "ProjectReports" | "SalesReports" | "ServiceReports" | "SystemReports" | "TimeAndExpenseReports" | "CompanyConfigurations" | "FinanceAgreements" | "ProjectScheduling" | "ServiceResourceScheduling" | "SystemManageHostedApi" | "SystemMyAccount" | "SystemCustomMenuEntry" | "SystemMassMaintenance" | "SystemTableSetup"; id?: number; itemIdentifier?: string }[]>

  • Parameters

    Returns Promise<{ customizeIdentifier?: null | "CompanyReports" | "FinanceReports" | "MarketingReports" | "ProcurementReports" | "ProjectReports" | "SalesReports" | "ServiceReports" | "SystemReports" | "TimeAndExpenseReports" | "CompanyConfigurations" | "FinanceAgreements" | "ProjectScheduling" | "ServiceResourceScheduling" | "SystemManageHostedApi" | "SystemMyAccount" | "SystemCustomMenuEntry" | "SystemMassMaintenance" | "SystemTableSetup"; id?: number; itemIdentifier?: string }[]>

getSystemMycompanyDocuments

  • getSystemMycompanyDocuments(params?: CommonParameters): Promise<{ _info?: {}; docPath?: string; id?: number; isPublicFlag?: null | boolean; templateOutputPath?: string; templatePath?: string; uploadAsLinkFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; docPath?: string; id?: number; isPublicFlag?: null | boolean; templateOutputPath?: string; templatePath?: string; uploadAsLinkFlag?: null | boolean }[]>

getSystemMycompanyDocumentsById

  • getSystemMycompanyDocumentsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; docPath?: string; id?: number; isPublicFlag?: null | boolean; templateOutputPath?: string; templatePath?: string; uploadAsLinkFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; docPath?: string; id?: number; isPublicFlag?: null | boolean; templateOutputPath?: string; templatePath?: string; uploadAsLinkFlag?: null | boolean }>

getSystemMycompanyInfoServices

  • getSystemMycompanyInfoServices(params?: CommonParameters): Promise<{ _info?: {}; contactColor?: string; headerColor?: string; id?: number; memberColor?: string; unknownColor?: string }[]>

getSystemMycompanyInfoServicesById

  • getSystemMycompanyInfoServicesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; contactColor?: string; headerColor?: string; id?: number; memberColor?: string; unknownColor?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; contactColor?: string; headerColor?: string; id?: number; memberColor?: string; unknownColor?: string }>

getSystemMycompanyReportingServices

  • getSystemMycompanyReportingServices(params?: CommonParameters): Promise<{ _info?: {}; id?: number; reportingDomain?: string; reportingPassword?: string; reportingUrl?: string; reportingUserName?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; reportingDomain?: string; reportingPassword?: string; reportingUrl?: string; reportingUserName?: string }[]>

getSystemMycompanyReportingServicesById

  • getSystemMycompanyReportingServicesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; reportingDomain?: string; reportingPassword?: string; reportingUrl?: string; reportingUserName?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; reportingDomain?: string; reportingPassword?: string; reportingUrl?: string; reportingUserName?: string }>

getSystemMycompanyServices

  • getSystemMycompanyServices(params?: CommonParameters): Promise<{ _info?: {}; allowCCFlag?: null | boolean; allowTOFlag?: null | boolean; calendarSetup?: { _info?: {}; id?: null | number }; contactColor?: string; contactColorDisableFlag?: null | boolean; headerColor?: string; headerColorDisableFlag?: null | boolean; hideDelimiterFlag?: null | boolean; id?: number; memberColor?: string; memberColorDisableFlag?: null | boolean; scheduleSpan: "Standard" | "OfficeHours" | "Overnight"; srNotify: null | "All" | "None" | "NewAndClosedRequests" | "ClosedRequestsOnly" | "NewRequestsOnly"; unknownColor?: string; unknownColorDisableFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; allowCCFlag?: null | boolean; allowTOFlag?: null | boolean; calendarSetup?: { _info?: {}; id?: null | number }; contactColor?: string; contactColorDisableFlag?: null | boolean; headerColor?: string; headerColorDisableFlag?: null | boolean; hideDelimiterFlag?: null | boolean; id?: number; memberColor?: string; memberColorDisableFlag?: null | boolean; scheduleSpan: "Standard" | "OfficeHours" | "Overnight"; srNotify: null | "All" | "None" | "NewAndClosedRequests" | "ClosedRequestsOnly" | "NewRequestsOnly"; unknownColor?: string; unknownColorDisableFlag?: null | boolean }[]>

getSystemMycompanyServicesById

  • getSystemMycompanyServicesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; allowCCFlag?: null | boolean; allowTOFlag?: null | boolean; calendarSetup?: { _info?: {}; id?: null | number }; contactColor?: string; contactColorDisableFlag?: null | boolean; headerColor?: string; headerColorDisableFlag?: null | boolean; hideDelimiterFlag?: null | boolean; id?: number; memberColor?: string; memberColorDisableFlag?: null | boolean; scheduleSpan: "Standard" | "OfficeHours" | "Overnight"; srNotify: null | "All" | "None" | "NewAndClosedRequests" | "ClosedRequestsOnly" | "NewRequestsOnly"; unknownColor?: string; unknownColorDisableFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; allowCCFlag?: null | boolean; allowTOFlag?: null | boolean; calendarSetup?: { _info?: {}; id?: null | number }; contactColor?: string; contactColorDisableFlag?: null | boolean; headerColor?: string; headerColorDisableFlag?: null | boolean; hideDelimiterFlag?: null | boolean; id?: number; memberColor?: string; memberColorDisableFlag?: null | boolean; scheduleSpan: "Standard" | "OfficeHours" | "Overnight"; srNotify: null | "All" | "None" | "NewAndClosedRequests" | "ClosedRequestsOnly" | "NewRequestsOnly"; unknownColor?: string; unknownColorDisableFlag?: null | boolean }>

getSystemNotificationRecipients

  • getSystemNotificationRecipients(params?: CommonParameters): Promise<{ _info?: {}; agreementFlag?: null | boolean; configFlag?: null | boolean; externalFlag?: null | boolean; id?: number; identifier?: string; invoiceFlag?: null | boolean; knowledgeBaseFlag?: null | boolean; memberFlag?: null | boolean; mspFlag?: null | boolean; name?: string; procurementFlag?: null | boolean; projectFlag?: null | boolean; salesFlag?: null | boolean; serviceFlag?: null | boolean; trackFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; agreementFlag?: null | boolean; configFlag?: null | boolean; externalFlag?: null | boolean; id?: number; identifier?: string; invoiceFlag?: null | boolean; knowledgeBaseFlag?: null | boolean; memberFlag?: null | boolean; mspFlag?: null | boolean; name?: string; procurementFlag?: null | boolean; projectFlag?: null | boolean; salesFlag?: null | boolean; serviceFlag?: null | boolean; trackFlag?: null | boolean }[]>

getSystemNotificationRecipientsById

  • getSystemNotificationRecipientsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; agreementFlag?: null | boolean; configFlag?: null | boolean; externalFlag?: null | boolean; id?: number; identifier?: string; invoiceFlag?: null | boolean; knowledgeBaseFlag?: null | boolean; memberFlag?: null | boolean; mspFlag?: null | boolean; name?: string; procurementFlag?: null | boolean; projectFlag?: null | boolean; salesFlag?: null | boolean; serviceFlag?: null | boolean; trackFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; agreementFlag?: null | boolean; configFlag?: null | boolean; externalFlag?: null | boolean; id?: number; identifier?: string; invoiceFlag?: null | boolean; knowledgeBaseFlag?: null | boolean; memberFlag?: null | boolean; mspFlag?: null | boolean; name?: string; procurementFlag?: null | boolean; projectFlag?: null | boolean; salesFlag?: null | boolean; serviceFlag?: null | boolean; trackFlag?: null | boolean }>

getSystemNotificationRecipientsCount

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

getSystemOffice365EmailSetups

  • getSystemOffice365EmailSetups(params?: CommonParameters): Promise<{ _info?: {}; authorizedFlag?: null | boolean; clientId?: string; clientSecret?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; processedFolder: string; tenantId?: string; username: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; authorizedFlag?: null | boolean; clientId?: string; clientSecret?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; processedFolder: string; tenantId?: string; username: string }[]>

getSystemOffice365EmailSetupsById

  • getSystemOffice365EmailSetupsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; authorizedFlag?: null | boolean; clientId?: string; clientSecret?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; processedFolder: string; tenantId?: string; username: string }>

  • Parameters

    Returns Promise<{ _info?: {}; authorizedFlag?: null | boolean; clientId?: string; clientSecret?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; processedFolder: string; tenantId?: string; username: string }>

getSystemOffice365EmailSetupsCount

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

getSystemOsgradeweights

  • getSystemOsgradeweights(params?: CommonParameters): Promise<{ _info?: {}; id?: number; osGradeWeight?: number; osName?: string }[]>

getSystemOsgradeweightsById

  • getSystemOsgradeweightsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; osGradeWeight?: number; osName?: string }>

getSystemOsgradeweightsCount

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

getSystemParsingTypes

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

getSystemParsingTypesById

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

getSystemParsingTypesCount

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

getSystemParsingVariables

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

getSystemParsingVariablesById

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

getSystemParsingVariablesCount

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

getSystemPortalReports

  • getSystemPortalReports(params?: CommonParameters): Promise<{ _info?: {}; customFlag?: null | boolean; displayFlag?: null | boolean; id?: number; name: string; openSameWindowFlag?: null | boolean; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; url: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; customFlag?: null | boolean; displayFlag?: null | boolean; id?: number; name: string; openSameWindowFlag?: null | boolean; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; url: string }[]>

getSystemPortalReportsById

  • getSystemPortalReportsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; customFlag?: null | boolean; displayFlag?: null | boolean; id?: number; name: string; openSameWindowFlag?: null | boolean; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; url: string }>

  • Parameters

    Returns Promise<{ _info?: {}; customFlag?: null | boolean; displayFlag?: null | boolean; id?: number; name: string; openSameWindowFlag?: null | boolean; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; url: string }>

getSystemPortalReportsCount

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

getSystemQuoteLinkSetup

  • getSystemQuoteLinkSetup(params?: CommonParameters): Promise<{ _info?: {}; allLocationsFlag?: null | boolean; id?: number; link: string; location?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; allLocationsFlag?: null | boolean; id?: number; link: string; location?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag?: null | boolean }[]>

getSystemQuoteLinkSetupById

  • getSystemQuoteLinkSetupById(id: number, params?: CommonParameters): Promise<{ _info?: {}; allLocationsFlag?: null | boolean; id?: number; link: string; location?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; allLocationsFlag?: null | boolean; id?: number; link: string; location?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag?: null | boolean }>

getSystemQuoteLinkSetupCount

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

getSystemQuoteLinkSetupTestConnection

  • getSystemQuoteLinkSetupTestConnection(url: string, params?: CommonParameters): Promise<{ message?: string; success?: boolean }>

getSystemReportCards

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

getSystemReportCardsById

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

getSystemReportCardsByIdInfo

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

getSystemReportCardsByParentIdDetails

  • getSystemReportCardsByParentIdDetails(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; kpi?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; sortOrder?: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; kpi?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; sortOrder?: null | number }[]>

getSystemReportCardsByParentIdDetailsById

  • getSystemReportCardsByParentIdDetailsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; kpi?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; sortOrder?: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; kpi?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; sortOrder?: null | number }>

getSystemReportCardsByParentIdDetailsCount

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

getSystemReportCardsCount

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

getSystemReportCardsInfo

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

getSystemReportCardsInfoCount

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

getSystemReports

getSystemReportsByReportName

  • getSystemReportsByReportName(reportName: string, params?: CommonParameters): Promise<{ column_definitions?: {}[]; row_values?: {}[][] }>

getSystemReportsByReportNameColumns

  • getSystemReportsByReportNameColumns(reportName: string, params?: CommonParameters): Promise<{ identityColumn?: boolean; isNullable?: boolean; type?: string }[]>

getSystemReportsByReportNameCount

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

getSystemSecurityRolesByParentIdSettings

  • getSystemSecurityRolesByParentIdSettings(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; addLevel?: null | "All" | "None" | "My"; customFlag?: null | boolean; deleteLevel?: null | "All" | "None" | "My"; editLevel?: null | "All" | "None" | "My"; id?: number; inquireLevel?: null | "All" | "None" | "My"; moduleDescription?: string; moduleFunctionDescription?: string; moduleFunctionIdentifier?: string; moduleFunctionName?: string; moduleIdentifier?: string; moduleName?: string; myAllFlag?: null | boolean; reportFlag?: null | boolean; restrictFlag?: null | boolean; sortOrder?: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; addLevel?: null | "All" | "None" | "My"; customFlag?: null | boolean; deleteLevel?: null | "All" | "None" | "My"; editLevel?: null | "All" | "None" | "My"; id?: number; inquireLevel?: null | "All" | "None" | "My"; moduleDescription?: string; moduleFunctionDescription?: string; moduleFunctionIdentifier?: string; moduleFunctionName?: string; moduleIdentifier?: string; moduleName?: string; myAllFlag?: null | boolean; reportFlag?: null | boolean; restrictFlag?: null | boolean; sortOrder?: null | number }[]>

getSystemSecurityRolesByParentIdSettingsById

  • getSystemSecurityRolesByParentIdSettingsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; addLevel?: null | "All" | "None" | "My"; customFlag?: null | boolean; deleteLevel?: null | "All" | "None" | "My"; editLevel?: null | "All" | "None" | "My"; id?: number; inquireLevel?: null | "All" | "None" | "My"; moduleDescription?: string; moduleFunctionDescription?: string; moduleFunctionIdentifier?: string; moduleFunctionName?: string; moduleIdentifier?: string; moduleName?: string; myAllFlag?: null | boolean; reportFlag?: null | boolean; restrictFlag?: null | boolean; sortOrder?: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; addLevel?: null | "All" | "None" | "My"; customFlag?: null | boolean; deleteLevel?: null | "All" | "None" | "My"; editLevel?: null | "All" | "None" | "My"; id?: number; inquireLevel?: null | "All" | "None" | "My"; moduleDescription?: string; moduleFunctionDescription?: string; moduleFunctionIdentifier?: string; moduleFunctionName?: string; moduleIdentifier?: string; moduleName?: string; myAllFlag?: null | boolean; reportFlag?: null | boolean; restrictFlag?: null | boolean; sortOrder?: null | number }>

getSystemSecurityRolesByParentIdSettingsCount

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

getSystemSecurityroles

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

getSystemSecurityrolesById

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

getSystemSecurityrolesByIdInfo

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

getSystemSecurityrolesCount

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

getSystemSecurityrolesInfo

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

getSystemSecurityrolesInfoCount

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

getSystemSettings

  • getSystemSettings(params?: CommonParameters): Promise<{ _info?: {}; description?: string; id?: number; value: string; valueType?: string }[]>

getSystemSettingsById

  • getSystemSettingsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; description?: string; id?: number; value: string; valueType?: string }>

getSystemSettingsCount

getSystemSetupScreens

  • getSystemSetupScreens(params?: CommonParameters): Promise<{ _info?: {}; category?: string; description?: string; id?: number; moduleDescription?: string; moduleIdentifier?: string; moduleName?: string; name?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; category?: string; description?: string; id?: number; moduleDescription?: string; moduleIdentifier?: string; moduleName?: string; name?: string }[]>

getSystemSetupScreensById

  • getSystemSetupScreensById(id: number, params?: CommonParameters): Promise<{ _info?: {}; category?: string; description?: string; id?: number; moduleDescription?: string; moduleIdentifier?: string; moduleName?: string; name?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; category?: string; description?: string; id?: number; moduleDescription?: string; moduleIdentifier?: string; moduleName?: string; name?: string }>

getSystemSetupScreensCount

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

getSystemSkillCategories

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

getSystemSkillCategoriesById

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

getSystemSkillCategoriesCount

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

getSystemSkills

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

getSystemSkillsById

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

getSystemSkillsByIdInfo

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

getSystemSkillsCount

getSystemSkillsInfo

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

getSystemSkillsInfoCount

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

getSystemSsoConfigurations

  • getSystemSsoConfigurations(params?: CommonParameters): Promise<{ _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }[]>

getSystemSsoConfigurationsById

  • getSystemSsoConfigurationsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }>

getSystemSsoConfigurationsCount

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

getSystemSsoUsers

  • getSystemSsoUsers(params?: CommonParameters): Promise<{ dateEntered?: string; disabledFlag?: null | boolean; email?: string; emailConfirmed?: null | boolean; firstName?: string; id?: number; lastName?: string; lastUpdated?: string; linkedFlag?: null | boolean; linkedMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ssoUserId?: string; userName?: string }[]>

  • Parameters

    Returns Promise<{ dateEntered?: string; disabledFlag?: null | boolean; email?: string; emailConfirmed?: null | boolean; firstName?: string; id?: number; lastName?: string; lastUpdated?: string; linkedFlag?: null | boolean; linkedMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ssoUserId?: string; userName?: string }[]>

getSystemSsoUsersByExternalId

  • getSystemSsoUsersByExternalId(externalId: number, params?: CommonParameters): Promise<{ dateEntered?: string; disabledFlag?: null | boolean; email?: string; emailConfirmed?: null | boolean; firstName?: string; id?: number; lastName?: string; lastUpdated?: string; linkedFlag?: null | boolean; linkedMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ssoUserId?: string; userName?: string }>

  • Parameters

    Returns Promise<{ dateEntered?: string; disabledFlag?: null | boolean; email?: string; emailConfirmed?: null | boolean; firstName?: string; id?: number; lastName?: string; lastUpdated?: string; linkedFlag?: null | boolean; linkedMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; ssoUserId?: string; userName?: string }>

getSystemSsoUsersCount

getSystemStandardNotes

  • getSystemStandardNotes(params?: CommonParameters): Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; contents: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; contents: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string }[]>

getSystemStandardNotesById

  • getSystemStandardNotesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; contents: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string }>

  • Parameters

    Returns Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; contents: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string }>

getSystemStandardNotesCount

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

getSystemSurveys

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

getSystemSurveysByGrandparentIdQuestionsByParentIdValues

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

  • Parameters

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

getSystemSurveysByGrandparentIdQuestionsByParentIdValuesById

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

  • Parameters

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

getSystemSurveysById

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

getSystemSurveysByIdInfo

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

getSystemSurveysByParentIdQuestions

  • getSystemSurveysByParentIdQuestions(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Button" | "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; survey?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Button" | "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; survey?: { _info?: {}; id?: null | number; name?: string } }[]>

getSystemSurveysByParentIdQuestionsById

  • getSystemSurveysByParentIdQuestionsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Button" | "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; survey?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Button" | "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; survey?: { _info?: {}; id?: null | number; name?: string } }>

getSystemSurveysByParentIdQuestionsCount

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

getSystemSurveysCount

getSystemSurveysInfo

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

getSystemSurveysInfoCount

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

getSystemTimeZoneSetups

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

  • Parameters

    Returns Promise<{ _info?: {}; daylightSavingsFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; name: string; offset?: null | number; timeZone?: { _info?: {}; id?: null | number; name?: string } }[]>

getSystemTimeZoneSetupsById

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

  • Parameters

    Returns Promise<{ _info?: {}; daylightSavingsFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; name: string; offset?: null | number; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

getSystemTimeZoneSetupsByIdInfo

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

getSystemTimeZoneSetupsCount

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

getSystemTimeZoneSetupsInfo

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

getSystemTimeZoneSetupsInfoCount

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

getSystemTodayPageCategories

  • getSystemTodayPageCategories(params?: CommonParameters): Promise<{ _info?: {}; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; sortOrder: null | number }[]>

  • Parameters

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

getSystemTodayPageCategoriesById

  • getSystemTodayPageCategoriesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; sortOrder: null | number }>

  • Parameters

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

getSystemTodayPageCategoriesCount

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

getSystemUserDefinedFields

  • getSystemUserDefinedFields(params?: CommonParameters): Promise<{ _info?: {}; addAllBusinessUnits?: null | boolean; addAllLocations?: null | boolean; businessUnitIds?: number[]; buttonUrl?: string; caption: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId: null | number; readOnlyFlag?: null | boolean; removeAllBusinessUnits?: null | boolean; removeAllLocations?: null | boolean; requiredFlag?: null | boolean; sequenceNumber: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; addAllBusinessUnits?: null | boolean; addAllLocations?: null | boolean; businessUnitIds?: number[]; buttonUrl?: string; caption: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId: null | number; readOnlyFlag?: null | boolean; removeAllBusinessUnits?: null | boolean; removeAllLocations?: null | boolean; requiredFlag?: null | boolean; sequenceNumber: null | number }[]>

getSystemUserDefinedFieldsById

  • getSystemUserDefinedFieldsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; addAllBusinessUnits?: null | boolean; addAllLocations?: null | boolean; businessUnitIds?: number[]; buttonUrl?: string; caption: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId: null | number; readOnlyFlag?: null | boolean; removeAllBusinessUnits?: null | boolean; removeAllLocations?: null | boolean; requiredFlag?: null | boolean; sequenceNumber: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; addAllBusinessUnits?: null | boolean; addAllLocations?: null | boolean; businessUnitIds?: number[]; buttonUrl?: string; caption: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId: null | number; readOnlyFlag?: null | boolean; removeAllBusinessUnits?: null | boolean; removeAllLocations?: null | boolean; requiredFlag?: null | boolean; sequenceNumber: null | number }>

getSystemUserDefinedFieldsByIdInfo

  • getSystemUserDefinedFieldsByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; businessUnitIds?: number[]; buttonUrl?: string; caption?: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId?: null | number; readOnlyFlag?: null | boolean; requiredFlag?: null | boolean; sequenceNumber?: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; businessUnitIds?: number[]; buttonUrl?: string; caption?: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId?: null | number; readOnlyFlag?: null | boolean; requiredFlag?: null | boolean; sequenceNumber?: null | number }>

getSystemUserDefinedFieldsCount

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

getSystemUserDefinedFieldsInfo

  • getSystemUserDefinedFieldsInfo(params?: CommonParameters): Promise<{ _info?: {}; businessUnitIds?: number[]; buttonUrl?: string; caption?: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId?: null | number; readOnlyFlag?: null | boolean; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; businessUnitIds?: number[]; buttonUrl?: string; caption?: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId?: null | number; readOnlyFlag?: null | boolean; requiredFlag?: null | boolean; sequenceNumber?: null | number }[]>

getSystemUserDefinedFieldsInfoCount

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

getSystemWorkflowActionsByParentIdAutomateParameters

  • getSystemWorkflowActionsByParentIdAutomateParameters(parentId: number, params?: CommonParameters): Promise<{ id?: number; name: string; value?: string }[]>

getSystemWorkflowActionsByParentIdAutomateParametersById

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

getSystemWorkflowActionsByParentIdAutomateParametersCount

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

getSystemWorkflows

  • getSystemWorkflows(params?: CommonParameters): Promise<{ _info?: {}; activateFlag?: null | boolean; batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"; batchInterval?: null | number; batchLastRan?: string; batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"; board?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; tableType?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; activateFlag?: null | boolean; batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"; batchInterval?: null | number; batchLastRan?: string; batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"; board?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; tableType?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

getSystemWorkflowsByGrandparentIdEventsByParentIdActions

  • getSystemWorkflowsByGrandparentIdEventsByParentIdActions(parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachConfigurationsFor?: null | "Company" | "Contact"; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; attachments?: number[]; auditNotesFlag?: null | boolean; automateScript?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; board?: { _info?: {}; id?: null | number; name?: string }; boardStatus?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; configurationStatus?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; detailNotesFlag?: null | boolean; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; internalNotesFlag?: null | boolean; invoiceMinDays?: null | number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectStatus?: { _info?: {}; id?: null | number; name?: string }; salesOrderStatus?: { _info?: {}; id?: null | number; name?: string }; scriptFailStatus?: { _info?: {}; id?: null | number; name?: string }; scriptSuccessStatus?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificTeamTo?: { _info?: {}; id?: null | number; isProjectTeamFlag?: boolean; name?: string }; subject?: string; updateOwnerFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachConfigurationsFor?: null | "Company" | "Contact"; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; attachments?: number[]; auditNotesFlag?: null | boolean; automateScript?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; board?: { _info?: {}; id?: null | number; name?: string }; boardStatus?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; configurationStatus?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; detailNotesFlag?: null | boolean; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; internalNotesFlag?: null | boolean; invoiceMinDays?: null | number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectStatus?: { _info?: {}; id?: null | number; name?: string }; salesOrderStatus?: { _info?: {}; id?: null | number; name?: string }; scriptFailStatus?: { _info?: {}; id?: null | number; name?: string }; scriptSuccessStatus?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificTeamTo?: { _info?: {}; id?: null | number; isProjectTeamFlag?: boolean; name?: string }; subject?: string; updateOwnerFlag?: null | boolean }[]>

getSystemWorkflowsByGrandparentIdEventsByParentIdActionsById

  • getSystemWorkflowsByGrandparentIdEventsByParentIdActionsById(id: number, parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachConfigurationsFor?: null | "Company" | "Contact"; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; attachments?: number[]; auditNotesFlag?: null | boolean; automateScript?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; board?: { _info?: {}; id?: null | number; name?: string }; boardStatus?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; configurationStatus?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; detailNotesFlag?: null | boolean; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; internalNotesFlag?: null | boolean; invoiceMinDays?: null | number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectStatus?: { _info?: {}; id?: null | number; name?: string }; salesOrderStatus?: { _info?: {}; id?: null | number; name?: string }; scriptFailStatus?: { _info?: {}; id?: null | number; name?: string }; scriptSuccessStatus?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificTeamTo?: { _info?: {}; id?: null | number; isProjectTeamFlag?: boolean; name?: string }; subject?: string; updateOwnerFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachConfigurationsFor?: null | "Company" | "Contact"; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; attachments?: number[]; auditNotesFlag?: null | boolean; automateScript?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; board?: { _info?: {}; id?: null | number; name?: string }; boardStatus?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; configurationStatus?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; detailNotesFlag?: null | boolean; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; internalNotesFlag?: null | boolean; invoiceMinDays?: null | number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectStatus?: { _info?: {}; id?: null | number; name?: string }; salesOrderStatus?: { _info?: {}; id?: null | number; name?: string }; scriptFailStatus?: { _info?: {}; id?: null | number; name?: string }; scriptSuccessStatus?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificTeamTo?: { _info?: {}; id?: null | number; isProjectTeamFlag?: boolean; name?: string }; subject?: string; updateOwnerFlag?: null | boolean }>

getSystemWorkflowsByGrandparentIdEventsByParentIdActionsCount

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

getSystemWorkflowsByGrandparentIdTriggersByParentIdOptions

  • getSystemWorkflowsByGrandparentIdTriggersByParentIdOptions(parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ _info?: {}; customField?: { _info?: {}; id?: null | number; name?: string }; name?: string; value?: string }[]>

  • Parameters

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

getSystemWorkflowsByGrandparentIdTriggersByParentIdOptionsCount

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

getSystemWorkflowsById

  • getSystemWorkflowsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; activateFlag?: null | boolean; batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"; batchInterval?: null | number; batchLastRan?: string; batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"; board?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; tableType?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; activateFlag?: null | boolean; batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"; batchInterval?: null | number; batchLastRan?: string; batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"; board?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; tableType?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

getSystemWorkflowsByParentIdAttachments

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

getSystemWorkflowsByParentIdAttachmentsById

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

getSystemWorkflowsByParentIdAttachmentsCount

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

getSystemWorkflowsByParentIdEvents

  • getSystemWorkflowsByParentIdEvents(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; eventCondition: string; executionTime?: null | "Once" | "MultipleTimes" | "Continuously"; frequencyOfExecution?: null | number; frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"; id?: number; maxNumberOfExecution?: null | number; name?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; eventCondition: string; executionTime?: null | "Once" | "MultipleTimes" | "Continuously"; frequencyOfExecution?: null | number; frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"; id?: number; maxNumberOfExecution?: null | number; name?: string }[]>

getSystemWorkflowsByParentIdEventsById

  • getSystemWorkflowsByParentIdEventsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; eventCondition: string; executionTime?: null | "Once" | "MultipleTimes" | "Continuously"; frequencyOfExecution?: null | number; frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"; id?: number; maxNumberOfExecution?: null | number; name?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; eventCondition: string; executionTime?: null | "Once" | "MultipleTimes" | "Continuously"; frequencyOfExecution?: null | number; frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"; id?: number; maxNumberOfExecution?: null | number; name?: string }>

getSystemWorkflowsByParentIdEventsByIdTest

  • getSystemWorkflowsByParentIdEventsByIdTest(id: number, parentId: number, params?: CommonParameters): Promise<object[]>

getSystemWorkflowsByParentIdEventsCount

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

getSystemWorkflowsByParentIdNotifyTypes

  • getSystemWorkflowsByParentIdNotifyTypes(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; externalFlag?: null | boolean; id?: number; identifier?: string; isSetupFlag?: null | boolean; name?: string }[]>

  • Parameters

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

getSystemWorkflowsByParentIdNotifyTypesById

  • getSystemWorkflowsByParentIdNotifyTypesById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; externalFlag?: null | boolean; id?: number; identifier?: string; isSetupFlag?: null | boolean; name?: string }>

  • Parameters

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

getSystemWorkflowsByParentIdNotifyTypesByIdInfo

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

getSystemWorkflowsByParentIdNotifyTypesCount

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

getSystemWorkflowsByParentIdNotifyTypesInfo

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

getSystemWorkflowsByParentIdNotifyTypesInfoCount

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

getSystemWorkflowsByParentIdTriggers

  • getSystemWorkflowsByParentIdTriggers(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; customField?: { _info?: {}; id?: null | number; name?: string }; description?: string; expectedType?: string; hasOperatorFlag?: null | boolean; hasOptionsFlag?: null | boolean; id?: number; name?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; customField?: { _info?: {}; id?: null | number; name?: string }; description?: string; expectedType?: string; hasOperatorFlag?: null | boolean; hasOptionsFlag?: null | boolean; id?: number; name?: string }[]>

getSystemWorkflowsByParentIdTriggersCount

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

getSystemWorkflowsCount

getSystemWorkflowsTableTypes

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

getSystemWorkflowsTableTypesById

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

getSystemWorkflowsTableTypesByIdInfo

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

getSystemWorkflowsTableTypesCount

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

getSystemWorkflowsTableTypesInfo

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

getSystemWorkflowsTableTypesInfoCount

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

getSystemWorkflowsUserdefinedfieldsByGrandparentIdActionsByParentId

  • getSystemWorkflowsUserdefinedfieldsByGrandparentIdActionsByParentId(parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ _info?: {}; actionId?: number; caption?: string; entryTypeId?: string; eventId?: number; fieldTypeId?: string; id?: number; inactiveFlag?: null | boolean; overwriteFlag?: null | boolean; podDescription?: string; requiredFlag?: null | boolean; userDefinedFieldId?: number; value?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; actionId?: number; caption?: string; entryTypeId?: string; eventId?: number; fieldTypeId?: string; id?: number; inactiveFlag?: null | boolean; overwriteFlag?: null | boolean; podDescription?: string; requiredFlag?: null | boolean; userDefinedFieldId?: number; value?: string }[]>

patchSystemAllowedfiletypesById

  • patchSystemAllowedfiletypesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; fileType: string; id?: number; sizeLimit?: null | number }>

  • Parameters

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

    Returns Promise<{ _info?: {}; fileType: string; id?: number; sizeLimit?: null | number }>

patchSystemAllowedoriginsById

  • patchSystemAllowedoriginsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; description: string; id?: number; lastUpdateUtc?: string; origin: string; updatedBy?: string }>

  • Parameters

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

    Returns Promise<{ _info?: {}; description: string; id?: number; lastUpdateUtc?: string; origin: string; updatedBy?: string }>

patchSystemApiMembersById

  • patchSystemApiMembersById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; blockCostFlag?: null | boolean; blockPriceFlag?: null | boolean; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; excludedServiceBoardIds?: number[]; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; name?: string; notes?: string; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

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

    Returns Promise<{ _info?: {}; blockCostFlag?: null | boolean; blockPriceFlag?: null | boolean; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; excludedServiceBoardIds?: number[]; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; name?: string; notes?: string; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

patchSystemAuthAnvilsById

  • patchSystemAuthAnvilsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; serverLocationUrl: string; siteId: null | number }>

  • Parameters

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

    Returns Promise<{ _info?: {}; id?: number; serverLocationUrl: string; siteId: null | number }>

patchSystemAutoSyncTimeById

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

  • Parameters

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

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

patchSystemCallbacksById

  • patchSystemCallbacksById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; description?: string; id?: number; inactiveFlag?: null | boolean; isSelfSuppressedFlag?: null | boolean; isSoapCallbackFlag?: null | boolean; level?: string; memberId?: null | number; objectId?: null | number; payloadVersion?: string; type?: string; url?: string }>

  • Parameters

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

    Returns Promise<{ _info?: {}; description?: string; id?: number; inactiveFlag?: null | boolean; isSelfSuppressedFlag?: null | boolean; isSoapCallbackFlag?: null | boolean; level?: string; memberId?: null | number; objectId?: null | number; payloadVersion?: string; type?: string; url?: string }>

patchSystemCertificationsById

  • patchSystemCertificationsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: 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; name: string }>

patchSystemConnectwisehostedsetupsById

  • patchSystemConnectwisehostedsetupsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; clientId?: string; createdBy?: string; dateCreated?: string; description: string; disabledFlag?: null | boolean; id?: number; locationIds?: number[]; locationsEnabledFlag?: null | boolean; origin?: string; podHeight?: null | number; screenId: null | number; toolbarButtonDialogHeight?: null | number; toolbarButtonDialogWidth?: null | number; toolbarButtonIconDocumentId?: null | number; toolbarButtonText?: string; toolbarButtonToolTip?: string; type: null | "Tab" | "Pod" | "ToolbarButton"; url: string }>

  • Parameters

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

    Returns Promise<{ _info?: {}; clientId?: string; createdBy?: string; dateCreated?: string; description: string; disabledFlag?: null | boolean; id?: number; locationIds?: number[]; locationsEnabledFlag?: null | boolean; origin?: string; podHeight?: null | number; screenId: null | number; toolbarButtonDialogHeight?: null | number; toolbarButtonDialogWidth?: null | number; toolbarButtonIconDocumentId?: null | number; toolbarButtonText?: string; toolbarButtonToolTip?: string; type: null | "Tab" | "Pod" | "ToolbarButton"; url: string }>

patchSystemCustomReportsById

  • patchSystemCustomReportsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; agreementFlag?: null | boolean; agreementOverride?: string; agreementParamId?: null | number; agreementTypeFlag?: null | boolean; agreementTypeOverride?: string; agreementTypeParamId?: null | number; companyFlag?: null | boolean; companyOverride?: string; companyParamId?: null | number; departmentDefaultFlag?: null | boolean; departmentFlag?: null | boolean; departmentOverride?: string; departmentParamId?: null | number; description: string; endDateFlag?: null | boolean; endDateOverride?: string; endDateParamId?: null | number; generatedFlag?: null | boolean; id?: number; invoiceFlag?: null | boolean; invoiceOverride?: string; invoiceParamId?: null | number; locationDefaultFlag?: null | boolean; locationFlag?: null | boolean; locationOverride?: string; locationParamId?: null | number; marketingCampaignFlag?: null | boolean; marketingCampaignOverride?: string; marketingCampaignParamId?: null | number; memberFlag?: null | boolean; memberOverride?: string; memberParamId?: null | number; module: null | "Project" | "Finance" | "Sales" | "Companies" | "Marketing" | "Procurement" | "ServiceDesk" | "TimeExpense"; name: string; oppTypeFlag?: null | boolean; oppTypeOverride?: string; oppTypeParamId?: null | number; opportunityFlag?: null | boolean; opportunityOverride?: string; opportunityParamId?: null | number; parameterNameSeparator?: string; parameterPrefix?: string; parameterSeparator?: string; parameterSuffix?: string; projectFlag?: null | boolean; projectOverride?: string; projectParamId?: null | number; projectTypeFlag?: null | boolean; projectTypeOverride?: string; projectTypeParamId?: null | number; reportLink: string; serviceBoardDefaultFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceBoardOverride?: string; serviceBoardParamId?: null | number; serviceStatusFlag?: null | boolean; serviceStatusOverride?: string; serviceStatusParamId?: null | number; serviceTypeFlag?: null | boolean; serviceTypeOverride?: string; serviceTypeParamId?: null | number; startDateFlag?: null | boolean; startDateOverride?: string; startDateParamId?: null | number; territoryDefaultFlag?: null | boolean; territoryFlag?: null | boolean; territoryOverride?: string; territoryParamId?: null | number; workRoleFlag?: null | boolean; workRoleOverride?: string; workRoleParamId?: null | number; workTypeFlag?: null | boolean; workTypeOverride?: string; workTypeParamId?: null | number }>

  • Parameters

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

    Returns Promise<{ _info?: {}; agreementFlag?: null | boolean; agreementOverride?: string; agreementParamId?: null | number; agreementTypeFlag?: null | boolean; agreementTypeOverride?: string; agreementTypeParamId?: null | number; companyFlag?: null | boolean; companyOverride?: string; companyParamId?: null | number; departmentDefaultFlag?: null | boolean; departmentFlag?: null | boolean; departmentOverride?: string; departmentParamId?: null | number; description: string; endDateFlag?: null | boolean; endDateOverride?: string; endDateParamId?: null | number; generatedFlag?: null | boolean; id?: number; invoiceFlag?: null | boolean; invoiceOverride?: string; invoiceParamId?: null | number; locationDefaultFlag?: null | boolean; locationFlag?: null | boolean; locationOverride?: string; locationParamId?: null | number; marketingCampaignFlag?: null | boolean; marketingCampaignOverride?: string; marketingCampaignParamId?: null | number; memberFlag?: null | boolean; memberOverride?: string; memberParamId?: null | number; module: null | "Project" | "Finance" | "Sales" | "Companies" | "Marketing" | "Procurement" | "ServiceDesk" | "TimeExpense"; name: string; oppTypeFlag?: null | boolean; oppTypeOverride?: string; oppTypeParamId?: null | number; opportunityFlag?: null | boolean; opportunityOverride?: string; opportunityParamId?: null | number; parameterNameSeparator?: string; parameterPrefix?: string; parameterSeparator?: string; parameterSuffix?: string; projectFlag?: null | boolean; projectOverride?: string; projectParamId?: null | number; projectTypeFlag?: null | boolean; projectTypeOverride?: string; projectTypeParamId?: null | number; reportLink: string; serviceBoardDefaultFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceBoardOverride?: string; serviceBoardParamId?: null | number; serviceStatusFlag?: null | boolean; serviceStatusOverride?: string; serviceStatusParamId?: null | number; serviceTypeFlag?: null | boolean; serviceTypeOverride?: string; serviceTypeParamId?: null | number; startDateFlag?: null | boolean; startDateOverride?: string; startDateParamId?: null | number; territoryDefaultFlag?: null | boolean; territoryFlag?: null | boolean; territoryOverride?: string; territoryParamId?: null | number; workRoleFlag?: null | boolean; workRoleOverride?: string; workRoleParamId?: null | number; workTypeFlag?: null | boolean; workTypeOverride?: string; workTypeParamId?: null | number }>

patchSystemCustomReportsByParentIdParametersById

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

  • Parameters

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

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

patchSystemDepartmentsById

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

  • Parameters

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

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

patchSystemDepartmentsByParentIdLocationsById

  • patchSystemDepartmentsByParentIdLocationsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; addAllLocations?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; departmentManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatch?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; ldapConfig?: { _info?: {}; id?: null | number; name?: string; server?: string }; location?: { _info?: {}; id?: null | number; name?: string }; removeAllLocations?: null | boolean; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

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

    Returns Promise<{ _info?: {}; addAllLocations?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; departmentManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatch?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; ldapConfig?: { _info?: {}; id?: null | number; name?: string; server?: string }; location?: { _info?: {}; id?: null | number; name?: string }; removeAllLocations?: null | boolean; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

patchSystemEPayConfigurationsById

  • patchSystemEPayConfigurationsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; 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 }; encryptionKey?: string; id?: number; initializationVector?: string; location?: { _info?: {}; id?: null | number; name?: string }; storeIdentifier: string; url: string }>

  • Parameters

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

    Returns Promise<{ _info?: {}; 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 }; encryptionKey?: string; id?: number; initializationVector?: string; location?: { _info?: {}; id?: null | number; name?: string }; storeIdentifier: string; url: string }>

patchSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRulesById

  • patchSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRulesById(id: number, parentId: number, grandparentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; parsingStyle?: { _info?: {}; id?: null | number; name?: string }; parsingVariable?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority: null | number; searchTerm: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceStatus?: { _info?: {}; id?: null | number; name?: string }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

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

    Returns Promise<{ _info?: {}; id?: number; parsingStyle?: { _info?: {}; id?: null | number; name?: string }; parsingVariable?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority: null | number; searchTerm: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceStatus?: { _info?: {}; id?: null | number; name?: string }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string } }>

patchSystemEmailConnectorsById

  • patchSystemEmailConnectorsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; addCcFlag?: null | boolean; bccEmailTo?: string; createContactFlag?: null | boolean; defaultCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; discardDuplicatesFlag?: null | boolean; emailErrorsTo: string; emailNotifyFrom?: string; emailServerType?: null | "IMAP" | "Office365" | "Google"; googleEmailSetup?: { _info?: {}; id?: null | number; name?: string }; id?: number; imapSetup?: { _info?: {}; id?: null | number; name?: string }; itemOverride?: { _info?: {}; id?: null | number; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; neverRespondFlag?: null | boolean; noResponseFlag?: null | boolean; office365EmailSetup?: { _info?: {}; id?: null | number; name?: string }; postRepliesToTicketFlag?: null | boolean; priorityOverride?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; responseEmailForExisting?: string; responseEmailForNew?: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; setEmailToDefaultContactFlag?: null | boolean; sourceOverride?: { _info?: {}; id?: null | number; name?: string }; statusOverride?: { _info?: {}; id?: null | number; name?: string }; subTypeOverride?: { _info?: {}; id?: null | number; name?: string }; typeOverride?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

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

    Returns Promise<{ _info?: {}; addCcFlag?: null | boolean; bccEmailTo?: string; createContactFlag?: null | boolean; defaultCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; discardDuplicatesFlag?: null | boolean; emailErrorsTo: string; emailNotifyFrom?: string; emailServerType?: null | "IMAP" | "Office365" | "Google"; googleEmailSetup?: { _info?: {}; id?: null | number; name?: string }; id?: number; imapSetup?: { _info?: {}; id?: null | number; name?: string }; itemOverride?: { _info?: {}; id?: null | number; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; neverRespondFlag?: null | boolean; noResponseFlag?: null | boolean; office365EmailSetup?: { _info?: {}; id?: null | number; name?: string }; postRepliesToTicketFlag?: null | boolean; priorityOverride?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; responseEmailForExisting?: string; responseEmailForNew?: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; setEmailToDefaultContactFlag?: null | boolean; sourceOverride?: { _info?: {}; id?: null | number; name?: string }; statusOverride?: { _info?: {}; id?: null | number; name?: string }; subTypeOverride?: { _info?: {}; id?: null | number; name?: string }; typeOverride?: { _info?: {}; id?: null | number; name?: string } }>

patchSystemEmailConnectorsByParentIdParsingStylesById

  • patchSystemEmailConnectorsByParentIdParsingStylesById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; parseRule: string; parsingType?: { _info?: {}; id?: null | number; name?: string }; priority: null | number }>

  • Parameters

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

    Returns Promise<{ _info?: {}; id?: number; parseRule: string; parsingType?: { _info?: {}; id?: null | number; name?: string }; priority: null | number }>

patchSystemEmailExclusionsById

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

  • Parameters

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

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

patchSystemFileuploadsettingsById

  • patchSystemFileuploadsettingsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; globalFileSizeLimit?: null | number; id?: number; restrictFileTypesFlag: null | boolean }>

  • Parameters

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

    Returns Promise<{ _info?: {}; globalFileSizeLimit?: null | number; id?: number; restrictFileTypesFlag: null | boolean }>

patchSystemGoogleemailsetupById

  • patchSystemGoogleemailsetupById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; clientId?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; privateKey?: string; processedFolder: string; username: string }>

  • Parameters

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

    Returns Promise<{ _info?: {}; clientId?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; privateKey?: string; processedFolder: string; username: string }>

patchSystemImapsById

  • patchSystemImapsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; imapName: string; name: string; password?: string; port: null | number; processedName: string; server: string; sslFlag?: null | boolean; userName: string }>

  • Parameters

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

    Returns Promise<{ _info?: {}; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; imapName: string; name: string; password?: string; port: null | number; processedName: string; server: string; sslFlag?: null | boolean; userName: string }>

patchSystemInOutBoardsById

  • patchSystemInOutBoardsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; additionalInfo?: string; dateBack: string; id?: number; inOutType?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

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

    Returns Promise<{ _info?: {}; additionalInfo?: string; dateBack: string; id?: number; inOutType?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

patchSystemInOutTypesById

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

  • Parameters

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

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

patchSystemIntegratorTagsById

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

  • Parameters

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

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

patchSystemIntegratorloginsById

  • patchSystemIntegratorloginsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; activityApiFlag?: null | boolean; activityCallbackUrl?: string; activityLegacyCallbackFlag?: null | boolean; agreementApiFlag?: null | boolean; agreementCallbackLegacyFlag?: null | boolean; agreementCallbackUrl?: string; board?: { _info?: {}; id?: null | number; name?: string }; canAccessAllApisFlag?: null | boolean; canAccessAllRecordsFlag?: null | boolean; companyApiFlag?: null | boolean; companyCallbackUrl?: string; companyLegacyCallbackFlag?: null | boolean; configurationApiFlag?: null | boolean; configurationAutoChildFlag?: null | boolean; configurationCallbackUrl?: string; configurationChildlingFlag?: null | boolean; configurationLegacyCallbackFlag?: null | boolean; contactApiFlag?: null | boolean; contactCallbackUrl?: string; contactLegacyCallbackFlag?: null | boolean; dateInactivated?: string; documentApiFlag?: null | boolean; id?: number; inactivatedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; inactiveFlag?: null | boolean; invoiceApiFlag?: null | boolean; managedServicesApiFlag?: null | boolean; managedServicesAutoChildFlag?: null | boolean; managedServicesChildingFlag?: null | boolean; marketingApiFlag?: null | boolean; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memberApiFlag?: null | boolean; opportunityApiFlag?: null | boolean; opportunityCallbackUrl?: string; opportunityConversionApiFlag?: null | boolean; opportunityLegacyCallbackFlag?: null | boolean; password?: string; productApiFlag?: null | boolean; productCallbackUrl?: string; productLegacyCallbackFlag?: null | boolean; projectApiFlag?: null | boolean; projectCallbackUrl?: string; projectLegacyCallbackFlag?: null | boolean; purchasingApiFlag?: null | boolean; purchasingCallbackUrl?: string; purchasingLegacyCallbackFlag?: null | boolean; reportingApiFlag?: null | boolean; scheduleApiFlag?: null | boolean; scheduleCallbackUrl?: string; scheduleLegacyCallbackFlag?: null | boolean; serviceBoardCallbackUrl?: string; serviceBoardLegacyCallbackFlag?: null | boolean; serviceTicketApiFlag?: null | boolean; systemApiFlag?: null | boolean; timeEntryApiFlag?: null | boolean; timeEntryCallbackUrl?: string; timeEntryLegacyCallbackFlag?: null | boolean; username: string }>

  • Parameters

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

    Returns Promise<{ _info?: {}; activityApiFlag?: null | boolean; activityCallbackUrl?: string; activityLegacyCallbackFlag?: null | boolean; agreementApiFlag?: null | boolean; agreementCallbackLegacyFlag?: null | boolean; agreementCallbackUrl?: string; board?: { _info?: {}; id?: null | number; name?: string }; canAccessAllApisFlag?: null | boolean; canAccessAllRecordsFlag?: null | boolean; companyApiFlag?: null | boolean; companyCallbackUrl?: string; companyLegacyCallbackFlag?: null | boolean; configurationApiFlag?: null | boolean; configurationAutoChildFlag?: null | boolean; configurationCallbackUrl?: string; configurationChildlingFlag?: null | boolean; configurationLegacyCallbackFlag?: null | boolean; contactApiFlag?: null | boolean; contactCallbackUrl?: string; contactLegacyCallbackFlag?: null | boolean; dateInactivated?: string; documentApiFlag?: null | boolean; id?: number; inactivatedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; inactiveFlag?: null | boolean; invoiceApiFlag?: null | boolean; managedServicesApiFlag?: null | boolean; managedServicesAutoChildFlag?: null | boolean; managedServicesChildingFlag?: null | boolean; marketingApiFlag?: null | boolean; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memberApiFlag?: null | boolean; opportunityApiFlag?: null | boolean; opportunityCallbackUrl?: string; opportunityConversionApiFlag?: null | boolean; opportunityLegacyCallbackFlag?: null | boolean; password?: string; productApiFlag?: null | boolean; productCallbackUrl?: string; productLegacyCallbackFlag?: null | boolean; projectApiFlag?: null | boolean; projectCallbackUrl?: string; projectLegacyCallbackFlag?: null | boolean; purchasingApiFlag?: null | boolean; purchasingCallbackUrl?: string; purchasingLegacyCallbackFlag?: null | boolean; reportingApiFlag?: null | boolean; scheduleApiFlag?: null | boolean; scheduleCallbackUrl?: string; scheduleLegacyCallbackFlag?: null | boolean; serviceBoardCallbackUrl?: string; serviceBoardLegacyCallbackFlag?: null | boolean; serviceTicketApiFlag?: null | boolean; systemApiFlag?: null | boolean; timeEntryApiFlag?: null | boolean; timeEntryCallbackUrl?: string; timeEntryLegacyCallbackFlag?: null | boolean; username: string }>

patchSystemLdapConfigurationsById

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

  • Parameters

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

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

patchSystemLinksById

  • patchSystemLinksById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; name: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service"; tableReferenceId?: null | number; url?: string }>

  • Parameters

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

    Returns Promise<{ _info?: {}; id?: number; name: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service"; tableReferenceId?: null | number; url?: string }>

patchSystemLocationsById

  • patchSystemLocationsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; calendar?: { _info?: {}; id?: null | number; name?: string }; clientFlag?: null | boolean; departmentIds?: number[]; id?: number; locationFlag?: null | boolean; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; overrideAddressLine1?: string; overrideAddressLine2?: string; overrideCity?: string; overrideCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; overrideFaxNumber?: string; overridePhoneNumber?: string; overrideState?: string; overrideZip?: string; owaUrl?: string; ownerLevelId?: null | number; payrollXref?: string; reportsTo?: { _info?: {}; id?: null | number; name?: string }; salesRep?: string; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; workRoleIds?: number[] }>

  • Parameters

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

    Returns Promise<{ _info?: {}; calendar?: { _info?: {}; id?: null | number; name?: string }; clientFlag?: null | boolean; departmentIds?: number[]; id?: number; locationFlag?: null | boolean; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; overrideAddressLine1?: string; overrideAddressLine2?: string; overrideCity?: string; overrideCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; overrideFaxNumber?: string; overridePhoneNumber?: string; overrideState?: string; overrideZip?: string; owaUrl?: string; ownerLevelId?: null | number; payrollXref?: string; reportsTo?: { _info?: {}; id?: null | number; name?: string }; salesRep?: string; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; workRoleIds?: number[] }>

patchSystemManagementNetworkSecuritiesById

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

  • Parameters

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

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

patchSystemMembersById

  • patchSystemMembersById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

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

    Returns Promise<{ _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

patchSystemMembersByParentIdAccrualsById

  • patchSystemMembersByParentIdAccrualsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; accrualType: null | "Holiday" | "PTO" | "Sick" | "Vacation"; hours: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; reason: string; year: null | number }>

  • Parameters

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

    Returns Promise<{ _info?: {}; accrualType: null | "Holiday" | "PTO" | "Sick" | "Vacation"; hours: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; reason: string; year: null | number }>

patchSystemMembersByParentIdCertificationsById

  • patchSystemMembersByParentIdCertificationsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }>

  • Parameters

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

    Returns Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }>

patchSystemMembersByParentIdDelegationsById

  • patchSystemMembersByParentIdDelegationsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

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

    Returns Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

patchSystemMembersByParentIdMycertificationsById

  • patchSystemMembersByParentIdMycertificationsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }>

  • Parameters

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

    Returns Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }>

patchSystemMembersByParentIdNotificationSettingsById

  • patchSystemMembersByParentIdNotificationSettingsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; notificationTrigger: null | "ExpenseReport" | "ActivityStatusReq" | "CustomerUpdated" | "TicketStatusChange" | "TicketStatusRequest" | "TimeNagApprover" | "TimeNagMember" | "TimeSheet" | "WorkflowRules"; notificationType: null | "Email" | "Push" }>

  • Parameters

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

    Returns Promise<{ _info?: {}; id?: number; notificationTrigger: null | "ExpenseReport" | "ActivityStatusReq" | "CustomerUpdated" | "TicketStatusChange" | "TicketStatusRequest" | "TimeNagApprover" | "TimeNagMember" | "TimeSheet" | "WorkflowRules"; notificationType: null | "Email" | "Push" }>

patchSystemMembersByParentIdSkillsById

  • patchSystemMembersByParentIdSkillsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }>

  • Parameters

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

    Returns Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }>

patchSystemMembersTypesById

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

  • Parameters

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

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

patchSystemMenuentriesById

  • patchSystemMenuentriesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; addAllLocations?: null | boolean; caption: string; clientId?: string; id?: number; largeMenuIconId?: null | number; link: string; locationIds?: number[]; menuLocation?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag: null | boolean; origin?: string; removeAllLocations?: null | boolean; smallMenuIconId?: null | number }>

  • Parameters

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

    Returns Promise<{ _info?: {}; addAllLocations?: null | boolean; caption: string; clientId?: string; id?: number; largeMenuIconId?: null | number; link: string; locationIds?: number[]; menuLocation?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag: null | boolean; origin?: string; removeAllLocations?: null | boolean; smallMenuIconId?: null | number }>

patchSystemMyAccountById

  • patchSystemMyAccountById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

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

    Returns Promise<{ _info?: {}; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

patchSystemMyAccountByParentIdDelegationsById

  • patchSystemMyAccountByParentIdDelegationsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

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

    Returns Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

patchSystemMyAccountByParentIdSkillsById

  • patchSystemMyAccountByParentIdSkillsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }>

  • Parameters

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

    Returns Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }>

patchSystemMyCompanyCorporateStructureById

  • patchSystemMyCompanyCorporateStructureById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; baseCurrency: { _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 }; chiefOperatingOfficer?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; controller?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatcher?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; fiscalYearStart: null | "January" | "February" | "March" | "April" | "May" | "June" | "July" | "August" | "September" | "October" | "November" | "December"; groupCaption: string; id?: number; level1Name?: string; level2Name?: string; level3Name?: string; level4Name?: string; level5Name?: string; levelCount?: null | "Level1" | "Level2" | "Level3" | "Level4" | "Level5"; locationCaption: string; president?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

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

    Returns Promise<{ _info?: {}; baseCurrency: { _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 }; chiefOperatingOfficer?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; controller?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatcher?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; fiscalYearStart: null | "January" | "February" | "March" | "April" | "May" | "June" | "July" | "August" | "September" | "October" | "November" | "December"; groupCaption: string; id?: number; level1Name?: string; level2Name?: string; level3Name?: string; level4Name?: string; level5Name?: string; levelCount?: null | "Level1" | "Level2" | "Level3" | "Level4" | "Level5"; locationCaption: string; president?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

patchSystemMyCompanyCrmById

  • patchSystemMyCompanyCrmById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; accountManagerRole?: { _info?: {}; id?: null | number; name?: string }; companyIdGenerationFlag?: null | boolean; companyListCount?: null | number; defaultYear?: null | boolean; excludeSpacesFlag?: null | boolean; field10Caption?: string; field1Caption?: string; field2Caption?: string; field3Caption?: string; field4Caption?: string; field5Caption?: string; field6Caption?: string; field7Caption?: string; field8Caption?: string; field9Caption?: string; id?: number; lockProbabilityFlag?: null | boolean; other1Caption?: string; other2Caption?: string; primaryRepCaption?: string; salesRepRole?: { _info?: {}; id?: null | number; name?: string }; secondaryRepCaption?: string; technicalContactRole?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

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

    Returns Promise<{ _info?: {}; accountManagerRole?: { _info?: {}; id?: null | number; name?: string }; companyIdGenerationFlag?: null | boolean; companyListCount?: null | number; defaultYear?: null | boolean; excludeSpacesFlag?: null | boolean; field10Caption?: string; field1Caption?: string; field2Caption?: string; field3Caption?: string; field4Caption?: string; field5Caption?: string; field6Caption?: string; field7Caption?: string; field8Caption?: string; field9Caption?: string; id?: number; lockProbabilityFlag?: null | boolean; other1Caption?: string; other2Caption?: string; primaryRepCaption?: string; salesRepRole?: { _info?: {}; id?: null | number; name?: string }; secondaryRepCaption?: string; technicalContactRole?: { _info?: {}; id?: null | number; name?: string } }>

patchSystemMyCompanyOtherById

  • patchSystemMyCompanyOtherById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; contactSync?: null | "FL" | "LF" | "CFL" | "CLF"; defaultAddressFormat?: { _info?: {}; id?: null | number; name?: string }; defaultCalendar?: { _info?: {}; id?: null | number; name?: string }; defaultFromAddress: string; defaultLdap?: { _info?: {}; id?: null | number; name?: string; server?: string }; disableZAdminLoginFlag?: null | boolean; id?: number; includePortalLinkFlag?: null | boolean; locale?: { _info?: {}; id?: null | number; name?: string }; logoPath?: string; portalUrlOverride: string; serverTimeZone?: { _info?: {}; id?: null | number; name?: string }; siteUrl: string; syncLeadsFlag?: null | boolean; updateMemberTimeZonesFlag?: null | boolean; useExpandedFormatActivityFlag?: null | boolean; useExpandedFormatTimeFlag?: null | boolean; useSslFlag?: null | boolean }>

  • Parameters

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

    Returns Promise<{ _info?: {}; contactSync?: null | "FL" | "LF" | "CFL" | "CLF"; defaultAddressFormat?: { _info?: {}; id?: null | number; name?: string }; defaultCalendar?: { _info?: {}; id?: null | number; name?: string }; defaultFromAddress: string; defaultLdap?: { _info?: {}; id?: null | number; name?: string; server?: string }; disableZAdminLoginFlag?: null | boolean; id?: number; includePortalLinkFlag?: null | boolean; locale?: { _info?: {}; id?: null | number; name?: string }; logoPath?: string; portalUrlOverride: string; serverTimeZone?: { _info?: {}; id?: null | number; name?: string }; siteUrl: string; syncLeadsFlag?: null | boolean; updateMemberTimeZonesFlag?: null | boolean; useExpandedFormatActivityFlag?: null | boolean; useExpandedFormatTimeFlag?: null | boolean; useSslFlag?: null | boolean }>

patchSystemMyCompanyTimeExpenseById

  • patchSystemMyCompanyTimeExpenseById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; defaultSpecialInvoiceType?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; disableTimeEntryFlag?: null | boolean; id?: number; internalCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; invoiceStart?: null | number; requireExpenseNoteFlag?: null | boolean; requireTimeNoteFlag?: null | boolean; roundingFactor?: null | number; tier1ApprovalFlag?: null | boolean; tier2ApprovalFlag?: null | boolean }>

  • Parameters

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

    Returns Promise<{ _info?: {}; defaultSpecialInvoiceType?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; disableTimeEntryFlag?: null | boolean; id?: number; internalCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; invoiceStart?: null | number; requireExpenseNoteFlag?: null | boolean; requireTimeNoteFlag?: null | boolean; roundingFactor?: null | number; tier1ApprovalFlag?: null | boolean; tier2ApprovalFlag?: null | boolean }>

patchSystemMycompanyDocumentsById

  • patchSystemMycompanyDocumentsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; docPath?: string; id?: number; isPublicFlag?: null | boolean; templateOutputPath?: string; templatePath?: string; uploadAsLinkFlag?: null | boolean }>

  • Parameters

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

    Returns Promise<{ _info?: {}; docPath?: string; id?: number; isPublicFlag?: null | boolean; templateOutputPath?: string; templatePath?: string; uploadAsLinkFlag?: null | boolean }>

patchSystemMycompanyReportingServicesById

  • patchSystemMycompanyReportingServicesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; reportingDomain?: string; reportingPassword?: string; reportingUrl?: string; reportingUserName?: string }>

  • Parameters

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

    Returns Promise<{ _info?: {}; id?: number; reportingDomain?: string; reportingPassword?: string; reportingUrl?: string; reportingUserName?: string }>

patchSystemMycompanyServicesById

  • patchSystemMycompanyServicesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; allowCCFlag?: null | boolean; allowTOFlag?: null | boolean; calendarSetup?: { _info?: {}; id?: null | number }; contactColor?: string; contactColorDisableFlag?: null | boolean; headerColor?: string; headerColorDisableFlag?: null | boolean; hideDelimiterFlag?: null | boolean; id?: number; memberColor?: string; memberColorDisableFlag?: null | boolean; scheduleSpan: "Standard" | "OfficeHours" | "Overnight"; srNotify: null | "All" | "None" | "NewAndClosedRequests" | "ClosedRequestsOnly" | "NewRequestsOnly"; unknownColor?: string; unknownColorDisableFlag?: null | boolean }>

  • Parameters

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

    Returns Promise<{ _info?: {}; allowCCFlag?: null | boolean; allowTOFlag?: null | boolean; calendarSetup?: { _info?: {}; id?: null | number }; contactColor?: string; contactColorDisableFlag?: null | boolean; headerColor?: string; headerColorDisableFlag?: null | boolean; hideDelimiterFlag?: null | boolean; id?: number; memberColor?: string; memberColorDisableFlag?: null | boolean; scheduleSpan: "Standard" | "OfficeHours" | "Overnight"; srNotify: null | "All" | "None" | "NewAndClosedRequests" | "ClosedRequestsOnly" | "NewRequestsOnly"; unknownColor?: string; unknownColorDisableFlag?: null | boolean }>

patchSystemOffice365EmailSetupsById

  • patchSystemOffice365EmailSetupsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; authorizedFlag?: null | boolean; clientId?: string; clientSecret?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; processedFolder: string; tenantId?: string; username: string }>

  • Parameters

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

    Returns Promise<{ _info?: {}; authorizedFlag?: null | boolean; clientId?: string; clientSecret?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; processedFolder: string; tenantId?: string; username: string }>

patchSystemOsgradeweightsById

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

  • Parameters

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

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

patchSystemPortalReportsById

  • patchSystemPortalReportsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; customFlag?: null | boolean; displayFlag?: null | boolean; id?: number; name: string; openSameWindowFlag?: null | boolean; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; url: string }>

  • Parameters

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

    Returns Promise<{ _info?: {}; customFlag?: null | boolean; displayFlag?: null | boolean; id?: number; name: string; openSameWindowFlag?: null | boolean; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; url: string }>

patchSystemQuoteLinkSetupById

  • patchSystemQuoteLinkSetupById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; allLocationsFlag?: null | boolean; id?: number; link: string; location?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag?: null | boolean }>

  • Parameters

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

    Returns Promise<{ _info?: {}; allLocationsFlag?: null | boolean; id?: number; link: string; location?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag?: null | boolean }>

patchSystemReportCardsById

  • patchSystemReportCardsById(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 }>

patchSystemReportCardsByParentIdDetailsById

  • patchSystemReportCardsByParentIdDetailsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; kpi?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; sortOrder?: null | number }>

  • Parameters

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

    Returns Promise<{ _info?: {}; id?: number; kpi?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; sortOrder?: null | number }>

patchSystemSettingsById

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

  • Parameters

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

    Returns Promise<{ _info?: {}; description?: string; id?: number; value: string; valueType?: string }>

patchSystemSkillCategoriesById

  • patchSystemSkillCategoriesById(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 }>

patchSystemSkillsById

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

  • Parameters

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

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

patchSystemSsoConfigurationsById

  • patchSystemSsoConfigurationsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }>

  • Parameters

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

    Returns Promise<{ _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }>

patchSystemStandardNotesById

  • patchSystemStandardNotesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; contents: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string }>

  • Parameters

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

    Returns Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; contents: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string }>

patchSystemSurveysByGrandparentIdQuestionsByParentIdValuesById

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

  • Parameters

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

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

patchSystemSurveysById

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

  • Parameters

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

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

patchSystemSurveysByParentIdQuestionsById

  • patchSystemSurveysByParentIdQuestionsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Button" | "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; survey?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

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

    Returns Promise<{ _info?: {}; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Button" | "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; survey?: { _info?: {}; id?: null | number; name?: string } }>

patchSystemTimeZoneSetupsById

  • patchSystemTimeZoneSetupsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; daylightSavingsFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; name: string; offset?: null | number; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

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

    Returns Promise<{ _info?: {}; daylightSavingsFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; name: string; offset?: null | number; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

patchSystemTodayPageCategoriesById

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

  • Parameters

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

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

patchSystemUserDefinedFieldsById

  • patchSystemUserDefinedFieldsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; addAllBusinessUnits?: null | boolean; addAllLocations?: null | boolean; businessUnitIds?: number[]; buttonUrl?: string; caption: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId: null | number; readOnlyFlag?: null | boolean; removeAllBusinessUnits?: null | boolean; removeAllLocations?: null | boolean; requiredFlag?: null | boolean; sequenceNumber: null | number }>

  • Parameters

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

    Returns Promise<{ _info?: {}; addAllBusinessUnits?: null | boolean; addAllLocations?: null | boolean; businessUnitIds?: number[]; buttonUrl?: string; caption: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId: null | number; readOnlyFlag?: null | boolean; removeAllBusinessUnits?: null | boolean; removeAllLocations?: null | boolean; requiredFlag?: null | boolean; sequenceNumber: null | number }>

patchSystemWorkflowActionsByParentIdAutomateParametersById

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

  • Parameters

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

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

patchSystemWorkflowsByGrandparentIdEventsByParentIdActionsById

  • patchSystemWorkflowsByGrandparentIdEventsByParentIdActionsById(id: number, parentId: number, grandparentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachConfigurationsFor?: null | "Company" | "Contact"; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; attachments?: number[]; auditNotesFlag?: null | boolean; automateScript?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; board?: { _info?: {}; id?: null | number; name?: string }; boardStatus?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; configurationStatus?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; detailNotesFlag?: null | boolean; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; internalNotesFlag?: null | boolean; invoiceMinDays?: null | number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectStatus?: { _info?: {}; id?: null | number; name?: string }; salesOrderStatus?: { _info?: {}; id?: null | number; name?: string }; scriptFailStatus?: { _info?: {}; id?: null | number; name?: string }; scriptSuccessStatus?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificTeamTo?: { _info?: {}; id?: null | number; isProjectTeamFlag?: boolean; name?: string }; subject?: string; updateOwnerFlag?: null | boolean }>

  • Parameters

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

    Returns Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachConfigurationsFor?: null | "Company" | "Contact"; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; attachments?: number[]; auditNotesFlag?: null | boolean; automateScript?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; board?: { _info?: {}; id?: null | number; name?: string }; boardStatus?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; configurationStatus?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; detailNotesFlag?: null | boolean; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; internalNotesFlag?: null | boolean; invoiceMinDays?: null | number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectStatus?: { _info?: {}; id?: null | number; name?: string }; salesOrderStatus?: { _info?: {}; id?: null | number; name?: string }; scriptFailStatus?: { _info?: {}; id?: null | number; name?: string }; scriptSuccessStatus?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificTeamTo?: { _info?: {}; id?: null | number; isProjectTeamFlag?: boolean; name?: string }; subject?: string; updateOwnerFlag?: null | boolean }>

patchSystemWorkflowsById

  • patchSystemWorkflowsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; activateFlag?: null | boolean; batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"; batchInterval?: null | number; batchLastRan?: string; batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"; board?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; tableType?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

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

    Returns Promise<{ _info?: {}; activateFlag?: null | boolean; batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"; batchInterval?: null | number; batchLastRan?: string; batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"; board?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; tableType?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

patchSystemWorkflowsByParentIdEventsById

  • patchSystemWorkflowsByParentIdEventsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; eventCondition: string; executionTime?: null | "Once" | "MultipleTimes" | "Continuously"; frequencyOfExecution?: null | number; frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"; id?: number; maxNumberOfExecution?: null | number; name?: string }>

  • Parameters

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

    Returns Promise<{ _info?: {}; eventCondition: string; executionTime?: null | "Once" | "MultipleTimes" | "Continuously"; frequencyOfExecution?: null | number; frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"; id?: number; maxNumberOfExecution?: null | number; name?: string }>

patchSystemWorkflowsUserdefinedfieldsById

  • patchSystemWorkflowsUserdefinedfieldsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; actionId?: number; caption?: string; entryTypeId?: string; eventId?: number; fieldTypeId?: string; id?: number; inactiveFlag?: null | boolean; overwriteFlag?: null | boolean; podDescription?: string; requiredFlag?: null | boolean; userDefinedFieldId?: number; value?: string }>

  • Parameters

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

    Returns Promise<{ _info?: {}; actionId?: number; caption?: string; entryTypeId?: string; eventId?: number; fieldTypeId?: string; id?: number; inactiveFlag?: null | boolean; overwriteFlag?: null | boolean; podDescription?: string; requiredFlag?: null | boolean; userDefinedFieldId?: number; value?: string }>

postSystemAllowedFileTypes

  • postSystemAllowedFileTypes(allowedFileType: { _info?: {}; fileType: string; id?: number; sizeLimit?: null | number }): Promise<{ _info?: {}; fileType: string; id?: number; sizeLimit?: null | number }>

  • Parameters

    • allowedFileType: { _info?: {}; fileType: string; id?: number; sizeLimit?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • fileType: string
      • Optional id?: number

        Format: int32

      • Optional sizeLimit?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; fileType: string; id?: number; sizeLimit?: null | number }>

postSystemAllowedorigins

  • postSystemAllowedorigins(origin: { _info?: {}; description: string; id?: number; lastUpdateUtc?: string; origin: string; updatedBy?: string }): Promise<{ _info?: {}; description: string; id?: number; lastUpdateUtc?: string; origin: string; updatedBy?: string }>

  • Parameters

    • origin: { _info?: {}; description: string; id?: number; lastUpdateUtc?: string; origin: string; updatedBy?: string }
      • Optional _info?: {}
        • [key: string]: string
      • description: string
        description

        Max length: 2000;

      • Optional id?: number

        Format: int32

      • Optional lastUpdateUtc?: string

        Format: date-time

      • origin: string
        description

        Max length: 2000;

      • Optional updatedBy?: string

    Returns Promise<{ _info?: {}; description: string; id?: number; lastUpdateUtc?: string; origin: string; updatedBy?: string }>

postSystemApiMembers

  • postSystemApiMembers(apiMember: { _info?: {}; blockCostFlag?: null | boolean; blockPriceFlag?: null | boolean; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; excludedServiceBoardIds?: number[]; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; name?: string; notes?: string; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; blockCostFlag?: null | boolean; blockPriceFlag?: null | boolean; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; excludedServiceBoardIds?: number[]; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; name?: string; notes?: string; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • apiMember: { _info?: {}; blockCostFlag?: null | boolean; blockPriceFlag?: null | boolean; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; excludedServiceBoardIds?: number[]; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; name?: string; notes?: string; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional blockCostFlag?: null | boolean
      • Optional blockPriceFlag?: null | boolean
      • 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 emailAddress?: string
        description

        Max length: 250;

      • Optional excludedServiceBoardIds?: number[]
      • Optional id?: number

        Format: int32

      • identifier: string
        description

        Max length: 15;

      • Optional inactiveDate?: string

        Format: date-time

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

        Max length: 30; Required On Updates;

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional structureLevel?: { _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

    Returns Promise<{ _info?: {}; blockCostFlag?: null | boolean; blockPriceFlag?: null | boolean; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; excludedServiceBoardIds?: number[]; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; name?: string; notes?: string; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

postSystemAutoSyncTime

  • postSystemAutoSyncTime(autoSyncTime: { _info?: {}; id?: number; syncTime: string; timeZone?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; syncTime: string; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

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

        Format: int32

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

          Format: int32

        • Optional name?: string

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

postSystemBundles

  • postSystemBundles(requests: { requests: { apiRequest?: { entity?: { id?: number }; externalId?: string; fields?: string; filters?: { childconditions?: string; conditions?: string; customfieldconditions?: string; orderBy?: string }; format?: string; grandParentId?: null | number; id?: number; memberContext?: string; miscProperties?: {}; page?: { page?: null | number; pageId?: null | number; pageSize?: null | number }; parentId?: null | number }; resourceType?: string; sequenceNumber?: number; version?: string }[] }): Promise<{ _info?: {}; results?: { count?: number; entities?: { id?: number }[]; error?: { code?: string; errors?: { code?: string; details?: string; field?: string; message?: string; resource?: string }[]; message?: string }; resourceType?: string; sequenceNumber?: number; statusCode?: number; success?: boolean; version?: string }[] }>

  • Parameters

    • requests: { requests: { apiRequest?: { entity?: { id?: number }; externalId?: string; fields?: string; filters?: { childconditions?: string; conditions?: string; customfieldconditions?: string; orderBy?: string }; format?: string; grandParentId?: null | number; id?: number; memberContext?: string; miscProperties?: {}; page?: { page?: null | number; pageId?: null | number; pageSize?: null | number }; parentId?: null | number }; resourceType?: string; sequenceNumber?: number; version?: string }[] }
      • requests: { apiRequest?: { entity?: { id?: number }; externalId?: string; fields?: string; filters?: { childconditions?: string; conditions?: string; customfieldconditions?: string; orderBy?: string }; format?: string; grandParentId?: null | number; id?: number; memberContext?: string; miscProperties?: {}; page?: { page?: null | number; pageId?: null | number; pageSize?: null | number }; parentId?: null | number }; resourceType?: string; sequenceNumber?: number; version?: string }[]

    Returns Promise<{ _info?: {}; results?: { count?: number; entities?: { id?: number }[]; error?: { code?: string; errors?: { code?: string; details?: string; field?: string; message?: string; resource?: string }[]; message?: string }; resourceType?: string; sequenceNumber?: number; statusCode?: number; success?: boolean; version?: string }[] }>

postSystemBundlesCount

  • postSystemBundlesCount(requests: { requests: { apiRequest?: { entity?: { id?: number }; externalId?: string; fields?: string; filters?: { childconditions?: string; conditions?: string; customfieldconditions?: string; orderBy?: string }; format?: string; grandParentId?: null | number; id?: number; memberContext?: string; miscProperties?: {}; page?: { page?: null | number; pageId?: null | number; pageSize?: null | number }; parentId?: null | number }; resourceType?: string; sequenceNumber?: number; version?: string }[] }): Promise<{ _info?: {}; results?: { count?: number; entities?: { id?: number }[]; error?: { code?: string; errors?: { code?: string; details?: string; field?: string; message?: string; resource?: string }[]; message?: string }; resourceType?: string; sequenceNumber?: number; statusCode?: number; success?: boolean; version?: string }[] }>

  • Parameters

    • requests: { requests: { apiRequest?: { entity?: { id?: number }; externalId?: string; fields?: string; filters?: { childconditions?: string; conditions?: string; customfieldconditions?: string; orderBy?: string }; format?: string; grandParentId?: null | number; id?: number; memberContext?: string; miscProperties?: {}; page?: { page?: null | number; pageId?: null | number; pageSize?: null | number }; parentId?: null | number }; resourceType?: string; sequenceNumber?: number; version?: string }[] }
      • requests: { apiRequest?: { entity?: { id?: number }; externalId?: string; fields?: string; filters?: { childconditions?: string; conditions?: string; customfieldconditions?: string; orderBy?: string }; format?: string; grandParentId?: null | number; id?: number; memberContext?: string; miscProperties?: {}; page?: { page?: null | number; pageId?: null | number; pageSize?: null | number }; parentId?: null | number }; resourceType?: string; sequenceNumber?: number; version?: string }[]

    Returns Promise<{ _info?: {}; results?: { count?: number; entities?: { id?: number }[]; error?: { code?: string; errors?: { code?: string; details?: string; field?: string; message?: string; resource?: string }[]; message?: string }; resourceType?: string; sequenceNumber?: number; statusCode?: number; success?: boolean; version?: string }[] }>

postSystemCallbacks

  • postSystemCallbacks(callbackEntry: { _info?: {}; description?: string; id?: number; inactiveFlag?: null | boolean; isSelfSuppressedFlag?: null | boolean; isSoapCallbackFlag?: null | boolean; level?: string; memberId?: null | number; objectId?: null | number; payloadVersion?: string; type?: string; url?: string }): Promise<{ _info?: {}; description?: string; id?: number; inactiveFlag?: null | boolean; isSelfSuppressedFlag?: null | boolean; isSoapCallbackFlag?: null | boolean; level?: string; memberId?: null | number; objectId?: null | number; payloadVersion?: string; type?: string; url?: string }>

  • Parameters

    • callbackEntry: { _info?: {}; description?: string; id?: number; inactiveFlag?: null | boolean; isSelfSuppressedFlag?: null | boolean; isSoapCallbackFlag?: null | boolean; level?: string; memberId?: null | number; objectId?: null | number; payloadVersion?: string; type?: string; url?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional description?: string
        description

        Max length: 100;

      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • Optional isSelfSuppressedFlag?: null | boolean
      • Optional isSoapCallbackFlag?: null | boolean
      • Optional level?: string
        description

        Required Reference

      • Optional memberId?: null | number

        Format: int32

      • Optional objectId?: null | number

        Format: int32

        description

        Required Reference

      • Optional payloadVersion?: string
      • Optional type?: string
        description

        Required Reference

      • Optional url?: string
        description

        Required Reference

    Returns Promise<{ _info?: {}; description?: string; id?: number; inactiveFlag?: null | boolean; isSelfSuppressedFlag?: null | boolean; isSoapCallbackFlag?: null | boolean; level?: string; memberId?: null | number; objectId?: null | number; payloadVersion?: string; type?: string; url?: string }>

postSystemCertifications

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

  • Parameters

    • certification: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: 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

      • name: string
        description

        Max length: 50;

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

postSystemConnectwisehostedsetups

  • postSystemConnectwisehostedsetups(connectWiseHostedSetup: { _info?: {}; clientId?: string; createdBy?: string; dateCreated?: string; description: string; disabledFlag?: null | boolean; id?: number; locationIds?: number[]; locationsEnabledFlag?: null | boolean; origin?: string; podHeight?: null | number; screenId: null | number; toolbarButtonDialogHeight?: null | number; toolbarButtonDialogWidth?: null | number; toolbarButtonIconDocumentId?: null | number; toolbarButtonText?: string; toolbarButtonToolTip?: string; type: null | "Tab" | "Pod" | "ToolbarButton"; url: string }): Promise<{ _info?: {}; clientId?: string; createdBy?: string; dateCreated?: string; description: string; disabledFlag?: null | boolean; id?: number; locationIds?: number[]; locationsEnabledFlag?: null | boolean; origin?: string; podHeight?: null | number; screenId: null | number; toolbarButtonDialogHeight?: null | number; toolbarButtonDialogWidth?: null | number; toolbarButtonIconDocumentId?: null | number; toolbarButtonText?: string; toolbarButtonToolTip?: string; type: null | "Tab" | "Pod" | "ToolbarButton"; url: string }>

  • Parameters

    • connectWiseHostedSetup: { _info?: {}; clientId?: string; createdBy?: string; dateCreated?: string; description: string; disabledFlag?: null | boolean; id?: number; locationIds?: number[]; locationsEnabledFlag?: null | boolean; origin?: string; podHeight?: null | number; screenId: null | number; toolbarButtonDialogHeight?: null | number; toolbarButtonDialogWidth?: null | number; toolbarButtonIconDocumentId?: null | number; toolbarButtonText?: string; toolbarButtonToolTip?: string; type: null | "Tab" | "Pod" | "ToolbarButton"; url: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional clientId?: string
        description

        Only required if not already set Max length: 36;

      • Optional createdBy?: string
      • Optional dateCreated?: string
      • description: string
        description

        Max length: 50;

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

        Format: int32

      • Optional locationIds?: number[]
      • Optional locationsEnabledFlag?: null | boolean
      • Optional origin?: string
        description

        Max length: 100;

      • Optional podHeight?: null | number

        Format: int32

      • screenId: null | number

        Format: int32

        description

        Can be obtained via ConnectWiseHostedApiScreen report

      • Optional toolbarButtonDialogHeight?: null | number

        Format: int32

      • Optional toolbarButtonDialogWidth?: null | number

        Format: int32

      • Optional toolbarButtonIconDocumentId?: null | number

        Format: int32

      • Optional toolbarButtonText?: string
        description

        Only required for ToolbarButtons Max length: 50;

      • Optional toolbarButtonToolTip?: string
        description

        Max length: 50;

      • type: null | "Tab" | "Pod" | "ToolbarButton"
      • url: string
        description

        Max length: 1024;

    Returns Promise<{ _info?: {}; clientId?: string; createdBy?: string; dateCreated?: string; description: string; disabledFlag?: null | boolean; id?: number; locationIds?: number[]; locationsEnabledFlag?: null | boolean; origin?: string; podHeight?: null | number; screenId: null | number; toolbarButtonDialogHeight?: null | number; toolbarButtonDialogWidth?: null | number; toolbarButtonIconDocumentId?: null | number; toolbarButtonText?: string; toolbarButtonToolTip?: string; type: null | "Tab" | "Pod" | "ToolbarButton"; url: string }>

postSystemCustomReports

  • postSystemCustomReports(customReport: { _info?: {}; agreementFlag?: null | boolean; agreementOverride?: string; agreementParamId?: null | number; agreementTypeFlag?: null | boolean; agreementTypeOverride?: string; agreementTypeParamId?: null | number; companyFlag?: null | boolean; companyOverride?: string; companyParamId?: null | number; departmentDefaultFlag?: null | boolean; departmentFlag?: null | boolean; departmentOverride?: string; departmentParamId?: null | number; description: string; endDateFlag?: null | boolean; endDateOverride?: string; endDateParamId?: null | number; generatedFlag?: null | boolean; id?: number; invoiceFlag?: null | boolean; invoiceOverride?: string; invoiceParamId?: null | number; locationDefaultFlag?: null | boolean; locationFlag?: null | boolean; locationOverride?: string; locationParamId?: null | number; marketingCampaignFlag?: null | boolean; marketingCampaignOverride?: string; marketingCampaignParamId?: null | number; memberFlag?: null | boolean; memberOverride?: string; memberParamId?: null | number; module: null | "Project" | "Finance" | "Sales" | "Companies" | "Marketing" | "Procurement" | "ServiceDesk" | "TimeExpense"; name: string; oppTypeFlag?: null | boolean; oppTypeOverride?: string; oppTypeParamId?: null | number; opportunityFlag?: null | boolean; opportunityOverride?: string; opportunityParamId?: null | number; parameterNameSeparator?: string; parameterPrefix?: string; parameterSeparator?: string; parameterSuffix?: string; projectFlag?: null | boolean; projectOverride?: string; projectParamId?: null | number; projectTypeFlag?: null | boolean; projectTypeOverride?: string; projectTypeParamId?: null | number; reportLink: string; serviceBoardDefaultFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceBoardOverride?: string; serviceBoardParamId?: null | number; serviceStatusFlag?: null | boolean; serviceStatusOverride?: string; serviceStatusParamId?: null | number; serviceTypeFlag?: null | boolean; serviceTypeOverride?: string; serviceTypeParamId?: null | number; startDateFlag?: null | boolean; startDateOverride?: string; startDateParamId?: null | number; territoryDefaultFlag?: null | boolean; territoryFlag?: null | boolean; territoryOverride?: string; territoryParamId?: null | number; workRoleFlag?: null | boolean; workRoleOverride?: string; workRoleParamId?: null | number; workTypeFlag?: null | boolean; workTypeOverride?: string; workTypeParamId?: null | number }): Promise<{ _info?: {}; agreementFlag?: null | boolean; agreementOverride?: string; agreementParamId?: null | number; agreementTypeFlag?: null | boolean; agreementTypeOverride?: string; agreementTypeParamId?: null | number; companyFlag?: null | boolean; companyOverride?: string; companyParamId?: null | number; departmentDefaultFlag?: null | boolean; departmentFlag?: null | boolean; departmentOverride?: string; departmentParamId?: null | number; description: string; endDateFlag?: null | boolean; endDateOverride?: string; endDateParamId?: null | number; generatedFlag?: null | boolean; id?: number; invoiceFlag?: null | boolean; invoiceOverride?: string; invoiceParamId?: null | number; locationDefaultFlag?: null | boolean; locationFlag?: null | boolean; locationOverride?: string; locationParamId?: null | number; marketingCampaignFlag?: null | boolean; marketingCampaignOverride?: string; marketingCampaignParamId?: null | number; memberFlag?: null | boolean; memberOverride?: string; memberParamId?: null | number; module: null | "Project" | "Finance" | "Sales" | "Companies" | "Marketing" | "Procurement" | "ServiceDesk" | "TimeExpense"; name: string; oppTypeFlag?: null | boolean; oppTypeOverride?: string; oppTypeParamId?: null | number; opportunityFlag?: null | boolean; opportunityOverride?: string; opportunityParamId?: null | number; parameterNameSeparator?: string; parameterPrefix?: string; parameterSeparator?: string; parameterSuffix?: string; projectFlag?: null | boolean; projectOverride?: string; projectParamId?: null | number; projectTypeFlag?: null | boolean; projectTypeOverride?: string; projectTypeParamId?: null | number; reportLink: string; serviceBoardDefaultFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceBoardOverride?: string; serviceBoardParamId?: null | number; serviceStatusFlag?: null | boolean; serviceStatusOverride?: string; serviceStatusParamId?: null | number; serviceTypeFlag?: null | boolean; serviceTypeOverride?: string; serviceTypeParamId?: null | number; startDateFlag?: null | boolean; startDateOverride?: string; startDateParamId?: null | number; territoryDefaultFlag?: null | boolean; territoryFlag?: null | boolean; territoryOverride?: string; territoryParamId?: null | number; workRoleFlag?: null | boolean; workRoleOverride?: string; workRoleParamId?: null | number; workTypeFlag?: null | boolean; workTypeOverride?: string; workTypeParamId?: null | number }>

  • Parameters

    • customReport: { _info?: {}; agreementFlag?: null | boolean; agreementOverride?: string; agreementParamId?: null | number; agreementTypeFlag?: null | boolean; agreementTypeOverride?: string; agreementTypeParamId?: null | number; companyFlag?: null | boolean; companyOverride?: string; companyParamId?: null | number; departmentDefaultFlag?: null | boolean; departmentFlag?: null | boolean; departmentOverride?: string; departmentParamId?: null | number; description: string; endDateFlag?: null | boolean; endDateOverride?: string; endDateParamId?: null | number; generatedFlag?: null | boolean; id?: number; invoiceFlag?: null | boolean; invoiceOverride?: string; invoiceParamId?: null | number; locationDefaultFlag?: null | boolean; locationFlag?: null | boolean; locationOverride?: string; locationParamId?: null | number; marketingCampaignFlag?: null | boolean; marketingCampaignOverride?: string; marketingCampaignParamId?: null | number; memberFlag?: null | boolean; memberOverride?: string; memberParamId?: null | number; module: null | "Project" | "Finance" | "Sales" | "Companies" | "Marketing" | "Procurement" | "ServiceDesk" | "TimeExpense"; name: string; oppTypeFlag?: null | boolean; oppTypeOverride?: string; oppTypeParamId?: null | number; opportunityFlag?: null | boolean; opportunityOverride?: string; opportunityParamId?: null | number; parameterNameSeparator?: string; parameterPrefix?: string; parameterSeparator?: string; parameterSuffix?: string; projectFlag?: null | boolean; projectOverride?: string; projectParamId?: null | number; projectTypeFlag?: null | boolean; projectTypeOverride?: string; projectTypeParamId?: null | number; reportLink: string; serviceBoardDefaultFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceBoardOverride?: string; serviceBoardParamId?: null | number; serviceStatusFlag?: null | boolean; serviceStatusOverride?: string; serviceStatusParamId?: null | number; serviceTypeFlag?: null | boolean; serviceTypeOverride?: string; serviceTypeParamId?: null | number; startDateFlag?: null | boolean; startDateOverride?: string; startDateParamId?: null | number; territoryDefaultFlag?: null | boolean; territoryFlag?: null | boolean; territoryOverride?: string; territoryParamId?: null | number; workRoleFlag?: null | boolean; workRoleOverride?: string; workRoleParamId?: null | number; workTypeFlag?: null | boolean; workTypeOverride?: string; workTypeParamId?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementFlag?: null | boolean
      • Optional agreementOverride?: string
      • Optional agreementParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Agreement parameter

      • Optional agreementTypeFlag?: null | boolean
      • Optional agreementTypeOverride?: string
      • Optional agreementTypeParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Agreement Type parameter

      • Optional companyFlag?: null | boolean
      • Optional companyOverride?: string
      • Optional companyParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Company parameter

      • Optional departmentDefaultFlag?: null | boolean
      • Optional departmentFlag?: null | boolean
      • Optional departmentOverride?: string
      • Optional departmentParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Department parameter

      • description: string
        description

        Max length: 150;

      • Optional endDateFlag?: null | boolean
      • Optional endDateOverride?: string
      • Optional endDateParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's End Date parameter

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

        Format: int32

      • Optional invoiceFlag?: null | boolean
      • Optional invoiceOverride?: string
      • Optional invoiceParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Invoice Type parameter

      • Optional locationDefaultFlag?: null | boolean
      • Optional locationFlag?: null | boolean
      • Optional locationOverride?: string
      • Optional locationParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Location parameter

      • Optional marketingCampaignFlag?: null | boolean
      • Optional marketingCampaignOverride?: string
      • Optional marketingCampaignParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Marketing Campaign parameter

      • Optional memberFlag?: null | boolean
      • Optional memberOverride?: string
      • Optional memberParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Member parameter

      • module: null | "Project" | "Finance" | "Sales" | "Companies" | "Marketing" | "Procurement" | "ServiceDesk" | "TimeExpense"
        description

        The Module Name

      • name: string
        description

        Max length: 100;

      • Optional oppTypeFlag?: null | boolean
      • Optional oppTypeOverride?: string
      • Optional oppTypeParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Opportunity Type parameter

      • Optional opportunityFlag?: null | boolean
      • Optional opportunityOverride?: string
      • Optional opportunityParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Opportunity parameter

      • Optional parameterNameSeparator?: string
        description

        Max length: 50;

      • Optional parameterPrefix?: string
        description

        Max length: 50;

      • Optional parameterSeparator?: string
        description

        Max length: 50;

      • Optional parameterSuffix?: string
        description

        Max length: 50;

      • Optional projectFlag?: null | boolean
      • Optional projectOverride?: string
      • Optional projectParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Project parameter

      • Optional projectTypeFlag?: null | boolean
      • Optional projectTypeOverride?: string
      • Optional projectTypeParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Project Type parameter

      • reportLink: string
      • Optional serviceBoardDefaultFlag?: null | boolean
      • Optional serviceBoardFlag?: null | boolean
      • Optional serviceBoardOverride?: string
      • Optional serviceBoardParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Service Board parameter

      • Optional serviceStatusFlag?: null | boolean
      • Optional serviceStatusOverride?: string
      • Optional serviceStatusParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Service Status parameter

      • Optional serviceTypeFlag?: null | boolean
      • Optional serviceTypeOverride?: string
      • Optional serviceTypeParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Service Type parameter

      • Optional startDateFlag?: null | boolean
      • Optional startDateOverride?: string
      • Optional startDateParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Start Date parameter

      • Optional territoryDefaultFlag?: null | boolean
      • Optional territoryFlag?: null | boolean
      • Optional territoryOverride?: string
      • Optional territoryParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Terriroty parameter

      • Optional workRoleFlag?: null | boolean
      • Optional workRoleOverride?: string
      • Optional workRoleParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Work Role parameter

      • Optional workTypeFlag?: null | boolean
      • Optional workTypeOverride?: string
      • Optional workTypeParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Work Type parameter

    Returns Promise<{ _info?: {}; agreementFlag?: null | boolean; agreementOverride?: string; agreementParamId?: null | number; agreementTypeFlag?: null | boolean; agreementTypeOverride?: string; agreementTypeParamId?: null | number; companyFlag?: null | boolean; companyOverride?: string; companyParamId?: null | number; departmentDefaultFlag?: null | boolean; departmentFlag?: null | boolean; departmentOverride?: string; departmentParamId?: null | number; description: string; endDateFlag?: null | boolean; endDateOverride?: string; endDateParamId?: null | number; generatedFlag?: null | boolean; id?: number; invoiceFlag?: null | boolean; invoiceOverride?: string; invoiceParamId?: null | number; locationDefaultFlag?: null | boolean; locationFlag?: null | boolean; locationOverride?: string; locationParamId?: null | number; marketingCampaignFlag?: null | boolean; marketingCampaignOverride?: string; marketingCampaignParamId?: null | number; memberFlag?: null | boolean; memberOverride?: string; memberParamId?: null | number; module: null | "Project" | "Finance" | "Sales" | "Companies" | "Marketing" | "Procurement" | "ServiceDesk" | "TimeExpense"; name: string; oppTypeFlag?: null | boolean; oppTypeOverride?: string; oppTypeParamId?: null | number; opportunityFlag?: null | boolean; opportunityOverride?: string; opportunityParamId?: null | number; parameterNameSeparator?: string; parameterPrefix?: string; parameterSeparator?: string; parameterSuffix?: string; projectFlag?: null | boolean; projectOverride?: string; projectParamId?: null | number; projectTypeFlag?: null | boolean; projectTypeOverride?: string; projectTypeParamId?: null | number; reportLink: string; serviceBoardDefaultFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceBoardOverride?: string; serviceBoardParamId?: null | number; serviceStatusFlag?: null | boolean; serviceStatusOverride?: string; serviceStatusParamId?: null | number; serviceTypeFlag?: null | boolean; serviceTypeOverride?: string; serviceTypeParamId?: null | number; startDateFlag?: null | boolean; startDateOverride?: string; startDateParamId?: null | number; territoryDefaultFlag?: null | boolean; territoryFlag?: null | boolean; territoryOverride?: string; territoryParamId?: null | number; workRoleFlag?: null | boolean; workRoleOverride?: string; workRoleParamId?: null | number; workTypeFlag?: null | boolean; workTypeOverride?: string; workTypeParamId?: null | number }>

postSystemCustomReportsByParentIdParameters

  • postSystemCustomReportsByParentIdParameters(parentId: number, customReportParameter: { _info?: {}; captionName?: string; customReport?: { _info?: {}; id?: null | number; name?: string }; id?: number; name?: string }): Promise<{ _info?: {}; captionName?: string; customReport?: { _info?: {}; id?: null | number; name?: string }; id?: number; name?: string }>

  • Parameters

    • parentId: number
    • customReportParameter: { _info?: {}; captionName?: string; customReport?: { _info?: {}; id?: null | number; name?: string }; id?: number; name?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional captionName?: string
        description

        Either a caption name or parameter name is required Max length: 50;

      • Optional customReport?: { _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 name?: string
        description

        Either a caption name or parameter name is required Max length: 50;

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

postSystemDepartments

  • postSystemDepartments(department: { _info?: {}; id?: number; identifier: string; name: string }): Promise<{ _info?: {}; id?: number; identifier: string; name: string }>

  • Parameters

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

        Format: int32

      • identifier: string
        description

        Max length: 15;

      • name: string
        description

        Max length: 50;

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

postSystemDepartmentsByParentIdLocations

  • postSystemDepartmentsByParentIdLocations(parentId: number, departmentLocation: { _info?: {}; addAllLocations?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; departmentManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatch?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; ldapConfig?: { _info?: {}; id?: null | number; name?: string; server?: string }; location?: { _info?: {}; id?: null | number; name?: string }; removeAllLocations?: null | boolean; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; addAllLocations?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; departmentManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatch?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; ldapConfig?: { _info?: {}; id?: null | number; name?: string; server?: string }; location?: { _info?: {}; id?: null | number; name?: string }; removeAllLocations?: null | boolean; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • parentId: number
    • departmentLocation: { _info?: {}; addAllLocations?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; departmentManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatch?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; ldapConfig?: { _info?: {}; id?: null | number; name?: string; server?: string }; location?: { _info?: {}; id?: null | number; name?: string }; removeAllLocations?: null | boolean; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addAllLocations?: null | boolean
      • 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 departmentManager?: { _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 dispatch?: { _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 dutyManager?: { _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 ldapConfig?: { _info?: {}; id?: null | number; name?: string; server?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional removeAllLocations?: null | boolean
      • Optional serviceManager?: { _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?: {}; addAllLocations?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; departmentManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatch?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; ldapConfig?: { _info?: {}; id?: null | number; name?: string; server?: string }; location?: { _info?: {}; id?: null | number; name?: string }; removeAllLocations?: null | boolean; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

postSystemDocuments

  • postSystemDocuments(documentFormData: { file?: string; isAvatar?: boolean; privateFlag?: boolean; readOnlyFlay?: boolean; recordId?: number; recordType?: string; title?: string; url?: string }): Promise<{ _info?: {}; fileName?: string; guid?: string; htmlTemplateFlag?: null | boolean; id?: number; imageFlag?: null | boolean; linkFlag?: null | boolean; owner?: string; publicFlag?: null | boolean; readOnlyFlag?: null | boolean; serverFileName?: string; size?: null | number; title?: string; urlFlag?: null | boolean }>

  • Parameters

    • documentFormData: { file?: string; isAvatar?: boolean; privateFlag?: boolean; readOnlyFlay?: boolean; recordId?: number; recordType?: string; title?: string; url?: string }
      • Optional file?: string

        Format: binary

      • Optional isAvatar?: boolean
      • Optional privateFlag?: boolean
      • Optional readOnlyFlay?: boolean
      • Optional recordId?: number

        Format: int32

      • Optional recordType?: string
      • Optional title?: string
      • Optional url?: string

    Returns Promise<{ _info?: {}; fileName?: string; guid?: string; htmlTemplateFlag?: null | boolean; id?: number; imageFlag?: null | boolean; linkFlag?: null | boolean; owner?: string; publicFlag?: null | boolean; readOnlyFlag?: null | boolean; serverFileName?: string; size?: null | number; title?: string; urlFlag?: null | boolean }>

postSystemDocumentsById

  • postSystemDocumentsById(id: number): Promise<{ _info?: {}; fileName?: string; guid?: string; htmlTemplateFlag?: null | boolean; id?: number; imageFlag?: null | boolean; linkFlag?: null | boolean; owner?: string; publicFlag?: null | boolean; readOnlyFlag?: null | boolean; serverFileName?: string; size?: null | number; title?: string; urlFlag?: null | boolean }>

  • Parameters

    • id: number

    Returns Promise<{ _info?: {}; fileName?: string; guid?: string; htmlTemplateFlag?: null | boolean; id?: number; imageFlag?: null | boolean; linkFlag?: null | boolean; owner?: string; publicFlag?: null | boolean; readOnlyFlag?: null | boolean; serverFileName?: string; size?: null | number; title?: string; urlFlag?: null | boolean }>

postSystemEPayConfigurations

  • postSystemEPayConfigurations(ePayConfiguration: { _info?: {}; 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 }; encryptionKey?: string; id?: number; initializationVector?: string; location?: { _info?: {}; id?: null | number; name?: string }; storeIdentifier: string; url: string }): Promise<{ _info?: {}; 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 }; encryptionKey?: string; id?: number; initializationVector?: string; location?: { _info?: {}; id?: null | number; name?: string }; storeIdentifier: string; url: string }>

  • Parameters

    • ePayConfiguration: { _info?: {}; 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 }; encryptionKey?: string; id?: number; initializationVector?: string; location?: { _info?: {}; id?: null | number; name?: string }; storeIdentifier: string; url: string }
      • Optional _info?: {}
        • [key: string]: 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 encryptionKey?: string
        description

        Max length: 500;

      • Optional id?: number

        Format: int32

      • Optional initializationVector?: string
        description

        Max length: 500;

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

          Format: int32

        • Optional name?: string
      • storeIdentifier: string
        description

        Max length: 500;

      • url: string
        description

        Max length: 400;

    Returns Promise<{ _info?: {}; 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 }; encryptionKey?: string; id?: number; initializationVector?: string; location?: { _info?: {}; id?: null | number; name?: string }; storeIdentifier: string; url: string }>

postSystemEmailConnectors

  • postSystemEmailConnectors(emailConnector: { _info?: {}; addCcFlag?: null | boolean; bccEmailTo?: string; createContactFlag?: null | boolean; defaultCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; discardDuplicatesFlag?: null | boolean; emailErrorsTo: string; emailNotifyFrom?: string; emailServerType?: null | "IMAP" | "Office365" | "Google"; googleEmailSetup?: { _info?: {}; id?: null | number; name?: string }; id?: number; imapSetup?: { _info?: {}; id?: null | number; name?: string }; itemOverride?: { _info?: {}; id?: null | number; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; neverRespondFlag?: null | boolean; noResponseFlag?: null | boolean; office365EmailSetup?: { _info?: {}; id?: null | number; name?: string }; postRepliesToTicketFlag?: null | boolean; priorityOverride?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; responseEmailForExisting?: string; responseEmailForNew?: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; setEmailToDefaultContactFlag?: null | boolean; sourceOverride?: { _info?: {}; id?: null | number; name?: string }; statusOverride?: { _info?: {}; id?: null | number; name?: string }; subTypeOverride?: { _info?: {}; id?: null | number; name?: string }; typeOverride?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; addCcFlag?: null | boolean; bccEmailTo?: string; createContactFlag?: null | boolean; defaultCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; discardDuplicatesFlag?: null | boolean; emailErrorsTo: string; emailNotifyFrom?: string; emailServerType?: null | "IMAP" | "Office365" | "Google"; googleEmailSetup?: { _info?: {}; id?: null | number; name?: string }; id?: number; imapSetup?: { _info?: {}; id?: null | number; name?: string }; itemOverride?: { _info?: {}; id?: null | number; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; neverRespondFlag?: null | boolean; noResponseFlag?: null | boolean; office365EmailSetup?: { _info?: {}; id?: null | number; name?: string }; postRepliesToTicketFlag?: null | boolean; priorityOverride?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; responseEmailForExisting?: string; responseEmailForNew?: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; setEmailToDefaultContactFlag?: null | boolean; sourceOverride?: { _info?: {}; id?: null | number; name?: string }; statusOverride?: { _info?: {}; id?: null | number; name?: string }; subTypeOverride?: { _info?: {}; id?: null | number; name?: string }; typeOverride?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • emailConnector: { _info?: {}; addCcFlag?: null | boolean; bccEmailTo?: string; createContactFlag?: null | boolean; defaultCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; discardDuplicatesFlag?: null | boolean; emailErrorsTo: string; emailNotifyFrom?: string; emailServerType?: null | "IMAP" | "Office365" | "Google"; googleEmailSetup?: { _info?: {}; id?: null | number; name?: string }; id?: number; imapSetup?: { _info?: {}; id?: null | number; name?: string }; itemOverride?: { _info?: {}; id?: null | number; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; neverRespondFlag?: null | boolean; noResponseFlag?: null | boolean; office365EmailSetup?: { _info?: {}; id?: null | number; name?: string }; postRepliesToTicketFlag?: null | boolean; priorityOverride?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; responseEmailForExisting?: string; responseEmailForNew?: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; setEmailToDefaultContactFlag?: null | boolean; sourceOverride?: { _info?: {}; id?: null | number; name?: string }; statusOverride?: { _info?: {}; id?: null | number; name?: string }; subTypeOverride?: { _info?: {}; id?: null | number; name?: string }; typeOverride?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addCcFlag?: null | boolean
      • Optional bccEmailTo?: string
        description

        Max length: 250;

      • Optional createContactFlag?: null | boolean
      • Optional defaultCompany?: { _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 defaultMember?: { _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 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 discardDuplicatesFlag?: null | boolean
      • emailErrorsTo: string
        description

        Max length: 50;

      • Optional emailNotifyFrom?: string
        description

        Max length: 50;

      • Optional emailServerType?: null | "IMAP" | "Office365" | "Google"
      • Optional googleEmailSetup?: { _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 imapSetup?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional neverRespondFlag?: null | boolean
      • Optional noResponseFlag?: null | boolean
      • Optional office365EmailSetup?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional postRepliesToTicketFlag?: null | boolean
      • Optional priorityOverride?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; addCcFlag?: null | boolean; bccEmailTo?: string; createContactFlag?: null | boolean; defaultCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; discardDuplicatesFlag?: null | boolean; emailErrorsTo: string; emailNotifyFrom?: string; emailServerType?: null | "IMAP" | "Office365" | "Google"; googleEmailSetup?: { _info?: {}; id?: null | number; name?: string }; id?: number; imapSetup?: { _info?: {}; id?: null | number; name?: string }; itemOverride?: { _info?: {}; id?: null | number; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; neverRespondFlag?: null | boolean; noResponseFlag?: null | boolean; office365EmailSetup?: { _info?: {}; id?: null | number; name?: string }; postRepliesToTicketFlag?: null | boolean; priorityOverride?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; responseEmailForExisting?: string; responseEmailForNew?: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; setEmailToDefaultContactFlag?: null | boolean; sourceOverride?: { _info?: {}; id?: null | number; name?: string }; statusOverride?: { _info?: {}; id?: null | number; name?: string }; subTypeOverride?: { _info?: {}; id?: null | number; name?: string }; typeOverride?: { _info?: {}; id?: null | number; name?: string } }>

postSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRules

  • postSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRules(parentId: number, grandparentId: number, emailConnectorParsingRule: { _info?: {}; id?: number; parsingStyle?: { _info?: {}; id?: null | number; name?: string }; parsingVariable?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority: null | number; searchTerm: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceStatus?: { _info?: {}; id?: null | number; name?: string }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; parsingStyle?: { _info?: {}; id?: null | number; name?: string }; parsingVariable?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority: null | number; searchTerm: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceStatus?: { _info?: {}; id?: null | number; name?: string }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • grandparentId: number
    • emailConnectorParsingRule: { _info?: {}; id?: number; parsingStyle?: { _info?: {}; id?: null | number; name?: string }; parsingVariable?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority: null | number; searchTerm: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceStatus?: { _info?: {}; id?: null | number; name?: string }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional parsingVariable?: { _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
      • priority: null | number

        Format: int32

      • searchTerm: string
        description

        Max length: 250;

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; id?: number; parsingStyle?: { _info?: {}; id?: null | number; name?: string }; parsingVariable?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority: null | number; searchTerm: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceStatus?: { _info?: {}; id?: null | number; name?: string }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string } }>

postSystemEmailConnectorsByParentIdParsingStyles

  • postSystemEmailConnectorsByParentIdParsingStyles(parentId: number, emailConnectorParsingStyle: { _info?: {}; id?: number; parseRule: string; parsingType?: { _info?: {}; id?: null | number; name?: string }; priority: null | number }): Promise<{ _info?: {}; id?: number; parseRule: string; parsingType?: { _info?: {}; id?: null | number; name?: string }; priority: null | number }>

  • Parameters

    • parentId: number
    • emailConnectorParsingStyle: { _info?: {}; id?: number; parseRule: string; parsingType?: { _info?: {}; id?: null | number; name?: string }; priority: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • parseRule: string
        description

        Max length: 500;

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

          Format: int32

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

        Format: int32

    Returns Promise<{ _info?: {}; id?: number; parseRule: string; parsingType?: { _info?: {}; id?: null | number; name?: string }; priority: null | number }>

postSystemEmailExclusions

  • postSystemEmailExclusions(emailExclusion: { _info?: {}; description: string; id?: number }): Promise<{ _info?: {}; description: string; id?: number }>

  • Parameters

    • emailExclusion: { _info?: {}; description: string; id?: number }
      • Optional _info?: {}
        • [key: string]: string
      • description: string
        description

        Max length: 100;

      • Optional id?: number

        Format: int32

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

postSystemGoogleemailsetup

  • postSystemGoogleemailsetup(GoogleEmailSetup: { _info?: {}; clientId?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; privateKey?: string; processedFolder: string; username: string }): Promise<{ _info?: {}; clientId?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; privateKey?: string; processedFolder: string; username: string }>

  • Parameters

    • GoogleEmailSetup: { _info?: {}; clientId?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; privateKey?: string; processedFolder: string; username: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional clientId?: string
        description

        Max length: 200;

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

          Format: int32

        • Optional name?: string
      • failedFolder: string
        description

        Max length: 40;

      • Optional id?: number

        Format: int32

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

        Max length: 40;

      • name: string
        description

        Max length: 200;

      • Optional privateKey?: string
        description

        Max length: 4000;

      • processedFolder: string
        description

        Max length: 40;

      • username: string
        description

        Max length: 100;

    Returns Promise<{ _info?: {}; clientId?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; privateKey?: string; processedFolder: string; username: string }>

postSystemGoogleemailsetupByIdTestConnection

  • postSystemGoogleemailsetupByIdTestConnection(id: number): Promise<{ message?: string; success?: boolean }>

postSystemImaps

  • postSystemImaps(imap: { _info?: {}; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; imapName: string; name: string; password?: string; port: null | number; processedName: string; server: string; sslFlag?: null | boolean; userName: string }): Promise<{ _info?: {}; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; imapName: string; name: string; password?: string; port: null | number; processedName: string; server: string; sslFlag?: null | boolean; userName: string }>

  • Parameters

    • imap: { _info?: {}; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; imapName: string; name: string; password?: string; port: null | number; processedName: string; server: string; sslFlag?: null | boolean; userName: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional emailConnector?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • failedFolder: string
        description

        Max length: 40;

      • Optional id?: number

        Format: int32

      • imapName: string
        description

        Max length: 40;

      • name: string
        description

        Max length: 200;

      • Optional password?: string
        description

        Max length: 80;

      • port: null | number

        Format: int32

      • processedName: string
        description

        Max length: 40;

      • server: string
        description

        Max length: 200;

      • Optional sslFlag?: null | boolean
      • userName: string
        description

        Max length: 80;

    Returns Promise<{ _info?: {}; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; imapName: string; name: string; password?: string; port: null | number; processedName: string; server: string; sslFlag?: null | boolean; userName: string }>

postSystemImportMassMaintenanceById

  • postSystemImportMassMaintenanceById(id: number): Promise<{ deletedCompanyCount?: number; deletedContactCount?: number; message?: string; success?: boolean }>

  • Parameters

    • id: number

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

postSystemInOutBoards

  • postSystemInOutBoards(inOutBoard: { _info?: {}; additionalInfo?: string; dateBack: string; id?: number; inOutType?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; additionalInfo?: string; dateBack: string; id?: number; inOutType?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • inOutBoard: { _info?: {}; additionalInfo?: string; dateBack: string; id?: number; inOutType?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional additionalInfo?: string
        description

        Max length: 100;

      • dateBack: string

        Format: date-time

      • Optional id?: number

        Format: int32

      • Optional inOutType?: { _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

    Returns Promise<{ _info?: {}; additionalInfo?: string; dateBack: string; id?: number; inOutType?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

postSystemInOutTypes

  • postSystemInOutTypes(inOutType: { _info?: {}; description: string; id?: number }): Promise<{ _info?: {}; description: string; id?: number }>

  • Parameters

    • inOutType: { _info?: {}; description: string; id?: number }
      • Optional _info?: {}
        • [key: string]: string
      • description: string
        description

        Max length: 30;

      • Optional id?: number

        Format: int32

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

postSystemInfoLinksByIdResolveurl

  • postSystemInfoLinksByIdResolveurl(id: number, resolveInfo: { referenceId: null | number; url?: string }): Promise<{ referenceId: null | number; url?: string }>

  • Parameters

    • id: number
    • resolveInfo: { referenceId: null | number; url?: string }
      • referenceId: null | number

        Format: int32

      • Optional url?: string

    Returns Promise<{ referenceId: null | number; url?: string }>

postSystemIntegratorTags

  • postSystemIntegratorTags(tag: { _info?: {}; id?: number; text: string }): Promise<{ _info?: {}; id?: number; text: string }>

  • Parameters

    • tag: { _info?: {}; id?: number; text: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • text: string
        description

        Max length: 50;

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

postSystemIntegratorlogins

  • postSystemIntegratorlogins(integratorLogin: { _info?: {}; activityApiFlag?: null | boolean; activityCallbackUrl?: string; activityLegacyCallbackFlag?: null | boolean; agreementApiFlag?: null | boolean; agreementCallbackLegacyFlag?: null | boolean; agreementCallbackUrl?: string; board?: { _info?: {}; id?: null | number; name?: string }; canAccessAllApisFlag?: null | boolean; canAccessAllRecordsFlag?: null | boolean; companyApiFlag?: null | boolean; companyCallbackUrl?: string; companyLegacyCallbackFlag?: null | boolean; configurationApiFlag?: null | boolean; configurationAutoChildFlag?: null | boolean; configurationCallbackUrl?: string; configurationChildlingFlag?: null | boolean; configurationLegacyCallbackFlag?: null | boolean; contactApiFlag?: null | boolean; contactCallbackUrl?: string; contactLegacyCallbackFlag?: null | boolean; dateInactivated?: string; documentApiFlag?: null | boolean; id?: number; inactivatedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; inactiveFlag?: null | boolean; invoiceApiFlag?: null | boolean; managedServicesApiFlag?: null | boolean; managedServicesAutoChildFlag?: null | boolean; managedServicesChildingFlag?: null | boolean; marketingApiFlag?: null | boolean; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memberApiFlag?: null | boolean; opportunityApiFlag?: null | boolean; opportunityCallbackUrl?: string; opportunityConversionApiFlag?: null | boolean; opportunityLegacyCallbackFlag?: null | boolean; password?: string; productApiFlag?: null | boolean; productCallbackUrl?: string; productLegacyCallbackFlag?: null | boolean; projectApiFlag?: null | boolean; projectCallbackUrl?: string; projectLegacyCallbackFlag?: null | boolean; purchasingApiFlag?: null | boolean; purchasingCallbackUrl?: string; purchasingLegacyCallbackFlag?: null | boolean; reportingApiFlag?: null | boolean; scheduleApiFlag?: null | boolean; scheduleCallbackUrl?: string; scheduleLegacyCallbackFlag?: null | boolean; serviceBoardCallbackUrl?: string; serviceBoardLegacyCallbackFlag?: null | boolean; serviceTicketApiFlag?: null | boolean; systemApiFlag?: null | boolean; timeEntryApiFlag?: null | boolean; timeEntryCallbackUrl?: string; timeEntryLegacyCallbackFlag?: null | boolean; username: string }): Promise<{ _info?: {}; activityApiFlag?: null | boolean; activityCallbackUrl?: string; activityLegacyCallbackFlag?: null | boolean; agreementApiFlag?: null | boolean; agreementCallbackLegacyFlag?: null | boolean; agreementCallbackUrl?: string; board?: { _info?: {}; id?: null | number; name?: string }; canAccessAllApisFlag?: null | boolean; canAccessAllRecordsFlag?: null | boolean; companyApiFlag?: null | boolean; companyCallbackUrl?: string; companyLegacyCallbackFlag?: null | boolean; configurationApiFlag?: null | boolean; configurationAutoChildFlag?: null | boolean; configurationCallbackUrl?: string; configurationChildlingFlag?: null | boolean; configurationLegacyCallbackFlag?: null | boolean; contactApiFlag?: null | boolean; contactCallbackUrl?: string; contactLegacyCallbackFlag?: null | boolean; dateInactivated?: string; documentApiFlag?: null | boolean; id?: number; inactivatedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; inactiveFlag?: null | boolean; invoiceApiFlag?: null | boolean; managedServicesApiFlag?: null | boolean; managedServicesAutoChildFlag?: null | boolean; managedServicesChildingFlag?: null | boolean; marketingApiFlag?: null | boolean; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memberApiFlag?: null | boolean; opportunityApiFlag?: null | boolean; opportunityCallbackUrl?: string; opportunityConversionApiFlag?: null | boolean; opportunityLegacyCallbackFlag?: null | boolean; password?: string; productApiFlag?: null | boolean; productCallbackUrl?: string; productLegacyCallbackFlag?: null | boolean; projectApiFlag?: null | boolean; projectCallbackUrl?: string; projectLegacyCallbackFlag?: null | boolean; purchasingApiFlag?: null | boolean; purchasingCallbackUrl?: string; purchasingLegacyCallbackFlag?: null | boolean; reportingApiFlag?: null | boolean; scheduleApiFlag?: null | boolean; scheduleCallbackUrl?: string; scheduleLegacyCallbackFlag?: null | boolean; serviceBoardCallbackUrl?: string; serviceBoardLegacyCallbackFlag?: null | boolean; serviceTicketApiFlag?: null | boolean; systemApiFlag?: null | boolean; timeEntryApiFlag?: null | boolean; timeEntryCallbackUrl?: string; timeEntryLegacyCallbackFlag?: null | boolean; username: string }>

  • Parameters

    • integratorLogin: { _info?: {}; activityApiFlag?: null | boolean; activityCallbackUrl?: string; activityLegacyCallbackFlag?: null | boolean; agreementApiFlag?: null | boolean; agreementCallbackLegacyFlag?: null | boolean; agreementCallbackUrl?: string; board?: { _info?: {}; id?: null | number; name?: string }; canAccessAllApisFlag?: null | boolean; canAccessAllRecordsFlag?: null | boolean; companyApiFlag?: null | boolean; companyCallbackUrl?: string; companyLegacyCallbackFlag?: null | boolean; configurationApiFlag?: null | boolean; configurationAutoChildFlag?: null | boolean; configurationCallbackUrl?: string; configurationChildlingFlag?: null | boolean; configurationLegacyCallbackFlag?: null | boolean; contactApiFlag?: null | boolean; contactCallbackUrl?: string; contactLegacyCallbackFlag?: null | boolean; dateInactivated?: string; documentApiFlag?: null | boolean; id?: number; inactivatedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; inactiveFlag?: null | boolean; invoiceApiFlag?: null | boolean; managedServicesApiFlag?: null | boolean; managedServicesAutoChildFlag?: null | boolean; managedServicesChildingFlag?: null | boolean; marketingApiFlag?: null | boolean; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memberApiFlag?: null | boolean; opportunityApiFlag?: null | boolean; opportunityCallbackUrl?: string; opportunityConversionApiFlag?: null | boolean; opportunityLegacyCallbackFlag?: null | boolean; password?: string; productApiFlag?: null | boolean; productCallbackUrl?: string; productLegacyCallbackFlag?: null | boolean; projectApiFlag?: null | boolean; projectCallbackUrl?: string; projectLegacyCallbackFlag?: null | boolean; purchasingApiFlag?: null | boolean; purchasingCallbackUrl?: string; purchasingLegacyCallbackFlag?: null | boolean; reportingApiFlag?: null | boolean; scheduleApiFlag?: null | boolean; scheduleCallbackUrl?: string; scheduleLegacyCallbackFlag?: null | boolean; serviceBoardCallbackUrl?: string; serviceBoardLegacyCallbackFlag?: null | boolean; serviceTicketApiFlag?: null | boolean; systemApiFlag?: null | boolean; timeEntryApiFlag?: null | boolean; timeEntryCallbackUrl?: string; timeEntryLegacyCallbackFlag?: null | boolean; username: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional activityApiFlag?: null | boolean
      • Optional activityCallbackUrl?: string
        description

        Max length: 1000;

      • Optional activityLegacyCallbackFlag?: null | boolean
      • Optional agreementApiFlag?: null | boolean
      • Optional agreementCallbackLegacyFlag?: null | boolean
      • Optional agreementCallbackUrl?: string
        description

        Max length: 1000;

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

          Format: int32

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

        Setting this flag to true will create an integrator that can access all of the available apis in the system. If this field is set to true, both the member and board fields are required.

      • Optional canAccessAllRecordsFlag?: null | boolean
        description

        This flag controls whether the integrator can access only the db records it created, or all system records

      • Optional companyApiFlag?: null | boolean
      • Optional companyCallbackUrl?: string
        description

        Max length: 1000;

      • Optional companyLegacyCallbackFlag?: null | boolean
      • Optional configurationApiFlag?: null | boolean
      • Optional configurationAutoChildFlag?: null | boolean
      • Optional configurationCallbackUrl?: string
        description

        Max length: 1000;

      • Optional configurationChildlingFlag?: null | boolean
        description

        True if integrator is allowed to child configurations

      • Optional configurationLegacyCallbackFlag?: null | boolean
      • Optional contactApiFlag?: null | boolean
      • Optional contactCallbackUrl?: string
        description

        Max length: 1000;

      • Optional contactLegacyCallbackFlag?: null | boolean
      • Optional dateInactivated?: string

        Format: date-time

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

        Format: int32

      • Optional inactivatedBy?: { _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 inactiveFlag?: null | boolean
      • Optional invoiceApiFlag?: null | boolean
      • Optional managedServicesApiFlag?: null | boolean
      • Optional managedServicesAutoChildFlag?: null | boolean
      • Optional managedServicesChildingFlag?: null | boolean
        description

        True if integrator is allowed to child configurations

      • Optional marketingApiFlag?: null | boolean
      • 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 memberApiFlag?: null | boolean
      • Optional opportunityApiFlag?: null | boolean
      • Optional opportunityCallbackUrl?: string
        description

        Max length: 1000;

      • Optional opportunityConversionApiFlag?: null | boolean
        description

        True if the member has access to the Opportunity Conversion Api

      • Optional opportunityLegacyCallbackFlag?: null | boolean
      • Optional password?: string
        description

        The password will never be returned in response Max length: 50;

      • Optional productApiFlag?: null | boolean
      • Optional productCallbackUrl?: string
        description

        Max length: 1000;

      • Optional productLegacyCallbackFlag?: null | boolean
      • Optional projectApiFlag?: null | boolean
      • Optional projectCallbackUrl?: string
        description

        Max length: 1000;

      • Optional projectLegacyCallbackFlag?: null | boolean
      • Optional purchasingApiFlag?: null | boolean
      • Optional purchasingCallbackUrl?: string
        description

        Max length: 1000;

      • Optional purchasingLegacyCallbackFlag?: null | boolean
      • Optional reportingApiFlag?: null | boolean
      • Optional scheduleApiFlag?: null | boolean
      • Optional scheduleCallbackUrl?: string
        description

        Max length: 1000;

      • Optional scheduleLegacyCallbackFlag?: null | boolean
      • Optional serviceBoardCallbackUrl?: string
        description

        Max length: 1000;

      • Optional serviceBoardLegacyCallbackFlag?: null | boolean
      • Optional serviceTicketApiFlag?: null | boolean
      • Optional systemApiFlag?: null | boolean
      • Optional timeEntryApiFlag?: null | boolean
      • Optional timeEntryCallbackUrl?: string
        description

        Max length: 1000;

      • Optional timeEntryLegacyCallbackFlag?: null | boolean
      • username: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; activityApiFlag?: null | boolean; activityCallbackUrl?: string; activityLegacyCallbackFlag?: null | boolean; agreementApiFlag?: null | boolean; agreementCallbackLegacyFlag?: null | boolean; agreementCallbackUrl?: string; board?: { _info?: {}; id?: null | number; name?: string }; canAccessAllApisFlag?: null | boolean; canAccessAllRecordsFlag?: null | boolean; companyApiFlag?: null | boolean; companyCallbackUrl?: string; companyLegacyCallbackFlag?: null | boolean; configurationApiFlag?: null | boolean; configurationAutoChildFlag?: null | boolean; configurationCallbackUrl?: string; configurationChildlingFlag?: null | boolean; configurationLegacyCallbackFlag?: null | boolean; contactApiFlag?: null | boolean; contactCallbackUrl?: string; contactLegacyCallbackFlag?: null | boolean; dateInactivated?: string; documentApiFlag?: null | boolean; id?: number; inactivatedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; inactiveFlag?: null | boolean; invoiceApiFlag?: null | boolean; managedServicesApiFlag?: null | boolean; managedServicesAutoChildFlag?: null | boolean; managedServicesChildingFlag?: null | boolean; marketingApiFlag?: null | boolean; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memberApiFlag?: null | boolean; opportunityApiFlag?: null | boolean; opportunityCallbackUrl?: string; opportunityConversionApiFlag?: null | boolean; opportunityLegacyCallbackFlag?: null | boolean; password?: string; productApiFlag?: null | boolean; productCallbackUrl?: string; productLegacyCallbackFlag?: null | boolean; projectApiFlag?: null | boolean; projectCallbackUrl?: string; projectLegacyCallbackFlag?: null | boolean; purchasingApiFlag?: null | boolean; purchasingCallbackUrl?: string; purchasingLegacyCallbackFlag?: null | boolean; reportingApiFlag?: null | boolean; scheduleApiFlag?: null | boolean; scheduleCallbackUrl?: string; scheduleLegacyCallbackFlag?: null | boolean; serviceBoardCallbackUrl?: string; serviceBoardLegacyCallbackFlag?: null | boolean; serviceTicketApiFlag?: null | boolean; systemApiFlag?: null | boolean; timeEntryApiFlag?: null | boolean; timeEntryCallbackUrl?: string; timeEntryLegacyCallbackFlag?: null | boolean; username: string }>

postSystemLdapConfigurations

  • postSystemLdapConfigurations(ldapConfiguration: { _info?: {}; domain: string; id?: number; name: string; server: string }): Promise<{ _info?: {}; domain: string; id?: number; name: string; server: string }>

  • Parameters

    • ldapConfiguration: { _info?: {}; domain: string; id?: number; name: string; server: string }
      • Optional _info?: {}
        • [key: string]: string
      • domain: string
        description

        Domain Name of the server. Max length: 50;

      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 100;

      • server: string
        description

        FQDN of the Server. Max length: 200;

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

postSystemLdapConfigurationsTestLink

  • postSystemLdapConfigurationsTestLink(server: { server?: string } & { Server: unknown }): Promise<{ message?: string; success?: boolean }>

  • Parameters

    • server: { server?: string } & { Server: unknown }

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

postSystemLinks

  • postSystemLinks(link: { _info?: {}; id?: number; name: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service"; tableReferenceId?: null | number; url?: string }): Promise<{ _info?: {}; id?: number; name: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service"; tableReferenceId?: null | number; url?: string }>

  • Parameters

    • link: { _info?: {}; id?: number; name: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service"; tableReferenceId?: null | number; url?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 50;

      • Optional screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service"
      • Optional tableReferenceId?: null | number

        Format: int32

      • Optional url?: string
        description

        Max length: 1000;

    Returns Promise<{ _info?: {}; id?: number; name: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service"; tableReferenceId?: null | number; url?: string }>

postSystemLocations

  • postSystemLocations(location: { _info?: {}; calendar?: { _info?: {}; id?: null | number; name?: string }; clientFlag?: null | boolean; departmentIds?: number[]; id?: number; locationFlag?: null | boolean; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; overrideAddressLine1?: string; overrideAddressLine2?: string; overrideCity?: string; overrideCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; overrideFaxNumber?: string; overridePhoneNumber?: string; overrideState?: string; overrideZip?: string; owaUrl?: string; ownerLevelId?: null | number; payrollXref?: string; reportsTo?: { _info?: {}; id?: null | number; name?: string }; salesRep?: string; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; workRoleIds?: number[] }): Promise<{ _info?: {}; calendar?: { _info?: {}; id?: null | number; name?: string }; clientFlag?: null | boolean; departmentIds?: number[]; id?: number; locationFlag?: null | boolean; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; overrideAddressLine1?: string; overrideAddressLine2?: string; overrideCity?: string; overrideCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; overrideFaxNumber?: string; overridePhoneNumber?: string; overrideState?: string; overrideZip?: string; owaUrl?: string; ownerLevelId?: null | number; payrollXref?: string; reportsTo?: { _info?: {}; id?: null | number; name?: string }; salesRep?: string; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; workRoleIds?: number[] }>

  • Parameters

    • location: { _info?: {}; calendar?: { _info?: {}; id?: null | number; name?: string }; clientFlag?: null | boolean; departmentIds?: number[]; id?: number; locationFlag?: null | boolean; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; overrideAddressLine1?: string; overrideAddressLine2?: string; overrideCity?: string; overrideCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; overrideFaxNumber?: string; overridePhoneNumber?: string; overrideState?: string; overrideZip?: string; owaUrl?: string; ownerLevelId?: null | number; payrollXref?: string; reportsTo?: { _info?: {}; id?: null | number; name?: string }; salesRep?: string; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; workRoleIds?: number[] }
      • Optional _info?: {}
        • [key: string]: string
      • Optional calendar?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional clientFlag?: null | boolean
      • Optional departmentIds?: number[]
      • Optional id?: number

        Format: int32

      • Optional locationFlag?: null | boolean
      • Optional manager?: { _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
      • name: string
        description

        Max length: 50;

      • Optional overrideAddressLine1?: string
        description

        Max length: 50;

      • Optional overrideAddressLine2?: string
        description

        Max length: 50;

      • Optional overrideCity?: string
        description

        Max length: 50;

      • Optional overrideCountry?: { _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 overrideFaxNumber?: string
        description

        Max length: 15;

      • Optional overridePhoneNumber?: string
        description

        Max length: 15;

      • Optional overrideState?: string
        description

        Max length: 50;

      • Optional overrideZip?: string
        description

        Max length: 12;

      • Optional owaUrl?: string
        description

        Max length: 100;

      • Optional ownerLevelId?: null | number

        Format: int32

      • Optional payrollXref?: string
        description

        Max length: 10;

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

          Format: int32

        • Optional name?: string
      • Optional salesRep?: string
        description

        Max length: 50;

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

          Format: int32

        • 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 workRoleIds?: number[]

    Returns Promise<{ _info?: {}; calendar?: { _info?: {}; id?: null | number; name?: string }; clientFlag?: null | boolean; departmentIds?: number[]; id?: number; locationFlag?: null | boolean; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; overrideAddressLine1?: string; overrideAddressLine2?: string; overrideCity?: string; overrideCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; overrideFaxNumber?: string; overridePhoneNumber?: string; overrideState?: string; overrideZip?: string; owaUrl?: string; ownerLevelId?: null | number; payrollXref?: string; reportsTo?: { _info?: {}; id?: null | number; name?: string }; salesRep?: string; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; workRoleIds?: number[] }>

postSystemManagementNetworkSecurities

  • postSystemManagementNetworkSecurities(managementNetworkSecurity: { _info?: {}; id?: number; name: string; password?: string; site: string; username?: string }): Promise<{ _info?: {}; id?: number; name: string; password?: string; site: string; username?: string }>

  • Parameters

    • managementNetworkSecurity: { _info?: {}; id?: number; name: string; password?: string; site: string; username?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 30;

      • Optional password?: string
        description

        Max length: 50;

      • site: string
        description

        Max length: 100;

      • Optional username?: string
        description

        Max length: 50;

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

postSystemMarketplaceimportImport

  • postSystemMarketplaceimportImport(marketplaceImport: { id?: number; marketplaceImportType?: "Products" | "Agreements" | "Configurations" | "CRMSurveys" | "CustomReports" | "CustomerPortalTypes" | "HTMLEmailTemplates" | "ProjectBoards" | "ProjectTemplates" | "ReportWriterReports" | "ServiceBoards" | "TicketTemplates" | "Views"; marketplaceObject?: unknown[]; requiredFields?: string[] }): Promise<{ id?: number; marketplaceImportType?: "Products" | "Agreements" | "Configurations" | "CRMSurveys" | "CustomReports" | "CustomerPortalTypes" | "HTMLEmailTemplates" | "ProjectBoards" | "ProjectTemplates" | "ReportWriterReports" | "ServiceBoards" | "TicketTemplates" | "Views"; marketplaceObject?: unknown[]; requiredFields?: string[] }>

  • Parameters

    • marketplaceImport: { id?: number; marketplaceImportType?: "Products" | "Agreements" | "Configurations" | "CRMSurveys" | "CustomReports" | "CustomerPortalTypes" | "HTMLEmailTemplates" | "ProjectBoards" | "ProjectTemplates" | "ReportWriterReports" | "ServiceBoards" | "TicketTemplates" | "Views"; marketplaceObject?: unknown[]; requiredFields?: string[] }
      • Optional id?: number

        Format: int32

      • Optional marketplaceImportType?: "Products" | "Agreements" | "Configurations" | "CRMSurveys" | "CustomReports" | "CustomerPortalTypes" | "HTMLEmailTemplates" | "ProjectBoards" | "ProjectTemplates" | "ReportWriterReports" | "ServiceBoards" | "TicketTemplates" | "Views"
      • Optional marketplaceObject?: unknown[]
      • Optional requiredFields?: string[]

    Returns Promise<{ id?: number; marketplaceImportType?: "Products" | "Agreements" | "Configurations" | "CRMSurveys" | "CustomReports" | "CustomerPortalTypes" | "HTMLEmailTemplates" | "ProjectBoards" | "ProjectTemplates" | "ReportWriterReports" | "ServiceBoards" | "TicketTemplates" | "Views"; marketplaceObject?: unknown[]; requiredFields?: string[] }>

postSystemMembers

  • postSystemMembers(member: { _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • member: { _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional adminFlag?: null | boolean
      • agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"
      • Optional allowExpensesEnteredAgainstCompaniesFlag?: null | boolean
      • Optional allowInCellEntryOnTimeSheet?: null | boolean
      • Optional authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"
      • Optional autoPopupQuickNotesWithStopwatch?: null | boolean
      • Optional autoStartStopwatch?: null | boolean
      • Optional billableForecast?: null | number

        Format: double

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

          Format: int32

        • Optional name?: string
      • Optional calendarSyncIntegrationFlag?: null | boolean
      • Optional clientId?: string
      • companyActivityTabFormat: null | "SummaryList" | "DetailList"
      • Optional copyColumnLayoutsAndFilters?: boolean
      • Optional copyPodLayouts?: boolean
      • Optional copySharedDefaultViews?: boolean
      • 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 dailyCapacity?: null | number

        Format: double

      • Optional daysTolerance?: null | number

        Format: int32

      • 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
      • defaultEmail: null | "Mobile" | "Office" | "Home"
      • Optional defaultLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • defaultPhone: null | "Mobile" | "Office" | "Home"
      • Optional disableOnlineFlag?: null | boolean
      • Optional employeeIdentifer?: string
        description

        Max length: 10;

      • Optional enableLdapAuthenticationFlag?: null | boolean
      • Optional enableMobileFlag?: null | boolean
      • Optional enableMobileGpsFlag?: null | boolean
      • Optional enterTimeAgainstCompanyFlag?: null | boolean
      • Optional excludedProjectBoardIds?: number[]
      • Optional excludedServiceBoardIds?: number[]
      • Optional expenseApprover?: { _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
      • firstName: string
        description

        Max length: 30;

      • Optional fromMemberRecId?: number

        Format: int32

      • Optional globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"
      • Optional globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"
      • Optional hideMemberInDispatchPortalFlag?: null | boolean
      • hireDate: string

        Format: date-time

      • Optional homeEmail?: string
        description

        Max length: 250;

      • Optional homeExtension?: string
        description

        Max length: 10;

      • Optional homePhone?: string
        description

        Max length: 15;

      • Optional hourlyCost?: null | number

        Format: double

      • Optional hourlyRate?: null | number

        Format: double

      • Optional id?: number

        Format: int32

      • identifier: string
        description

        Max length: 15;

      • Optional inactiveDate?: string

        Format: date-time

      • Optional inactiveFlag?: null | boolean
      • Optional includeInUtilizationReportingFlag?: null | boolean
      • invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"
      • invoiceTimeTabFormat: null | "SummaryList" | "DetailList"
      • invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"
      • Optional lastLogin?: string
      • lastName: string
        description

        Max length: 30;

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

          Format: int32

        • Optional name?: string
        • Optional server?: string
      • Optional ldapUserName?: string
        description

        Max length: 50;

      • licenseClass: null | "A" | "C" | "F" | "X"
        description

        F = Full Member, A = API Member, C = StreamlineIT Member, X = Subcontractor Member

      • Optional mapiName?: string
      • Optional memberPersonas?: number[]
      • Optional middleInitial?: string
        description

        Max length: 1;

      • Optional minimumHours?: null | number

        Format: double

      • Optional mobileEmail?: string
        description

        Max length: 250;

      • Optional mobileExtension?: string
        description

        Max length: 10;

      • Optional mobilePhone?: string
        description

        Max length: 15;

      • Optional notes?: string
      • Optional office365?: { id?: string; name?: string }
        • Optional id?: string
        • Optional name?: string
      • Optional officeEmail?: string
        description

        Max length: 250;

      • Optional officeExtension?: string
        description

        Max length: 10;

      • Optional officePhone?: string
        description

        Max length: 15;

      • Optional partnerPortalFlag?: null | boolean
      • Optional password?: string
        description

        ConditionallyRequired. API Member will get random password generated Max length: 60;

      • Optional phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"
      • Optional phoneSource?: string
      • Optional photo?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional primaryEmail?: string
        description

        Max length: 250;

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

          Format: int32

        • Optional name?: string
      • Optional projectDefaultDepartment?: { _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 projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional reportsTo?: { _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 requireExpenseEntryFlag?: null | boolean
      • Optional requireStartAndEndTimeOnTimeEntryFlag?: null | boolean
      • Optional requireTimeSheetEntryFlag?: null | boolean
      • Optional restrictDefaultSalesTerritoryFlag?: null | boolean
      • Optional restrictDefaultWarehouseBinFlag?: null | boolean
      • Optional restrictDefaultWarehouseFlag?: null | boolean
      • Optional restrictDepartmentFlag?: null | boolean
      • Optional restrictLocationFlag?: null | boolean
      • Optional restrictProjectDefaultDepartmentFlag?: null | boolean
      • Optional restrictProjectDefaultLocationFlag?: null | boolean
      • Optional restrictScheduleFlag?: null | boolean
      • Optional restrictServiceDefaultDepartmentFlag?: null | boolean
      • Optional restrictServiceDefaultLocationFlag?: null | boolean
      • Optional salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

        Format: double

      • Optional scheduleDefaultDepartment?: { _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 scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional serviceDefaultDepartment?: { _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 serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional signature?: string
      • Optional ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional email?: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional stsUserAdminUrl?: string
      • Optional timeApprover?: { _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 timeReminderEmailFlag?: null | boolean
      • Optional timeSheetStartDate?: string

        Format: date-time

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

          Format: int32

        • Optional name?: string
      • Optional timebasedOneTimePasswordActivated?: null | boolean
      • Optional title?: string
        description

        Max length: 50;

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

          Format: int32

        • Optional name?: string
      • Optional useBrowserLanguageFlag?: null | boolean
      • Optional vendorNumber?: string
      • Optional warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

postSystemMembersByIdDeactivate

  • postSystemMembersByIdDeactivate(id: number, item: { activity?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; companyTeam?: { count?: number; id?: number; name?: string; reAssignToContact?: { _info?: {}; id?: null | number; name?: string }; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]; deleteOpenTimeSheetsFlag?: null | boolean; departmentManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; dispatchMember?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; dutyManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; knowledgeBaseArticle?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyCOO?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyController?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyDispatch?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyDutyManagerRole?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyPresident?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyServiceManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; opportunity?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; projectExpenseApprover?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; projectManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; projectTimeApprover?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; salesTeam?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; sendFromEmailNotify?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; serviceManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; serviceStatusWorkflow?: { count?: number; id?: number; name?: string; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]; serviceTeam?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; ticketTemplate?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; workflowEmail?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } } }): Promise<{ activity?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; companyTeam?: { count?: number; id?: number; name?: string; reAssignToContact?: { _info?: {}; id?: null | number; name?: string }; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]; deleteOpenTimeSheetsFlag?: null | boolean; departmentManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; dispatchMember?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; dutyManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; knowledgeBaseArticle?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyCOO?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyController?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyDispatch?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyDutyManagerRole?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyPresident?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyServiceManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; opportunity?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; projectExpenseApprover?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; projectManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; projectTimeApprover?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; salesTeam?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; sendFromEmailNotify?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; serviceManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; serviceStatusWorkflow?: { count?: number; id?: number; name?: string; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]; serviceTeam?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; ticketTemplate?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; workflowEmail?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } } }>

  • Parameters

    • id: number
    • item: { activity?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; companyTeam?: { count?: number; id?: number; name?: string; reAssignToContact?: { _info?: {}; id?: null | number; name?: string }; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]; deleteOpenTimeSheetsFlag?: null | boolean; departmentManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; dispatchMember?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; dutyManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; knowledgeBaseArticle?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyCOO?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyController?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyDispatch?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyDutyManagerRole?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyPresident?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyServiceManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; opportunity?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; projectExpenseApprover?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; projectManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; projectTimeApprover?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; salesTeam?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; sendFromEmailNotify?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; serviceManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; serviceStatusWorkflow?: { count?: number; id?: number; name?: string; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]; serviceTeam?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; ticketTemplate?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; workflowEmail?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } } }
      • Optional activity?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 companyTeam?: { count?: number; id?: number; name?: string; reAssignToContact?: { _info?: {}; id?: null | number; name?: string }; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]
        description

        A list of customers for which the member holds a team role

      • Optional deleteOpenTimeSheetsFlag?: null | boolean
        description

        By default, this is set to false If there is any open timesheets, system will return error message that there is open timesheets still attached to this member If user would like to delete member with open timesheets, they can set this boolean to TRUE System will delete member and any associated open timesheets

      • Optional departmentManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 dispatchMember?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 dutyManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 knowledgeBaseArticle?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 myCompanyCOO?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 myCompanyController?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 myCompanyDispatch?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 myCompanyDutyManagerRole?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 myCompanyPresident?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 myCompanyServiceManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 opportunity?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 projectExpenseApprover?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 projectManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 projectTimeApprover?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 salesTeam?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 sendFromEmailNotify?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 serviceManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 serviceStatusWorkflow?: { count?: number; id?: number; name?: string; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]
      • Optional serviceTeam?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 ticketTemplate?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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 workflowEmail?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
        • Optional count?: number

          Format: int32

        • Optional reAssignToMember?: { _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<{ activity?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; companyTeam?: { count?: number; id?: number; name?: string; reAssignToContact?: { _info?: {}; id?: null | number; name?: string }; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]; deleteOpenTimeSheetsFlag?: null | boolean; departmentManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; dispatchMember?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; dutyManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; knowledgeBaseArticle?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyCOO?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyController?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyDispatch?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyDutyManagerRole?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyPresident?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; myCompanyServiceManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; opportunity?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; projectExpenseApprover?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; projectManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; projectTimeApprover?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; salesTeam?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; sendFromEmailNotify?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; serviceManager?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; serviceStatusWorkflow?: { count?: number; id?: number; name?: string; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]; serviceTeam?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; ticketTemplate?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }; workflowEmail?: { count?: number; reAssignToMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string } } }>

postSystemMembersByIdLinkSsoUser

  • postSystemMembersByIdLinkSsoUser(id: number, item: { ssoUserId?: string }): Promise<{ message?: string; success?: boolean }>

  • Parameters

    • id: number
    • item: { ssoUserId?: string }
      • Optional ssoUserId?: string
        description

        Max length: 100;

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

postSystemMembersByIdSubmit

  • postSystemMembersByIdSubmit(id: number, item: { token?: string }): Promise<{ message?: string; success?: boolean }>

  • Parameters

    • id: number
    • item: { token?: string }
      • Optional token?: string

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

postSystemMembersByIdUnlinkSsoUser

  • postSystemMembersByIdUnlinkSsoUser(id: number): Promise<{ message?: string; success?: boolean }>

postSystemMembersByMemberIdentifierTokens

  • postSystemMembersByMemberIdentifierTokens(memberIdentifier: string): Promise<{ expiration?: string; privateKey?: string; publicKey?: string }>

  • Parameters

    • memberIdentifier: string

    Returns Promise<{ expiration?: string; privateKey?: string; publicKey?: string }>

postSystemMembersByParentIdAccruals

  • postSystemMembersByParentIdAccruals(parentId: number, memberAccrual: { _info?: {}; accrualType: null | "Holiday" | "PTO" | "Sick" | "Vacation"; hours: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; reason: string; year: null | number }): Promise<{ _info?: {}; accrualType: null | "Holiday" | "PTO" | "Sick" | "Vacation"; hours: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; reason: string; year: null | number }>

  • Parameters

    • parentId: number
    • memberAccrual: { _info?: {}; accrualType: null | "Holiday" | "PTO" | "Sick" | "Vacation"; hours: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; reason: string; year: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • accrualType: null | "Holiday" | "PTO" | "Sick" | "Vacation"
      • hours: null | number

        Format: double

      • 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
      • reason: string
      • year: null | number

        Format: int32

    Returns Promise<{ _info?: {}; accrualType: null | "Holiday" | "PTO" | "Sick" | "Vacation"; hours: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; reason: string; year: null | number }>

postSystemMembersByParentIdCertifications

  • postSystemMembersByParentIdCertifications(parentId: number, memberCertification: { _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }): Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }>

  • Parameters

    • parentId: number
    • memberCertification: { _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • certification: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional certificationNumber?: 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 dateExpires?: string

        Format: date-time

      • Optional dateReceived?: string

        Format: date-time

      • 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 notes?: string
      • Optional percentComplete?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }>

postSystemMembersByParentIdDelegations

  • postSystemMembersByParentIdDelegations(parentId: number, memberDelegation: { _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • parentId: number
    • memberDelegation: { _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • dateEnd: string

        Format: date-time

      • dateStart: string

        Format: date-time

      • Optional delegatedTo?: { _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
      • delegationType: null | "Project" | "Approval"
      • 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

    Returns Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

postSystemMembersByParentIdMycertifications

  • postSystemMembersByParentIdMycertifications(parentId: number, memberCertification: { _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }): Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }>

  • Parameters

    • parentId: number
    • memberCertification: { _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • certification: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional certificationNumber?: 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 dateExpires?: string

        Format: date-time

      • Optional dateReceived?: string

        Format: date-time

      • 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 notes?: string
      • Optional percentComplete?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }>

postSystemMembersByParentIdNotificationSettings

  • postSystemMembersByParentIdNotificationSettings(parentId: number, memberNotificationSetting: { _info?: {}; id?: number; notificationTrigger: null | "ExpenseReport" | "ActivityStatusReq" | "CustomerUpdated" | "TicketStatusChange" | "TicketStatusRequest" | "TimeNagApprover" | "TimeNagMember" | "TimeSheet" | "WorkflowRules"; notificationType: null | "Email" | "Push" }): Promise<{ _info?: {}; id?: number; notificationTrigger: null | "ExpenseReport" | "ActivityStatusReq" | "CustomerUpdated" | "TicketStatusChange" | "TicketStatusRequest" | "TimeNagApprover" | "TimeNagMember" | "TimeSheet" | "WorkflowRules"; notificationType: null | "Email" | "Push" }>

  • Parameters

    • parentId: number
    • memberNotificationSetting: { _info?: {}; id?: number; notificationTrigger: null | "ExpenseReport" | "ActivityStatusReq" | "CustomerUpdated" | "TicketStatusChange" | "TicketStatusRequest" | "TimeNagApprover" | "TimeNagMember" | "TimeSheet" | "WorkflowRules"; notificationType: null | "Email" | "Push" }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • notificationTrigger: null | "ExpenseReport" | "ActivityStatusReq" | "CustomerUpdated" | "TicketStatusChange" | "TicketStatusRequest" | "TimeNagApprover" | "TimeNagMember" | "TimeSheet" | "WorkflowRules"
      • notificationType: null | "Email" | "Push"

    Returns Promise<{ _info?: {}; id?: number; notificationTrigger: null | "ExpenseReport" | "ActivityStatusReq" | "CustomerUpdated" | "TicketStatusChange" | "TicketStatusRequest" | "TimeNagApprover" | "TimeNagMember" | "TimeSheet" | "WorkflowRules"; notificationType: null | "Email" | "Push" }>

postSystemMembersByParentIdSkills

  • postSystemMembersByParentIdSkills(parentId: number, memberSkill: { _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }): Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }>

  • Parameters

    • parentId: number
    • memberSkill: { _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional certifiedFlag?: 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 notes?: string
      • skill: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"
      • Optional yearsExperience?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }>

postSystemMembersTypes

  • postSystemMembersTypes(type: { _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string }): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string }>

  • Parameters

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

        Format: int32

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

        Max length: 30;

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

postSystemMenuEntriesByParentIdLocations

  • postSystemMenuEntriesByParentIdLocations(parentId: number, menuEntryLocation: { _info?: {}; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; menuEntry?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; menuEntry?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • menuEntryLocation: { _info?: {}; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; menuEntry?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: 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 menuEntry?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

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

postSystemMenuentries

  • postSystemMenuentries(menuEntry: { _info?: {}; addAllLocations?: null | boolean; caption: string; clientId?: string; id?: number; largeMenuIconId?: null | number; link: string; locationIds?: number[]; menuLocation?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag: null | boolean; origin?: string; removeAllLocations?: null | boolean; smallMenuIconId?: null | number }): Promise<{ _info?: {}; addAllLocations?: null | boolean; caption: string; clientId?: string; id?: number; largeMenuIconId?: null | number; link: string; locationIds?: number[]; menuLocation?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag: null | boolean; origin?: string; removeAllLocations?: null | boolean; smallMenuIconId?: null | number }>

  • Parameters

    • menuEntry: { _info?: {}; addAllLocations?: null | boolean; caption: string; clientId?: string; id?: number; largeMenuIconId?: null | number; link: string; locationIds?: number[]; menuLocation?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag: null | boolean; origin?: string; removeAllLocations?: null | boolean; smallMenuIconId?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addAllLocations?: null | boolean
      • caption: string
        description

        Max length: 50;

      • Optional clientId?: string
        description

        Only required if not already set Max length: 36;

      • Optional id?: number

        Format: int32

      • Optional largeMenuIconId?: null | number

        Format: int32

      • link: string
        description

        Max length: 2000;

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

          Format: int32

        • Optional name?: string
      • newWindowFlag: null | boolean
      • Optional origin?: string
        description

        Max length: 2000;

      • Optional removeAllLocations?: null | boolean
      • Optional smallMenuIconId?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; addAllLocations?: null | boolean; caption: string; clientId?: string; id?: number; largeMenuIconId?: null | number; link: string; locationIds?: number[]; menuLocation?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag: null | boolean; origin?: string; removeAllLocations?: null | boolean; smallMenuIconId?: null | number }>

postSystemMenuentriesByIdImage

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

postSystemMyAccountByParentIdDelegations

  • postSystemMyAccountByParentIdDelegations(parentId: number, memberDelegation: { _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • parentId: number
    • memberDelegation: { _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • dateEnd: string

        Format: date-time

      • dateStart: string

        Format: date-time

      • Optional delegatedTo?: { _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
      • delegationType: null | "Project" | "Approval"
      • 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

    Returns Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

postSystemMyAccountByParentIdSkills

  • postSystemMyAccountByParentIdSkills(parentId: number, memberSkill: { _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }): Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }>

  • Parameters

    • parentId: number
    • memberSkill: { _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional certifiedFlag?: 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 notes?: string
      • skill: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"
      • Optional yearsExperience?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }>

postSystemMycompanyReportingServicesByIdTestConnection

  • postSystemMycompanyReportingServicesByIdTestConnection(id: number): Promise<{ message?: string; success?: boolean }>

postSystemOffice365EmailSetups

  • postSystemOffice365EmailSetups(entity: { _info?: {}; authorizedFlag?: null | boolean; clientId?: string; clientSecret?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; processedFolder: string; tenantId?: string; username: string }): Promise<{ _info?: {}; authorizedFlag?: null | boolean; clientId?: string; clientSecret?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; processedFolder: string; tenantId?: string; username: string }>

  • Parameters

    • entity: { _info?: {}; authorizedFlag?: null | boolean; clientId?: string; clientSecret?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; processedFolder: string; tenantId?: string; username: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional authorizedFlag?: null | boolean
      • Optional clientId?: string
        description

        Max length: 36;

      • Optional clientSecret?: string
        description

        Max length: 4000;

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

          Format: int32

        • Optional name?: string
      • failedFolder: string
        description

        Max length: 40;

      • Optional id?: number

        Format: int32

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

        Max length: 40;

      • name: string
        description

        Max length: 200;

      • processedFolder: string
        description

        Max length: 40;

      • Optional tenantId?: string
        description

        Max length: 36;

      • username: string
        description

        Max length: 100;

    Returns Promise<{ _info?: {}; authorizedFlag?: null | boolean; clientId?: string; clientSecret?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; processedFolder: string; tenantId?: string; username: string }>

postSystemOffice365EmailSetupsByIdAuthorize

  • postSystemOffice365EmailSetupsByIdAuthorize(id: number): Promise<{ message?: string; success?: boolean }>

postSystemOffice365EmailSetupsByIdTestConnection

  • postSystemOffice365EmailSetupsByIdTestConnection(id: number): Promise<{ message?: string; success?: boolean }>

postSystemPortalReports

  • postSystemPortalReports(portalReport: { _info?: {}; customFlag?: null | boolean; displayFlag?: null | boolean; id?: number; name: string; openSameWindowFlag?: null | boolean; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; url: string }): Promise<{ _info?: {}; customFlag?: null | boolean; displayFlag?: null | boolean; id?: number; name: string; openSameWindowFlag?: null | boolean; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; url: string }>

  • Parameters

    • portalReport: { _info?: {}; customFlag?: null | boolean; displayFlag?: null | boolean; id?: number; name: string; openSameWindowFlag?: null | boolean; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; url: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional customFlag?: null | boolean
      • Optional displayFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 255;

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

          Format: int32

        • Optional name?: string
      • url: string
        description

        Max length: 255;

    Returns Promise<{ _info?: {}; customFlag?: null | boolean; displayFlag?: null | boolean; id?: number; name: string; openSameWindowFlag?: null | boolean; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; url: string }>

postSystemQuoteLinkSetup

  • postSystemQuoteLinkSetup(quoteLink: { _info?: {}; allLocationsFlag?: null | boolean; id?: number; link: string; location?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag?: null | boolean }): Promise<{ _info?: {}; allLocationsFlag?: null | boolean; id?: number; link: string; location?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag?: null | boolean }>

  • Parameters

    • quoteLink: { _info?: {}; allLocationsFlag?: null | boolean; id?: number; link: string; location?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional allLocationsFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • link: string
        description

        Max length: 2000;

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

          Format: int32

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

    Returns Promise<{ _info?: {}; allLocationsFlag?: null | boolean; id?: number; link: string; location?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag?: null | boolean }>

postSystemReportCards

  • postSystemReportCards(reportCard: { _info?: {}; id?: number; name: string }): Promise<{ _info?: {}; id?: number; name: string }>

  • Parameters

    • reportCard: { _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 }>

postSystemReportCardsByParentIdDetails

  • postSystemReportCardsByParentIdDetails(parentId: number, reportCardDetail: { _info?: {}; id?: number; kpi?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; sortOrder?: null | number }): Promise<{ _info?: {}; id?: number; kpi?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; sortOrder?: null | number }>

  • Parameters

    • parentId: number
    • reportCardDetail: { _info?: {}; id?: number; kpi?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; sortOrder?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

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

          Format: int32

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

          Format: int32

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

        Format: int32

    Returns Promise<{ _info?: {}; id?: number; kpi?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; sortOrder?: null | number }>

postSystemSecurityroles

  • postSystemSecurityroles(securityRole: { _info?: {}; adminFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string }): Promise<{ _info?: {}; adminFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string }>

  • Parameters

    • securityRole: { _info?: {}; adminFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional adminFlag?: null | boolean
      • Optional id?: number

        Format: int32

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

        Max length: 30;

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

postSystemSkillCategories

  • postSystemSkillCategories(skillCategory: { _info?: {}; id?: number; name: string }): Promise<{ _info?: {}; id?: number; name: string }>

  • Parameters

    • skillCategory: { _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 }>

postSystemSkills

  • postSystemSkills(skill: { _info?: {}; category?: { _info?: {}; id?: null | number; name?: string }; id?: number; name: string }): Promise<{ _info?: {}; category?: { _info?: {}; id?: null | number; name?: string }; id?: number; name: string }>

  • Parameters

    • skill: { _info?: {}; category?: { _info?: {}; id?: null | number; name?: string }; id?: number; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional category?: { _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

      • name: string
        description

        Max length: 50;

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

postSystemSsoConfigurations

  • postSystemSsoConfigurations(ssoConfiguration: { _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }): Promise<{ _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }>

  • Parameters

    • ssoConfiguration: { _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional allMembersSubmitted?: boolean
      • Optional clientId?: string
        description

        Client identity for this configuration of ConnectWise SSO Max length: 1000;

      • Optional id?: number

        Format: int32

        description

        Unique identifier of the SSO Configuration

      • Optional inactiveFlag?: null | boolean
        description

        Whether the SSO configuration is not active

      • Optional isSsoOnByDefault?: boolean
      • locationIds: number[]
        description

        The locations where the SAML Idp Configuration is used

      • name: string
        description

        Descriptor of the SSO Configuration Max length: 100;

      • Optional samlCertificateIssuedTo?: string
        description

        Who the SAML certificate was issued to. Metadata on SAML_Idp_Certificate

      • Optional samlCertificateName?: string
        description

        Name of the SAML certificate. Metadata on SAML_Idp_Certificate

      • Optional samlCertificateThumbprint?: string
        description

        Thumbprint of the SAML certificate. Metadata on SAML_Idp_Certificate

      • Optional samlCertificateValidFrom?: string

        Format: date-time

        description

        Date when the SAML certificate becomes valid. Metadata on SAML_Idp_Certificate

      • Optional samlCertificateValidTo?: string

        Format: date-time

        description

        Date when the SAML certificate is no longer valid. Metadata on SAML_Idp_Certificate

      • Optional samlEntityId?: string
        description

        SAML Identity Provider Id Max length: 1000;

      • Optional samlIdpCertificate?: string
        description

        Public certificate for Identity Provider signatures

      • Optional samlSignInUrl?: string
        description

        Sign in url for the SAML Identity Provider Max length: 1000;

      • ssoType: null | "CWSSO" | "SAML"
        description

        Type of SSO Configuration

      • Optional stsBaseUrl?: string
        description

        Sign in URL for ConnectWise SSO

      • Optional stsUserAdminUrl?: string
        description

        User Admin Url for ConnectWise SSO

      • Optional submittedMemberCount?: number

        Format: int32

      • Optional token?: string

    Returns Promise<{ _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }>

postSystemSsoConfigurationsByIdRegistertoken

  • postSystemSsoConfigurationsByIdRegistertoken(id: number, ssoConfiguration: { _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }): Promise<{ _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }>

  • Parameters

    • id: number
    • ssoConfiguration: { _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional allMembersSubmitted?: boolean
      • Optional clientId?: string
        description

        Client identity for this configuration of ConnectWise SSO Max length: 1000;

      • Optional id?: number

        Format: int32

        description

        Unique identifier of the SSO Configuration

      • Optional inactiveFlag?: null | boolean
        description

        Whether the SSO configuration is not active

      • Optional isSsoOnByDefault?: boolean
      • locationIds: number[]
        description

        The locations where the SAML Idp Configuration is used

      • name: string
        description

        Descriptor of the SSO Configuration Max length: 100;

      • Optional samlCertificateIssuedTo?: string
        description

        Who the SAML certificate was issued to. Metadata on SAML_Idp_Certificate

      • Optional samlCertificateName?: string
        description

        Name of the SAML certificate. Metadata on SAML_Idp_Certificate

      • Optional samlCertificateThumbprint?: string
        description

        Thumbprint of the SAML certificate. Metadata on SAML_Idp_Certificate

      • Optional samlCertificateValidFrom?: string

        Format: date-time

        description

        Date when the SAML certificate becomes valid. Metadata on SAML_Idp_Certificate

      • Optional samlCertificateValidTo?: string

        Format: date-time

        description

        Date when the SAML certificate is no longer valid. Metadata on SAML_Idp_Certificate

      • Optional samlEntityId?: string
        description

        SAML Identity Provider Id Max length: 1000;

      • Optional samlIdpCertificate?: string
        description

        Public certificate for Identity Provider signatures

      • Optional samlSignInUrl?: string
        description

        Sign in url for the SAML Identity Provider Max length: 1000;

      • ssoType: null | "CWSSO" | "SAML"
        description

        Type of SSO Configuration

      • Optional stsBaseUrl?: string
        description

        Sign in URL for ConnectWise SSO

      • Optional stsUserAdminUrl?: string
        description

        User Admin Url for ConnectWise SSO

      • Optional submittedMemberCount?: number

        Format: int32

      • Optional token?: string

    Returns Promise<{ _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }>

postSystemSsoConfigurationsByIdSubmitmembers

  • postSystemSsoConfigurationsByIdSubmitmembers(id: number, ssoConfiguration: { _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }): Promise<{ _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }>

  • Parameters

    • id: number
    • ssoConfiguration: { _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional allMembersSubmitted?: boolean
      • Optional clientId?: string
        description

        Client identity for this configuration of ConnectWise SSO Max length: 1000;

      • Optional id?: number

        Format: int32

        description

        Unique identifier of the SSO Configuration

      • Optional inactiveFlag?: null | boolean
        description

        Whether the SSO configuration is not active

      • Optional isSsoOnByDefault?: boolean
      • locationIds: number[]
        description

        The locations where the SAML Idp Configuration is used

      • name: string
        description

        Descriptor of the SSO Configuration Max length: 100;

      • Optional samlCertificateIssuedTo?: string
        description

        Who the SAML certificate was issued to. Metadata on SAML_Idp_Certificate

      • Optional samlCertificateName?: string
        description

        Name of the SAML certificate. Metadata on SAML_Idp_Certificate

      • Optional samlCertificateThumbprint?: string
        description

        Thumbprint of the SAML certificate. Metadata on SAML_Idp_Certificate

      • Optional samlCertificateValidFrom?: string

        Format: date-time

        description

        Date when the SAML certificate becomes valid. Metadata on SAML_Idp_Certificate

      • Optional samlCertificateValidTo?: string

        Format: date-time

        description

        Date when the SAML certificate is no longer valid. Metadata on SAML_Idp_Certificate

      • Optional samlEntityId?: string
        description

        SAML Identity Provider Id Max length: 1000;

      • Optional samlIdpCertificate?: string
        description

        Public certificate for Identity Provider signatures

      • Optional samlSignInUrl?: string
        description

        Sign in url for the SAML Identity Provider Max length: 1000;

      • ssoType: null | "CWSSO" | "SAML"
        description

        Type of SSO Configuration

      • Optional stsBaseUrl?: string
        description

        Sign in URL for ConnectWise SSO

      • Optional stsUserAdminUrl?: string
        description

        User Admin Url for ConnectWise SSO

      • Optional submittedMemberCount?: number

        Format: int32

      • Optional token?: string

    Returns Promise<{ _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }>

postSystemStandardNotes

  • postSystemStandardNotes(standardNote: { _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; contents: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string }): Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; contents: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string }>

  • Parameters

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

          Format: int32

        • Optional name?: string
      • contents: 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
      • name: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; contents: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string }>

postSystemSurveys

  • postSystemSurveys(survey: { _info?: {}; id?: number; inactiveFlag?: null | boolean; instructions?: string; name: string }): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; instructions?: string; name: string }>

  • Parameters

    • survey: { _info?: {}; id?: number; inactiveFlag?: null | boolean; instructions?: string; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

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

        Max length: 1000;

      • name: string
        description

        Max length: 50;

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

postSystemSurveysByGrandparentIdQuestionsByParentIdValues

  • postSystemSurveysByGrandparentIdQuestionsByParentIdValues(parentId: number, grandparentId: number, surveyQuestionValue: { _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; pointValue?: null | number; question?: { _info?: {}; id?: null | number; question?: string }; survey?: { _info?: {}; id?: null | number; name?: string }; value: string }): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; pointValue?: null | number; question?: { _info?: {}; id?: null | number; question?: string }; survey?: { _info?: {}; id?: null | number; name?: string }; value: string }>

  • Parameters

    • parentId: number
    • grandparentId: number
    • surveyQuestionValue: { _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; pointValue?: null | number; question?: { _info?: {}; id?: null | number; question?: string }; survey?: { _info?: {}; id?: null | number; name?: string }; value: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional defaultFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • Optional pointValue?: null | number

        Format: int32

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

          Format: int32

        • Optional question?: string
      • Optional survey?: { _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: 1000;

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

postSystemSurveysByIdCopy

  • postSystemSurveysByIdCopy(id: number): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; instructions?: string; name: string }>

  • Parameters

    • id: number

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

postSystemSurveysByParentIdQuestions

  • postSystemSurveysByParentIdQuestions(parentId: number, surveyQuestion: { _info?: {}; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Button" | "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; survey?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Button" | "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; survey?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • surveyQuestion: { _info?: {}; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Button" | "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; survey?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • entryType: null | "Date" | "EntryField" | "List" | "Option"
      • fieldType: null | "TextArea" | "Button" | "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

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

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Button" | "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; survey?: { _info?: {}; id?: null | number; name?: string } }>

postSystemTimeZoneSetups

  • postSystemTimeZoneSetups(timeZoneSetup: { _info?: {}; daylightSavingsFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; name: string; offset?: null | number; timeZone?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; daylightSavingsFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; name: string; offset?: null | number; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • timeZoneSetup: { _info?: {}; daylightSavingsFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; name: string; offset?: null | number; timeZone?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional daylightSavingsFlag?: null | boolean
        description

        Determined based on system library value for specified timeZone. Not able to be used in query params at this time

      • Optional defaultFlag?: null | boolean
        description

        Identifies the default system time zone setup

      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 50;

      • Optional offset?: null | number

        Format: double

        description

        The hours offset from UTC (+/-)

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

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; daylightSavingsFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; name: string; offset?: null | number; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

postSystemTodayPageCategories

  • postSystemTodayPageCategories(todayPageCategory: { _info?: {}; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; sortOrder: null | number }): Promise<{ _info?: {}; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; sortOrder: null | number }>

  • Parameters

    • todayPageCategory: { _info?: {}; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; sortOrder: null | number }
      • Optional _info?: {}
        • [key: string]: 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
      • name: string
        description

        Max length: 30;

      • sortOrder: null | number

        Format: int32

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

postSystemUserDefinedFields

  • postSystemUserDefinedFields(userDefinedField: { _info?: {}; addAllBusinessUnits?: null | boolean; addAllLocations?: null | boolean; businessUnitIds?: number[]; buttonUrl?: string; caption: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId: null | number; readOnlyFlag?: null | boolean; removeAllBusinessUnits?: null | boolean; removeAllLocations?: null | boolean; requiredFlag?: null | boolean; sequenceNumber: null | number }): Promise<{ _info?: {}; addAllBusinessUnits?: null | boolean; addAllLocations?: null | boolean; businessUnitIds?: number[]; buttonUrl?: string; caption: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId: null | number; readOnlyFlag?: null | boolean; removeAllBusinessUnits?: null | boolean; removeAllLocations?: null | boolean; requiredFlag?: null | boolean; sequenceNumber: null | number }>

  • Parameters

    • userDefinedField: { _info?: {}; addAllBusinessUnits?: null | boolean; addAllLocations?: null | boolean; businessUnitIds?: number[]; buttonUrl?: string; caption: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId: null | number; readOnlyFlag?: null | boolean; removeAllBusinessUnits?: null | boolean; removeAllLocations?: null | boolean; requiredFlag?: null | boolean; sequenceNumber: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addAllBusinessUnits?: null | boolean
      • Optional addAllLocations?: null | boolean
      • Optional businessUnitIds?: number[]
      • Optional buttonUrl?: string
        description

        Only available with Button Field Type. Required when entryTypeIdentifier is button Max length: 1000;

      • caption: string
        description

        Field caption Max length: 25;

      • Optional dateCreated?: string

        Format: date-time

        description

        Date in UTC the custom field was created

      • Optional displayOnScreenFlag?: null | boolean
      • Optional entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"
      • fieldTypeIdentifier: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"
      • Optional helpText?: string
        description

        Help text to accompany the custom field Max length: 1000;

      • Optional id?: number

        Format: int32

        description

        ID of the custom user defined field

      • Optional listViewFlag?: null | boolean
        description

        Denotes that this custom field is included on a list view

      • Optional locationIds?: number[]
      • Optional numberDecimals?: null | number

        Format: int32

        description

        Only valid for Number or percent

      • Optional options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]
      • podId: null | number

        Format: int32

        description

        Id of the Pod where the custom field will be placed

      • Optional readOnlyFlag?: null | boolean
      • Optional removeAllBusinessUnits?: null | boolean
      • Optional removeAllLocations?: null | boolean
      • Optional requiredFlag?: null | boolean
      • sequenceNumber: null | number

        Format: int32

        description

        Must be between 1 and 500. This defines the order in which the custom fields will appear

    Returns Promise<{ _info?: {}; addAllBusinessUnits?: null | boolean; addAllLocations?: null | boolean; businessUnitIds?: number[]; buttonUrl?: string; caption: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId: null | number; readOnlyFlag?: null | boolean; removeAllBusinessUnits?: null | boolean; removeAllLocations?: null | boolean; requiredFlag?: null | boolean; sequenceNumber: null | number }>

postSystemWorkflowActionsByParentIdAutomateParameters

  • postSystemWorkflowActionsByParentIdAutomateParameters(parentId: number, workflowActionAutomateParameter: { id?: number; name: string; value?: string }): Promise<{ id?: number; name: string; value?: string }>

  • Parameters

    • parentId: number
    • workflowActionAutomateParameter: { id?: number; name: string; value?: string }
      • Optional id?: number

        Format: int32

      • name: string
      • Optional value?: string

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

postSystemWorkflows

  • postSystemWorkflows(workflow: { _info?: {}; activateFlag?: null | boolean; batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"; batchInterval?: null | number; batchLastRan?: string; batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"; board?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; tableType?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; activateFlag?: null | boolean; batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"; batchInterval?: null | number; batchLastRan?: string; batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"; board?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; tableType?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • workflow: { _info?: {}; activateFlag?: null | boolean; batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"; batchInterval?: null | number; batchLastRan?: string; batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"; board?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; tableType?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional activateFlag?: null | boolean
        description

        Batches can not be turned on until after the workflow is created and it has atleast one event associated with it

      • Optional batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"
        description

        If not specified, defaults to Minutes. Months is not supported as month length varies

      • Optional batchInterval?: null | number

        Format: int32

      • Optional batchLastRan?: string

        Format: date-time

      • Optional batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"
        description

        If activateFlag is true, batchSchedule is required

      • Optional board?: { _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
      • name: string
        description

        Max length: 100;

      • Optional tableType?: { _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?: {}; activateFlag?: null | boolean; batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"; batchInterval?: null | number; batchLastRan?: string; batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"; board?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; tableType?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

postSystemWorkflowsByGrandparentIdEventsByParentIdActions

  • postSystemWorkflowsByGrandparentIdEventsByParentIdActions(parentId: number, grandparentId: number, workflowAction: { _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachConfigurationsFor?: null | "Company" | "Contact"; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; attachments?: number[]; auditNotesFlag?: null | boolean; automateScript?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; board?: { _info?: {}; id?: null | number; name?: string }; boardStatus?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; configurationStatus?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; detailNotesFlag?: null | boolean; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; internalNotesFlag?: null | boolean; invoiceMinDays?: null | number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectStatus?: { _info?: {}; id?: null | number; name?: string }; salesOrderStatus?: { _info?: {}; id?: null | number; name?: string }; scriptFailStatus?: { _info?: {}; id?: null | number; name?: string }; scriptSuccessStatus?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificTeamTo?: { _info?: {}; id?: null | number; isProjectTeamFlag?: boolean; name?: string }; subject?: string; updateOwnerFlag?: null | boolean }): Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachConfigurationsFor?: null | "Company" | "Contact"; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; attachments?: number[]; auditNotesFlag?: null | boolean; automateScript?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; board?: { _info?: {}; id?: null | number; name?: string }; boardStatus?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; configurationStatus?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; detailNotesFlag?: null | boolean; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; internalNotesFlag?: null | boolean; invoiceMinDays?: null | number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectStatus?: { _info?: {}; id?: null | number; name?: string }; salesOrderStatus?: { _info?: {}; id?: null | number; name?: string }; scriptFailStatus?: { _info?: {}; id?: null | number; name?: string }; scriptSuccessStatus?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificTeamTo?: { _info?: {}; id?: null | number; isProjectTeamFlag?: boolean; name?: string }; subject?: string; updateOwnerFlag?: null | boolean }>

  • Parameters

    • parentId: number
    • grandparentId: number
    • workflowAction: { _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachConfigurationsFor?: null | "Company" | "Contact"; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; attachments?: number[]; auditNotesFlag?: null | boolean; automateScript?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; board?: { _info?: {}; id?: null | number; name?: string }; boardStatus?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; configurationStatus?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; detailNotesFlag?: null | boolean; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; internalNotesFlag?: null | boolean; invoiceMinDays?: null | number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectStatus?: { _info?: {}; id?: null | number; name?: string }; salesOrderStatus?: { _info?: {}; id?: null | number; name?: string }; scriptFailStatus?: { _info?: {}; id?: null | number; name?: string }; scriptSuccessStatus?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificTeamTo?: { _info?: {}; id?: null | number; isProjectTeamFlag?: boolean; name?: string }; subject?: string; updateOwnerFlag?: null | boolean }
      • 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 attachConfigurationsFor?: null | "Company" | "Contact"
        description

        Required when notifyType is set to: "Attach Configuration"

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

          Format: int32

        • Optional name?: string
      • Optional attachments?: number[]
      • Optional auditNotesFlag?: null | boolean
      • Optional automateScript?: { _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 board?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional boardStatus?: { _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 configurationStatus?: { _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 daysToExecute?: null | number

        Format: int32

      • Optional detailNotesFlag?: null | boolean
      • Optional emailFrom?: string
        description

        Required when notifyFrom is set to: "Email Address" Max length: 250;

      • Optional emailRecipient?: string
        description

        Required when notifyWho is set to: "Email Address" 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 internalNotesFlag?: null | boolean
      • Optional invoiceMinDays?: null | 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: { _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
      • Optional projectStatus?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

        • 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 serviceType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: 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 specificTeamTo?: { _info?: {}; id?: null | number; isProjectTeamFlag?: boolean; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional isProjectTeamFlag?: boolean
        • Optional name?: string
      • Optional subject?: string
        description

        Required when notifyType is set to: "Create Activity", "Send Email", "Assign Resource" Max length: 100;

      • Optional updateOwnerFlag?: null | boolean

    Returns Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachConfigurationsFor?: null | "Company" | "Contact"; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; attachments?: number[]; auditNotesFlag?: null | boolean; automateScript?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; board?: { _info?: {}; id?: null | number; name?: string }; boardStatus?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; configurationStatus?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; detailNotesFlag?: null | boolean; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; internalNotesFlag?: null | boolean; invoiceMinDays?: null | number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectStatus?: { _info?: {}; id?: null | number; name?: string }; salesOrderStatus?: { _info?: {}; id?: null | number; name?: string }; scriptFailStatus?: { _info?: {}; id?: null | number; name?: string }; scriptSuccessStatus?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificTeamTo?: { _info?: {}; id?: null | number; isProjectTeamFlag?: boolean; name?: string }; subject?: string; updateOwnerFlag?: null | boolean }>

postSystemWorkflowsByIdCopy

  • postSystemWorkflowsByIdCopy(id: number): Promise<{ _info?: {}; activateFlag?: null | boolean; batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"; batchInterval?: null | number; batchLastRan?: string; batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"; board?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; tableType?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • id: number

    Returns Promise<{ _info?: {}; activateFlag?: null | boolean; batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"; batchInterval?: null | number; batchLastRan?: string; batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"; board?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; tableType?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

postSystemWorkflowsByParentIdEvents

  • postSystemWorkflowsByParentIdEvents(parentId: number, workflowEvent: { _info?: {}; eventCondition: string; executionTime?: null | "Once" | "MultipleTimes" | "Continuously"; frequencyOfExecution?: null | number; frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"; id?: number; maxNumberOfExecution?: null | number; name?: string }): Promise<{ _info?: {}; eventCondition: string; executionTime?: null | "Once" | "MultipleTimes" | "Continuously"; frequencyOfExecution?: null | number; frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"; id?: number; maxNumberOfExecution?: null | number; name?: string }>

  • Parameters

    • parentId: number
    • workflowEvent: { _info?: {}; eventCondition: string; executionTime?: null | "Once" | "MultipleTimes" | "Continuously"; frequencyOfExecution?: null | number; frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"; id?: number; maxNumberOfExecution?: null | number; name?: string }
      • Optional _info?: {}
        • [key: string]: string
      • eventCondition: string
      • Optional executionTime?: null | "Once" | "MultipleTimes" | "Continuously"
        description

        Defaults to Once when not specified

      • Optional frequencyOfExecution?: null | number

        Format: int32

        description

        Required when exectionTimes is set to MultipleTimes or Continuously

      • Optional frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"
        description

        Required when exectionTimes is set to MultipleTimes or Continuously

      • Optional id?: number

        Format: int32

      • Optional maxNumberOfExecution?: null | number

        Format: int32

        description

        Required when exectionTimes is set to MultipleTimes

      • Optional name?: string

    Returns Promise<{ _info?: {}; eventCondition: string; executionTime?: null | "Once" | "MultipleTimes" | "Continuously"; frequencyOfExecution?: null | number; frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"; id?: number; maxNumberOfExecution?: null | number; name?: string }>

postSystemWorkflowsByParentIdEventsByIdCopy

  • postSystemWorkflowsByParentIdEventsByIdCopy(id: number, parentId: number): Promise<{ _info?: {}; eventCondition: string; executionTime?: null | "Once" | "MultipleTimes" | "Continuously"; frequencyOfExecution?: null | number; frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"; id?: number; maxNumberOfExecution?: null | number; name?: string }>

  • Parameters

    • id: number
    • parentId: number

    Returns Promise<{ _info?: {}; eventCondition: string; executionTime?: null | "Once" | "MultipleTimes" | "Continuously"; frequencyOfExecution?: null | number; frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"; id?: number; maxNumberOfExecution?: null | number; name?: string }>

postSystemWorkflowsUserdefinedfieldsEventsByGrandparentId

  • postSystemWorkflowsUserdefinedfieldsEventsByGrandparentId(grandparentId: number, workflowActionUserDefinedField: { _info?: {}; actionId?: number; caption?: string; entryTypeId?: string; eventId?: number; fieldTypeId?: string; id?: number; inactiveFlag?: null | boolean; overwriteFlag?: null | boolean; podDescription?: string; requiredFlag?: null | boolean; userDefinedFieldId?: number; value?: string }): Promise<{ _info?: {}; actionId?: number; caption?: string; entryTypeId?: string; eventId?: number; fieldTypeId?: string; id?: number; inactiveFlag?: null | boolean; overwriteFlag?: null | boolean; podDescription?: string; requiredFlag?: null | boolean; userDefinedFieldId?: number; value?: string }>

  • Parameters

    • grandparentId: number
    • workflowActionUserDefinedField: { _info?: {}; actionId?: number; caption?: string; entryTypeId?: string; eventId?: number; fieldTypeId?: string; id?: number; inactiveFlag?: null | boolean; overwriteFlag?: null | boolean; podDescription?: string; requiredFlag?: null | boolean; userDefinedFieldId?: number; value?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional actionId?: number

        Format: int32

      • Optional caption?: string
      • Optional entryTypeId?: string
      • Optional eventId?: number

        Format: int32

      • Optional fieldTypeId?: string
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • Optional overwriteFlag?: null | boolean
      • Optional podDescription?: string
      • Optional requiredFlag?: null | boolean
      • Optional userDefinedFieldId?: number

        Format: int32

      • Optional value?: string

    Returns Promise<{ _info?: {}; actionId?: number; caption?: string; entryTypeId?: string; eventId?: number; fieldTypeId?: string; id?: number; inactiveFlag?: null | boolean; overwriteFlag?: null | boolean; podDescription?: string; requiredFlag?: null | boolean; userDefinedFieldId?: number; value?: string }>

putSystemAllowedfiletypesById

  • putSystemAllowedfiletypesById(id: number, AllowedFileType: { _info?: {}; fileType: string; id?: number; sizeLimit?: null | number }): Promise<{ _info?: {}; fileType: string; id?: number; sizeLimit?: null | number }>

  • Parameters

    • id: number
    • AllowedFileType: { _info?: {}; fileType: string; id?: number; sizeLimit?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • fileType: string
      • Optional id?: number

        Format: int32

      • Optional sizeLimit?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; fileType: string; id?: number; sizeLimit?: null | number }>

putSystemAllowedoriginsById

  • putSystemAllowedoriginsById(id: number, origin: { _info?: {}; description: string; id?: number; lastUpdateUtc?: string; origin: string; updatedBy?: string }): Promise<{ _info?: {}; description: string; id?: number; lastUpdateUtc?: string; origin: string; updatedBy?: string }>

  • Parameters

    • id: number
    • origin: { _info?: {}; description: string; id?: number; lastUpdateUtc?: string; origin: string; updatedBy?: string }
      • Optional _info?: {}
        • [key: string]: string
      • description: string
        description

        Max length: 2000;

      • Optional id?: number

        Format: int32

      • Optional lastUpdateUtc?: string

        Format: date-time

      • origin: string
        description

        Max length: 2000;

      • Optional updatedBy?: string

    Returns Promise<{ _info?: {}; description: string; id?: number; lastUpdateUtc?: string; origin: string; updatedBy?: string }>

putSystemApiMembersById

  • putSystemApiMembersById(id: number, apiMember: { _info?: {}; blockCostFlag?: null | boolean; blockPriceFlag?: null | boolean; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; excludedServiceBoardIds?: number[]; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; name?: string; notes?: string; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; blockCostFlag?: null | boolean; blockPriceFlag?: null | boolean; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; excludedServiceBoardIds?: number[]; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; name?: string; notes?: string; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • apiMember: { _info?: {}; blockCostFlag?: null | boolean; blockPriceFlag?: null | boolean; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; excludedServiceBoardIds?: number[]; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; name?: string; notes?: string; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional blockCostFlag?: null | boolean
      • Optional blockPriceFlag?: null | boolean
      • 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 emailAddress?: string
        description

        Max length: 250;

      • Optional excludedServiceBoardIds?: number[]
      • Optional id?: number

        Format: int32

      • identifier: string
        description

        Max length: 15;

      • Optional inactiveDate?: string

        Format: date-time

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

        Max length: 30; Required On Updates;

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional structureLevel?: { _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

    Returns Promise<{ _info?: {}; blockCostFlag?: null | boolean; blockPriceFlag?: null | boolean; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; excludedServiceBoardIds?: number[]; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; name?: string; notes?: string; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

putSystemAuthAnvilsById

  • putSystemAuthAnvilsById(id: number, authAnvil: { _info?: {}; id?: number; serverLocationUrl: string; siteId: null | number }): Promise<{ _info?: {}; id?: number; serverLocationUrl: string; siteId: null | number }>

  • Parameters

    • id: number
    • authAnvil: { _info?: {}; id?: number; serverLocationUrl: string; siteId: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • serverLocationUrl: string
      • siteId: null | number

        Format: int32

    Returns Promise<{ _info?: {}; id?: number; serverLocationUrl: string; siteId: null | number }>

putSystemAutoSyncTimeById

  • putSystemAutoSyncTimeById(id: number, autoSyncTime: { _info?: {}; id?: number; syncTime: string; timeZone?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; syncTime: string; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

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

        Format: int32

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

          Format: int32

        • Optional name?: string

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

putSystemCallbacksById

  • putSystemCallbacksById(id: number, callbackEntry: { _info?: {}; description?: string; id?: number; inactiveFlag?: null | boolean; isSelfSuppressedFlag?: null | boolean; isSoapCallbackFlag?: null | boolean; level?: string; memberId?: null | number; objectId?: null | number; payloadVersion?: string; type?: string; url?: string }): Promise<{ _info?: {}; description?: string; id?: number; inactiveFlag?: null | boolean; isSelfSuppressedFlag?: null | boolean; isSoapCallbackFlag?: null | boolean; level?: string; memberId?: null | number; objectId?: null | number; payloadVersion?: string; type?: string; url?: string }>

  • Parameters

    • id: number
    • callbackEntry: { _info?: {}; description?: string; id?: number; inactiveFlag?: null | boolean; isSelfSuppressedFlag?: null | boolean; isSoapCallbackFlag?: null | boolean; level?: string; memberId?: null | number; objectId?: null | number; payloadVersion?: string; type?: string; url?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional description?: string
        description

        Max length: 100;

      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • Optional isSelfSuppressedFlag?: null | boolean
      • Optional isSoapCallbackFlag?: null | boolean
      • Optional level?: string
        description

        Required Reference

      • Optional memberId?: null | number

        Format: int32

      • Optional objectId?: null | number

        Format: int32

        description

        Required Reference

      • Optional payloadVersion?: string
      • Optional type?: string
        description

        Required Reference

      • Optional url?: string
        description

        Required Reference

    Returns Promise<{ _info?: {}; description?: string; id?: number; inactiveFlag?: null | boolean; isSelfSuppressedFlag?: null | boolean; isSoapCallbackFlag?: null | boolean; level?: string; memberId?: null | number; objectId?: null | number; payloadVersion?: string; type?: string; url?: string }>

putSystemCertificationsById

  • putSystemCertificationsById(id: number, certification: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; name: string }): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; name: string }>

  • Parameters

    • id: number
    • certification: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: 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

      • name: string
        description

        Max length: 50;

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

putSystemConnectwisehostedsetupsById

  • putSystemConnectwisehostedsetupsById(id: number, connectWiseHostedSetup: { _info?: {}; clientId?: string; createdBy?: string; dateCreated?: string; description: string; disabledFlag?: null | boolean; id?: number; locationIds?: number[]; locationsEnabledFlag?: null | boolean; origin?: string; podHeight?: null | number; screenId: null | number; toolbarButtonDialogHeight?: null | number; toolbarButtonDialogWidth?: null | number; toolbarButtonIconDocumentId?: null | number; toolbarButtonText?: string; toolbarButtonToolTip?: string; type: null | "Tab" | "Pod" | "ToolbarButton"; url: string }): Promise<{ _info?: {}; clientId?: string; createdBy?: string; dateCreated?: string; description: string; disabledFlag?: null | boolean; id?: number; locationIds?: number[]; locationsEnabledFlag?: null | boolean; origin?: string; podHeight?: null | number; screenId: null | number; toolbarButtonDialogHeight?: null | number; toolbarButtonDialogWidth?: null | number; toolbarButtonIconDocumentId?: null | number; toolbarButtonText?: string; toolbarButtonToolTip?: string; type: null | "Tab" | "Pod" | "ToolbarButton"; url: string }>

  • Parameters

    • id: number
    • connectWiseHostedSetup: { _info?: {}; clientId?: string; createdBy?: string; dateCreated?: string; description: string; disabledFlag?: null | boolean; id?: number; locationIds?: number[]; locationsEnabledFlag?: null | boolean; origin?: string; podHeight?: null | number; screenId: null | number; toolbarButtonDialogHeight?: null | number; toolbarButtonDialogWidth?: null | number; toolbarButtonIconDocumentId?: null | number; toolbarButtonText?: string; toolbarButtonToolTip?: string; type: null | "Tab" | "Pod" | "ToolbarButton"; url: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional clientId?: string
        description

        Only required if not already set Max length: 36;

      • Optional createdBy?: string
      • Optional dateCreated?: string
      • description: string
        description

        Max length: 50;

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

        Format: int32

      • Optional locationIds?: number[]
      • Optional locationsEnabledFlag?: null | boolean
      • Optional origin?: string
        description

        Max length: 100;

      • Optional podHeight?: null | number

        Format: int32

      • screenId: null | number

        Format: int32

        description

        Can be obtained via ConnectWiseHostedApiScreen report

      • Optional toolbarButtonDialogHeight?: null | number

        Format: int32

      • Optional toolbarButtonDialogWidth?: null | number

        Format: int32

      • Optional toolbarButtonIconDocumentId?: null | number

        Format: int32

      • Optional toolbarButtonText?: string
        description

        Only required for ToolbarButtons Max length: 50;

      • Optional toolbarButtonToolTip?: string
        description

        Max length: 50;

      • type: null | "Tab" | "Pod" | "ToolbarButton"
      • url: string
        description

        Max length: 1024;

    Returns Promise<{ _info?: {}; clientId?: string; createdBy?: string; dateCreated?: string; description: string; disabledFlag?: null | boolean; id?: number; locationIds?: number[]; locationsEnabledFlag?: null | boolean; origin?: string; podHeight?: null | number; screenId: null | number; toolbarButtonDialogHeight?: null | number; toolbarButtonDialogWidth?: null | number; toolbarButtonIconDocumentId?: null | number; toolbarButtonText?: string; toolbarButtonToolTip?: string; type: null | "Tab" | "Pod" | "ToolbarButton"; url: string }>

putSystemCustomReportsById

  • putSystemCustomReportsById(id: number, customReport: { _info?: {}; agreementFlag?: null | boolean; agreementOverride?: string; agreementParamId?: null | number; agreementTypeFlag?: null | boolean; agreementTypeOverride?: string; agreementTypeParamId?: null | number; companyFlag?: null | boolean; companyOverride?: string; companyParamId?: null | number; departmentDefaultFlag?: null | boolean; departmentFlag?: null | boolean; departmentOverride?: string; departmentParamId?: null | number; description: string; endDateFlag?: null | boolean; endDateOverride?: string; endDateParamId?: null | number; generatedFlag?: null | boolean; id?: number; invoiceFlag?: null | boolean; invoiceOverride?: string; invoiceParamId?: null | number; locationDefaultFlag?: null | boolean; locationFlag?: null | boolean; locationOverride?: string; locationParamId?: null | number; marketingCampaignFlag?: null | boolean; marketingCampaignOverride?: string; marketingCampaignParamId?: null | number; memberFlag?: null | boolean; memberOverride?: string; memberParamId?: null | number; module: null | "Project" | "Finance" | "Sales" | "Companies" | "Marketing" | "Procurement" | "ServiceDesk" | "TimeExpense"; name: string; oppTypeFlag?: null | boolean; oppTypeOverride?: string; oppTypeParamId?: null | number; opportunityFlag?: null | boolean; opportunityOverride?: string; opportunityParamId?: null | number; parameterNameSeparator?: string; parameterPrefix?: string; parameterSeparator?: string; parameterSuffix?: string; projectFlag?: null | boolean; projectOverride?: string; projectParamId?: null | number; projectTypeFlag?: null | boolean; projectTypeOverride?: string; projectTypeParamId?: null | number; reportLink: string; serviceBoardDefaultFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceBoardOverride?: string; serviceBoardParamId?: null | number; serviceStatusFlag?: null | boolean; serviceStatusOverride?: string; serviceStatusParamId?: null | number; serviceTypeFlag?: null | boolean; serviceTypeOverride?: string; serviceTypeParamId?: null | number; startDateFlag?: null | boolean; startDateOverride?: string; startDateParamId?: null | number; territoryDefaultFlag?: null | boolean; territoryFlag?: null | boolean; territoryOverride?: string; territoryParamId?: null | number; workRoleFlag?: null | boolean; workRoleOverride?: string; workRoleParamId?: null | number; workTypeFlag?: null | boolean; workTypeOverride?: string; workTypeParamId?: null | number }): Promise<{ _info?: {}; agreementFlag?: null | boolean; agreementOverride?: string; agreementParamId?: null | number; agreementTypeFlag?: null | boolean; agreementTypeOverride?: string; agreementTypeParamId?: null | number; companyFlag?: null | boolean; companyOverride?: string; companyParamId?: null | number; departmentDefaultFlag?: null | boolean; departmentFlag?: null | boolean; departmentOverride?: string; departmentParamId?: null | number; description: string; endDateFlag?: null | boolean; endDateOverride?: string; endDateParamId?: null | number; generatedFlag?: null | boolean; id?: number; invoiceFlag?: null | boolean; invoiceOverride?: string; invoiceParamId?: null | number; locationDefaultFlag?: null | boolean; locationFlag?: null | boolean; locationOverride?: string; locationParamId?: null | number; marketingCampaignFlag?: null | boolean; marketingCampaignOverride?: string; marketingCampaignParamId?: null | number; memberFlag?: null | boolean; memberOverride?: string; memberParamId?: null | number; module: null | "Project" | "Finance" | "Sales" | "Companies" | "Marketing" | "Procurement" | "ServiceDesk" | "TimeExpense"; name: string; oppTypeFlag?: null | boolean; oppTypeOverride?: string; oppTypeParamId?: null | number; opportunityFlag?: null | boolean; opportunityOverride?: string; opportunityParamId?: null | number; parameterNameSeparator?: string; parameterPrefix?: string; parameterSeparator?: string; parameterSuffix?: string; projectFlag?: null | boolean; projectOverride?: string; projectParamId?: null | number; projectTypeFlag?: null | boolean; projectTypeOverride?: string; projectTypeParamId?: null | number; reportLink: string; serviceBoardDefaultFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceBoardOverride?: string; serviceBoardParamId?: null | number; serviceStatusFlag?: null | boolean; serviceStatusOverride?: string; serviceStatusParamId?: null | number; serviceTypeFlag?: null | boolean; serviceTypeOverride?: string; serviceTypeParamId?: null | number; startDateFlag?: null | boolean; startDateOverride?: string; startDateParamId?: null | number; territoryDefaultFlag?: null | boolean; territoryFlag?: null | boolean; territoryOverride?: string; territoryParamId?: null | number; workRoleFlag?: null | boolean; workRoleOverride?: string; workRoleParamId?: null | number; workTypeFlag?: null | boolean; workTypeOverride?: string; workTypeParamId?: null | number }>

  • Parameters

    • id: number
    • customReport: { _info?: {}; agreementFlag?: null | boolean; agreementOverride?: string; agreementParamId?: null | number; agreementTypeFlag?: null | boolean; agreementTypeOverride?: string; agreementTypeParamId?: null | number; companyFlag?: null | boolean; companyOverride?: string; companyParamId?: null | number; departmentDefaultFlag?: null | boolean; departmentFlag?: null | boolean; departmentOverride?: string; departmentParamId?: null | number; description: string; endDateFlag?: null | boolean; endDateOverride?: string; endDateParamId?: null | number; generatedFlag?: null | boolean; id?: number; invoiceFlag?: null | boolean; invoiceOverride?: string; invoiceParamId?: null | number; locationDefaultFlag?: null | boolean; locationFlag?: null | boolean; locationOverride?: string; locationParamId?: null | number; marketingCampaignFlag?: null | boolean; marketingCampaignOverride?: string; marketingCampaignParamId?: null | number; memberFlag?: null | boolean; memberOverride?: string; memberParamId?: null | number; module: null | "Project" | "Finance" | "Sales" | "Companies" | "Marketing" | "Procurement" | "ServiceDesk" | "TimeExpense"; name: string; oppTypeFlag?: null | boolean; oppTypeOverride?: string; oppTypeParamId?: null | number; opportunityFlag?: null | boolean; opportunityOverride?: string; opportunityParamId?: null | number; parameterNameSeparator?: string; parameterPrefix?: string; parameterSeparator?: string; parameterSuffix?: string; projectFlag?: null | boolean; projectOverride?: string; projectParamId?: null | number; projectTypeFlag?: null | boolean; projectTypeOverride?: string; projectTypeParamId?: null | number; reportLink: string; serviceBoardDefaultFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceBoardOverride?: string; serviceBoardParamId?: null | number; serviceStatusFlag?: null | boolean; serviceStatusOverride?: string; serviceStatusParamId?: null | number; serviceTypeFlag?: null | boolean; serviceTypeOverride?: string; serviceTypeParamId?: null | number; startDateFlag?: null | boolean; startDateOverride?: string; startDateParamId?: null | number; territoryDefaultFlag?: null | boolean; territoryFlag?: null | boolean; territoryOverride?: string; territoryParamId?: null | number; workRoleFlag?: null | boolean; workRoleOverride?: string; workRoleParamId?: null | number; workTypeFlag?: null | boolean; workTypeOverride?: string; workTypeParamId?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementFlag?: null | boolean
      • Optional agreementOverride?: string
      • Optional agreementParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Agreement parameter

      • Optional agreementTypeFlag?: null | boolean
      • Optional agreementTypeOverride?: string
      • Optional agreementTypeParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Agreement Type parameter

      • Optional companyFlag?: null | boolean
      • Optional companyOverride?: string
      • Optional companyParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Company parameter

      • Optional departmentDefaultFlag?: null | boolean
      • Optional departmentFlag?: null | boolean
      • Optional departmentOverride?: string
      • Optional departmentParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Department parameter

      • description: string
        description

        Max length: 150;

      • Optional endDateFlag?: null | boolean
      • Optional endDateOverride?: string
      • Optional endDateParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's End Date parameter

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

        Format: int32

      • Optional invoiceFlag?: null | boolean
      • Optional invoiceOverride?: string
      • Optional invoiceParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Invoice Type parameter

      • Optional locationDefaultFlag?: null | boolean
      • Optional locationFlag?: null | boolean
      • Optional locationOverride?: string
      • Optional locationParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Location parameter

      • Optional marketingCampaignFlag?: null | boolean
      • Optional marketingCampaignOverride?: string
      • Optional marketingCampaignParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Marketing Campaign parameter

      • Optional memberFlag?: null | boolean
      • Optional memberOverride?: string
      • Optional memberParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Member parameter

      • module: null | "Project" | "Finance" | "Sales" | "Companies" | "Marketing" | "Procurement" | "ServiceDesk" | "TimeExpense"
        description

        The Module Name

      • name: string
        description

        Max length: 100;

      • Optional oppTypeFlag?: null | boolean
      • Optional oppTypeOverride?: string
      • Optional oppTypeParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Opportunity Type parameter

      • Optional opportunityFlag?: null | boolean
      • Optional opportunityOverride?: string
      • Optional opportunityParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Opportunity parameter

      • Optional parameterNameSeparator?: string
        description

        Max length: 50;

      • Optional parameterPrefix?: string
        description

        Max length: 50;

      • Optional parameterSeparator?: string
        description

        Max length: 50;

      • Optional parameterSuffix?: string
        description

        Max length: 50;

      • Optional projectFlag?: null | boolean
      • Optional projectOverride?: string
      • Optional projectParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Project parameter

      • Optional projectTypeFlag?: null | boolean
      • Optional projectTypeOverride?: string
      • Optional projectTypeParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Project Type parameter

      • reportLink: string
      • Optional serviceBoardDefaultFlag?: null | boolean
      • Optional serviceBoardFlag?: null | boolean
      • Optional serviceBoardOverride?: string
      • Optional serviceBoardParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Service Board parameter

      • Optional serviceStatusFlag?: null | boolean
      • Optional serviceStatusOverride?: string
      • Optional serviceStatusParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Service Status parameter

      • Optional serviceTypeFlag?: null | boolean
      • Optional serviceTypeOverride?: string
      • Optional serviceTypeParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Service Type parameter

      • Optional startDateFlag?: null | boolean
      • Optional startDateOverride?: string
      • Optional startDateParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Start Date parameter

      • Optional territoryDefaultFlag?: null | boolean
      • Optional territoryFlag?: null | boolean
      • Optional territoryOverride?: string
      • Optional territoryParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Terriroty parameter

      • Optional workRoleFlag?: null | boolean
      • Optional workRoleOverride?: string
      • Optional workRoleParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Work Role parameter

      • Optional workTypeFlag?: null | boolean
      • Optional workTypeOverride?: string
      • Optional workTypeParamId?: null | number

        Format: int32

        description

        Parameter unique identifier for the Custom Report's Work Type parameter

    Returns Promise<{ _info?: {}; agreementFlag?: null | boolean; agreementOverride?: string; agreementParamId?: null | number; agreementTypeFlag?: null | boolean; agreementTypeOverride?: string; agreementTypeParamId?: null | number; companyFlag?: null | boolean; companyOverride?: string; companyParamId?: null | number; departmentDefaultFlag?: null | boolean; departmentFlag?: null | boolean; departmentOverride?: string; departmentParamId?: null | number; description: string; endDateFlag?: null | boolean; endDateOverride?: string; endDateParamId?: null | number; generatedFlag?: null | boolean; id?: number; invoiceFlag?: null | boolean; invoiceOverride?: string; invoiceParamId?: null | number; locationDefaultFlag?: null | boolean; locationFlag?: null | boolean; locationOverride?: string; locationParamId?: null | number; marketingCampaignFlag?: null | boolean; marketingCampaignOverride?: string; marketingCampaignParamId?: null | number; memberFlag?: null | boolean; memberOverride?: string; memberParamId?: null | number; module: null | "Project" | "Finance" | "Sales" | "Companies" | "Marketing" | "Procurement" | "ServiceDesk" | "TimeExpense"; name: string; oppTypeFlag?: null | boolean; oppTypeOverride?: string; oppTypeParamId?: null | number; opportunityFlag?: null | boolean; opportunityOverride?: string; opportunityParamId?: null | number; parameterNameSeparator?: string; parameterPrefix?: string; parameterSeparator?: string; parameterSuffix?: string; projectFlag?: null | boolean; projectOverride?: string; projectParamId?: null | number; projectTypeFlag?: null | boolean; projectTypeOverride?: string; projectTypeParamId?: null | number; reportLink: string; serviceBoardDefaultFlag?: null | boolean; serviceBoardFlag?: null | boolean; serviceBoardOverride?: string; serviceBoardParamId?: null | number; serviceStatusFlag?: null | boolean; serviceStatusOverride?: string; serviceStatusParamId?: null | number; serviceTypeFlag?: null | boolean; serviceTypeOverride?: string; serviceTypeParamId?: null | number; startDateFlag?: null | boolean; startDateOverride?: string; startDateParamId?: null | number; territoryDefaultFlag?: null | boolean; territoryFlag?: null | boolean; territoryOverride?: string; territoryParamId?: null | number; workRoleFlag?: null | boolean; workRoleOverride?: string; workRoleParamId?: null | number; workTypeFlag?: null | boolean; workTypeOverride?: string; workTypeParamId?: null | number }>

putSystemCustomReportsByParentIdParametersById

  • putSystemCustomReportsByParentIdParametersById(id: number, parentId: number, customReportParameter: { _info?: {}; captionName?: string; customReport?: { _info?: {}; id?: null | number; name?: string }; id?: number; name?: string }): Promise<{ _info?: {}; captionName?: string; customReport?: { _info?: {}; id?: null | number; name?: string }; id?: number; name?: string }>

  • Parameters

    • id: number
    • parentId: number
    • customReportParameter: { _info?: {}; captionName?: string; customReport?: { _info?: {}; id?: null | number; name?: string }; id?: number; name?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional captionName?: string
        description

        Either a caption name or parameter name is required Max length: 50;

      • Optional customReport?: { _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 name?: string
        description

        Either a caption name or parameter name is required Max length: 50;

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

putSystemDepartmentsById

  • putSystemDepartmentsById(id: number, department: { _info?: {}; id?: number; identifier: string; name: string }): Promise<{ _info?: {}; id?: number; identifier: string; name: string }>

  • Parameters

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

        Format: int32

      • identifier: string
        description

        Max length: 15;

      • name: string
        description

        Max length: 50;

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

putSystemDepartmentsByParentIdLocationsById

  • putSystemDepartmentsByParentIdLocationsById(id: number, parentId: number, departmentLocation: { _info?: {}; addAllLocations?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; departmentManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatch?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; ldapConfig?: { _info?: {}; id?: null | number; name?: string; server?: string }; location?: { _info?: {}; id?: null | number; name?: string }; removeAllLocations?: null | boolean; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; addAllLocations?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; departmentManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatch?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; ldapConfig?: { _info?: {}; id?: null | number; name?: string; server?: string }; location?: { _info?: {}; id?: null | number; name?: string }; removeAllLocations?: null | boolean; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • departmentLocation: { _info?: {}; addAllLocations?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; departmentManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatch?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; ldapConfig?: { _info?: {}; id?: null | number; name?: string; server?: string }; location?: { _info?: {}; id?: null | number; name?: string }; removeAllLocations?: null | boolean; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addAllLocations?: null | boolean
      • 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 departmentManager?: { _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 dispatch?: { _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 dutyManager?: { _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 ldapConfig?: { _info?: {}; id?: null | number; name?: string; server?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional removeAllLocations?: null | boolean
      • Optional serviceManager?: { _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?: {}; addAllLocations?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; departmentManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatch?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; ldapConfig?: { _info?: {}; id?: null | number; name?: string; server?: string }; location?: { _info?: {}; id?: null | number; name?: string }; removeAllLocations?: null | boolean; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

putSystemEPayConfigurationsById

  • putSystemEPayConfigurationsById(id: number, ePayConfiguration: { _info?: {}; 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 }; encryptionKey?: string; id?: number; initializationVector?: string; location?: { _info?: {}; id?: null | number; name?: string }; storeIdentifier: string; url: string }): Promise<{ _info?: {}; 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 }; encryptionKey?: string; id?: number; initializationVector?: string; location?: { _info?: {}; id?: null | number; name?: string }; storeIdentifier: string; url: string }>

  • Parameters

    • id: number
    • ePayConfiguration: { _info?: {}; 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 }; encryptionKey?: string; id?: number; initializationVector?: string; location?: { _info?: {}; id?: null | number; name?: string }; storeIdentifier: string; url: string }
      • Optional _info?: {}
        • [key: string]: 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 encryptionKey?: string
        description

        Max length: 500;

      • Optional id?: number

        Format: int32

      • Optional initializationVector?: string
        description

        Max length: 500;

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

          Format: int32

        • Optional name?: string
      • storeIdentifier: string
        description

        Max length: 500;

      • url: string
        description

        Max length: 400;

    Returns Promise<{ _info?: {}; 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 }; encryptionKey?: string; id?: number; initializationVector?: string; location?: { _info?: {}; id?: null | number; name?: string }; storeIdentifier: string; url: string }>

putSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRulesById

  • putSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRulesById(id: number, parentId: number, grandparentId: number, emailConnectorParsingRule: { _info?: {}; id?: number; parsingStyle?: { _info?: {}; id?: null | number; name?: string }; parsingVariable?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority: null | number; searchTerm: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceStatus?: { _info?: {}; id?: null | number; name?: string }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; parsingStyle?: { _info?: {}; id?: null | number; name?: string }; parsingVariable?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority: null | number; searchTerm: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceStatus?: { _info?: {}; id?: null | number; name?: string }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • grandparentId: number
    • emailConnectorParsingRule: { _info?: {}; id?: number; parsingStyle?: { _info?: {}; id?: null | number; name?: string }; parsingVariable?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority: null | number; searchTerm: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceStatus?: { _info?: {}; id?: null | number; name?: string }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional parsingVariable?: { _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
      • priority: null | number

        Format: int32

      • searchTerm: string
        description

        Max length: 250;

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; id?: number; parsingStyle?: { _info?: {}; id?: null | number; name?: string }; parsingVariable?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority: null | number; searchTerm: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceStatus?: { _info?: {}; id?: null | number; name?: string }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string } }>

putSystemEmailConnectorsById

  • putSystemEmailConnectorsById(id: number, emailConnector: { _info?: {}; addCcFlag?: null | boolean; bccEmailTo?: string; createContactFlag?: null | boolean; defaultCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; discardDuplicatesFlag?: null | boolean; emailErrorsTo: string; emailNotifyFrom?: string; emailServerType?: null | "IMAP" | "Office365" | "Google"; googleEmailSetup?: { _info?: {}; id?: null | number; name?: string }; id?: number; imapSetup?: { _info?: {}; id?: null | number; name?: string }; itemOverride?: { _info?: {}; id?: null | number; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; neverRespondFlag?: null | boolean; noResponseFlag?: null | boolean; office365EmailSetup?: { _info?: {}; id?: null | number; name?: string }; postRepliesToTicketFlag?: null | boolean; priorityOverride?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; responseEmailForExisting?: string; responseEmailForNew?: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; setEmailToDefaultContactFlag?: null | boolean; sourceOverride?: { _info?: {}; id?: null | number; name?: string }; statusOverride?: { _info?: {}; id?: null | number; name?: string }; subTypeOverride?: { _info?: {}; id?: null | number; name?: string }; typeOverride?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; addCcFlag?: null | boolean; bccEmailTo?: string; createContactFlag?: null | boolean; defaultCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; discardDuplicatesFlag?: null | boolean; emailErrorsTo: string; emailNotifyFrom?: string; emailServerType?: null | "IMAP" | "Office365" | "Google"; googleEmailSetup?: { _info?: {}; id?: null | number; name?: string }; id?: number; imapSetup?: { _info?: {}; id?: null | number; name?: string }; itemOverride?: { _info?: {}; id?: null | number; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; neverRespondFlag?: null | boolean; noResponseFlag?: null | boolean; office365EmailSetup?: { _info?: {}; id?: null | number; name?: string }; postRepliesToTicketFlag?: null | boolean; priorityOverride?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; responseEmailForExisting?: string; responseEmailForNew?: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; setEmailToDefaultContactFlag?: null | boolean; sourceOverride?: { _info?: {}; id?: null | number; name?: string }; statusOverride?: { _info?: {}; id?: null | number; name?: string }; subTypeOverride?: { _info?: {}; id?: null | number; name?: string }; typeOverride?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • emailConnector: { _info?: {}; addCcFlag?: null | boolean; bccEmailTo?: string; createContactFlag?: null | boolean; defaultCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; discardDuplicatesFlag?: null | boolean; emailErrorsTo: string; emailNotifyFrom?: string; emailServerType?: null | "IMAP" | "Office365" | "Google"; googleEmailSetup?: { _info?: {}; id?: null | number; name?: string }; id?: number; imapSetup?: { _info?: {}; id?: null | number; name?: string }; itemOverride?: { _info?: {}; id?: null | number; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; neverRespondFlag?: null | boolean; noResponseFlag?: null | boolean; office365EmailSetup?: { _info?: {}; id?: null | number; name?: string }; postRepliesToTicketFlag?: null | boolean; priorityOverride?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; responseEmailForExisting?: string; responseEmailForNew?: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; setEmailToDefaultContactFlag?: null | boolean; sourceOverride?: { _info?: {}; id?: null | number; name?: string }; statusOverride?: { _info?: {}; id?: null | number; name?: string }; subTypeOverride?: { _info?: {}; id?: null | number; name?: string }; typeOverride?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addCcFlag?: null | boolean
      • Optional bccEmailTo?: string
        description

        Max length: 250;

      • Optional createContactFlag?: null | boolean
      • Optional defaultCompany?: { _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 defaultMember?: { _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 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 discardDuplicatesFlag?: null | boolean
      • emailErrorsTo: string
        description

        Max length: 50;

      • Optional emailNotifyFrom?: string
        description

        Max length: 50;

      • Optional emailServerType?: null | "IMAP" | "Office365" | "Google"
      • Optional googleEmailSetup?: { _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 imapSetup?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional neverRespondFlag?: null | boolean
      • Optional noResponseFlag?: null | boolean
      • Optional office365EmailSetup?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional postRepliesToTicketFlag?: null | boolean
      • Optional priorityOverride?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; addCcFlag?: null | boolean; bccEmailTo?: string; createContactFlag?: null | boolean; defaultCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultMember?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; discardDuplicatesFlag?: null | boolean; emailErrorsTo: string; emailNotifyFrom?: string; emailServerType?: null | "IMAP" | "Office365" | "Google"; googleEmailSetup?: { _info?: {}; id?: null | number; name?: string }; id?: number; imapSetup?: { _info?: {}; id?: null | number; name?: string }; itemOverride?: { _info?: {}; id?: null | number; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; neverRespondFlag?: null | boolean; noResponseFlag?: null | boolean; office365EmailSetup?: { _info?: {}; id?: null | number; name?: string }; postRepliesToTicketFlag?: null | boolean; priorityOverride?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; responseEmailForExisting?: string; responseEmailForNew?: string; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; setEmailToDefaultContactFlag?: null | boolean; sourceOverride?: { _info?: {}; id?: null | number; name?: string }; statusOverride?: { _info?: {}; id?: null | number; name?: string }; subTypeOverride?: { _info?: {}; id?: null | number; name?: string }; typeOverride?: { _info?: {}; id?: null | number; name?: string } }>

putSystemEmailConnectorsByParentIdParsingStylesById

  • putSystemEmailConnectorsByParentIdParsingStylesById(id: number, parentId: number, emailConnectorParsingStyle: { _info?: {}; id?: number; parseRule: string; parsingType?: { _info?: {}; id?: null | number; name?: string }; priority: null | number }): Promise<{ _info?: {}; id?: number; parseRule: string; parsingType?: { _info?: {}; id?: null | number; name?: string }; priority: null | number }>

  • Parameters

    • id: number
    • parentId: number
    • emailConnectorParsingStyle: { _info?: {}; id?: number; parseRule: string; parsingType?: { _info?: {}; id?: null | number; name?: string }; priority: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • parseRule: string
        description

        Max length: 500;

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

          Format: int32

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

        Format: int32

    Returns Promise<{ _info?: {}; id?: number; parseRule: string; parsingType?: { _info?: {}; id?: null | number; name?: string }; priority: null | number }>

putSystemEmailExclusionsById

  • putSystemEmailExclusionsById(id: number, emailExclusion: { _info?: {}; description: string; id?: number }): Promise<{ _info?: {}; description: string; id?: number }>

  • Parameters

    • id: number
    • emailExclusion: { _info?: {}; description: string; id?: number }
      • Optional _info?: {}
        • [key: string]: string
      • description: string
        description

        Max length: 100;

      • Optional id?: number

        Format: int32

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

putSystemFileuploadsettingsById

  • putSystemFileuploadsettingsById(id: number, companyTypeAssociation: { _info?: {}; globalFileSizeLimit?: null | number; id?: number; restrictFileTypesFlag: null | boolean }): Promise<{ _info?: {}; globalFileSizeLimit?: null | number; id?: number; restrictFileTypesFlag: null | boolean }>

  • Parameters

    • id: number
    • companyTypeAssociation: { _info?: {}; globalFileSizeLimit?: null | number; id?: number; restrictFileTypesFlag: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional globalFileSizeLimit?: null | number

        Format: int32

      • Optional id?: number

        Format: int32

      • restrictFileTypesFlag: null | boolean

    Returns Promise<{ _info?: {}; globalFileSizeLimit?: null | number; id?: number; restrictFileTypesFlag: null | boolean }>

putSystemGoogleemailsetupById

  • putSystemGoogleemailsetupById(id: number, companyTypeAssociation: { _info?: {}; clientId?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; privateKey?: string; processedFolder: string; username: string }): Promise<{ _info?: {}; clientId?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; privateKey?: string; processedFolder: string; username: string }>

  • Parameters

    • id: number
    • companyTypeAssociation: { _info?: {}; clientId?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; privateKey?: string; processedFolder: string; username: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional clientId?: string
        description

        Max length: 200;

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

          Format: int32

        • Optional name?: string
      • failedFolder: string
        description

        Max length: 40;

      • Optional id?: number

        Format: int32

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

        Max length: 40;

      • name: string
        description

        Max length: 200;

      • Optional privateKey?: string
        description

        Max length: 4000;

      • processedFolder: string
        description

        Max length: 40;

      • username: string
        description

        Max length: 100;

    Returns Promise<{ _info?: {}; clientId?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; privateKey?: string; processedFolder: string; username: string }>

putSystemImapsById

  • putSystemImapsById(id: number, imap: { _info?: {}; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; imapName: string; name: string; password?: string; port: null | number; processedName: string; server: string; sslFlag?: null | boolean; userName: string }): Promise<{ _info?: {}; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; imapName: string; name: string; password?: string; port: null | number; processedName: string; server: string; sslFlag?: null | boolean; userName: string }>

  • Parameters

    • id: number
    • imap: { _info?: {}; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; imapName: string; name: string; password?: string; port: null | number; processedName: string; server: string; sslFlag?: null | boolean; userName: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional emailConnector?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • failedFolder: string
        description

        Max length: 40;

      • Optional id?: number

        Format: int32

      • imapName: string
        description

        Max length: 40;

      • name: string
        description

        Max length: 200;

      • Optional password?: string
        description

        Max length: 80;

      • port: null | number

        Format: int32

      • processedName: string
        description

        Max length: 40;

      • server: string
        description

        Max length: 200;

      • Optional sslFlag?: null | boolean
      • userName: string
        description

        Max length: 80;

    Returns Promise<{ _info?: {}; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; imapName: string; name: string; password?: string; port: null | number; processedName: string; server: string; sslFlag?: null | boolean; userName: string }>

putSystemInOutBoardsById

  • putSystemInOutBoardsById(id: number, inOutBoard: { _info?: {}; additionalInfo?: string; dateBack: string; id?: number; inOutType?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; additionalInfo?: string; dateBack: string; id?: number; inOutType?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • id: number
    • inOutBoard: { _info?: {}; additionalInfo?: string; dateBack: string; id?: number; inOutType?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional additionalInfo?: string
        description

        Max length: 100;

      • dateBack: string

        Format: date-time

      • Optional id?: number

        Format: int32

      • Optional inOutType?: { _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

    Returns Promise<{ _info?: {}; additionalInfo?: string; dateBack: string; id?: number; inOutType?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

putSystemInOutTypesById

  • putSystemInOutTypesById(id: number, inOutType: { _info?: {}; description: string; id?: number }): Promise<{ _info?: {}; description: string; id?: number }>

  • Parameters

    • id: number
    • inOutType: { _info?: {}; description: string; id?: number }
      • Optional _info?: {}
        • [key: string]: string
      • description: string
        description

        Max length: 30;

      • Optional id?: number

        Format: int32

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

putSystemIntegratorTagsById

  • putSystemIntegratorTagsById(id: number, tag: { _info?: {}; id?: number; text: string }): Promise<{ _info?: {}; id?: number; text: string }>

  • Parameters

    • id: number
    • tag: { _info?: {}; id?: number; text: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • text: string
        description

        Max length: 50;

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

putSystemIntegratorloginsById

  • putSystemIntegratorloginsById(id: number, integratorLogin: { _info?: {}; activityApiFlag?: null | boolean; activityCallbackUrl?: string; activityLegacyCallbackFlag?: null | boolean; agreementApiFlag?: null | boolean; agreementCallbackLegacyFlag?: null | boolean; agreementCallbackUrl?: string; board?: { _info?: {}; id?: null | number; name?: string }; canAccessAllApisFlag?: null | boolean; canAccessAllRecordsFlag?: null | boolean; companyApiFlag?: null | boolean; companyCallbackUrl?: string; companyLegacyCallbackFlag?: null | boolean; configurationApiFlag?: null | boolean; configurationAutoChildFlag?: null | boolean; configurationCallbackUrl?: string; configurationChildlingFlag?: null | boolean; configurationLegacyCallbackFlag?: null | boolean; contactApiFlag?: null | boolean; contactCallbackUrl?: string; contactLegacyCallbackFlag?: null | boolean; dateInactivated?: string; documentApiFlag?: null | boolean; id?: number; inactivatedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; inactiveFlag?: null | boolean; invoiceApiFlag?: null | boolean; managedServicesApiFlag?: null | boolean; managedServicesAutoChildFlag?: null | boolean; managedServicesChildingFlag?: null | boolean; marketingApiFlag?: null | boolean; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memberApiFlag?: null | boolean; opportunityApiFlag?: null | boolean; opportunityCallbackUrl?: string; opportunityConversionApiFlag?: null | boolean; opportunityLegacyCallbackFlag?: null | boolean; password?: string; productApiFlag?: null | boolean; productCallbackUrl?: string; productLegacyCallbackFlag?: null | boolean; projectApiFlag?: null | boolean; projectCallbackUrl?: string; projectLegacyCallbackFlag?: null | boolean; purchasingApiFlag?: null | boolean; purchasingCallbackUrl?: string; purchasingLegacyCallbackFlag?: null | boolean; reportingApiFlag?: null | boolean; scheduleApiFlag?: null | boolean; scheduleCallbackUrl?: string; scheduleLegacyCallbackFlag?: null | boolean; serviceBoardCallbackUrl?: string; serviceBoardLegacyCallbackFlag?: null | boolean; serviceTicketApiFlag?: null | boolean; systemApiFlag?: null | boolean; timeEntryApiFlag?: null | boolean; timeEntryCallbackUrl?: string; timeEntryLegacyCallbackFlag?: null | boolean; username: string }): Promise<{ _info?: {}; activityApiFlag?: null | boolean; activityCallbackUrl?: string; activityLegacyCallbackFlag?: null | boolean; agreementApiFlag?: null | boolean; agreementCallbackLegacyFlag?: null | boolean; agreementCallbackUrl?: string; board?: { _info?: {}; id?: null | number; name?: string }; canAccessAllApisFlag?: null | boolean; canAccessAllRecordsFlag?: null | boolean; companyApiFlag?: null | boolean; companyCallbackUrl?: string; companyLegacyCallbackFlag?: null | boolean; configurationApiFlag?: null | boolean; configurationAutoChildFlag?: null | boolean; configurationCallbackUrl?: string; configurationChildlingFlag?: null | boolean; configurationLegacyCallbackFlag?: null | boolean; contactApiFlag?: null | boolean; contactCallbackUrl?: string; contactLegacyCallbackFlag?: null | boolean; dateInactivated?: string; documentApiFlag?: null | boolean; id?: number; inactivatedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; inactiveFlag?: null | boolean; invoiceApiFlag?: null | boolean; managedServicesApiFlag?: null | boolean; managedServicesAutoChildFlag?: null | boolean; managedServicesChildingFlag?: null | boolean; marketingApiFlag?: null | boolean; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memberApiFlag?: null | boolean; opportunityApiFlag?: null | boolean; opportunityCallbackUrl?: string; opportunityConversionApiFlag?: null | boolean; opportunityLegacyCallbackFlag?: null | boolean; password?: string; productApiFlag?: null | boolean; productCallbackUrl?: string; productLegacyCallbackFlag?: null | boolean; projectApiFlag?: null | boolean; projectCallbackUrl?: string; projectLegacyCallbackFlag?: null | boolean; purchasingApiFlag?: null | boolean; purchasingCallbackUrl?: string; purchasingLegacyCallbackFlag?: null | boolean; reportingApiFlag?: null | boolean; scheduleApiFlag?: null | boolean; scheduleCallbackUrl?: string; scheduleLegacyCallbackFlag?: null | boolean; serviceBoardCallbackUrl?: string; serviceBoardLegacyCallbackFlag?: null | boolean; serviceTicketApiFlag?: null | boolean; systemApiFlag?: null | boolean; timeEntryApiFlag?: null | boolean; timeEntryCallbackUrl?: string; timeEntryLegacyCallbackFlag?: null | boolean; username: string }>

  • Parameters

    • id: number
    • integratorLogin: { _info?: {}; activityApiFlag?: null | boolean; activityCallbackUrl?: string; activityLegacyCallbackFlag?: null | boolean; agreementApiFlag?: null | boolean; agreementCallbackLegacyFlag?: null | boolean; agreementCallbackUrl?: string; board?: { _info?: {}; id?: null | number; name?: string }; canAccessAllApisFlag?: null | boolean; canAccessAllRecordsFlag?: null | boolean; companyApiFlag?: null | boolean; companyCallbackUrl?: string; companyLegacyCallbackFlag?: null | boolean; configurationApiFlag?: null | boolean; configurationAutoChildFlag?: null | boolean; configurationCallbackUrl?: string; configurationChildlingFlag?: null | boolean; configurationLegacyCallbackFlag?: null | boolean; contactApiFlag?: null | boolean; contactCallbackUrl?: string; contactLegacyCallbackFlag?: null | boolean; dateInactivated?: string; documentApiFlag?: null | boolean; id?: number; inactivatedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; inactiveFlag?: null | boolean; invoiceApiFlag?: null | boolean; managedServicesApiFlag?: null | boolean; managedServicesAutoChildFlag?: null | boolean; managedServicesChildingFlag?: null | boolean; marketingApiFlag?: null | boolean; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memberApiFlag?: null | boolean; opportunityApiFlag?: null | boolean; opportunityCallbackUrl?: string; opportunityConversionApiFlag?: null | boolean; opportunityLegacyCallbackFlag?: null | boolean; password?: string; productApiFlag?: null | boolean; productCallbackUrl?: string; productLegacyCallbackFlag?: null | boolean; projectApiFlag?: null | boolean; projectCallbackUrl?: string; projectLegacyCallbackFlag?: null | boolean; purchasingApiFlag?: null | boolean; purchasingCallbackUrl?: string; purchasingLegacyCallbackFlag?: null | boolean; reportingApiFlag?: null | boolean; scheduleApiFlag?: null | boolean; scheduleCallbackUrl?: string; scheduleLegacyCallbackFlag?: null | boolean; serviceBoardCallbackUrl?: string; serviceBoardLegacyCallbackFlag?: null | boolean; serviceTicketApiFlag?: null | boolean; systemApiFlag?: null | boolean; timeEntryApiFlag?: null | boolean; timeEntryCallbackUrl?: string; timeEntryLegacyCallbackFlag?: null | boolean; username: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional activityApiFlag?: null | boolean
      • Optional activityCallbackUrl?: string
        description

        Max length: 1000;

      • Optional activityLegacyCallbackFlag?: null | boolean
      • Optional agreementApiFlag?: null | boolean
      • Optional agreementCallbackLegacyFlag?: null | boolean
      • Optional agreementCallbackUrl?: string
        description

        Max length: 1000;

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

          Format: int32

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

        Setting this flag to true will create an integrator that can access all of the available apis in the system. If this field is set to true, both the member and board fields are required.

      • Optional canAccessAllRecordsFlag?: null | boolean
        description

        This flag controls whether the integrator can access only the db records it created, or all system records

      • Optional companyApiFlag?: null | boolean
      • Optional companyCallbackUrl?: string
        description

        Max length: 1000;

      • Optional companyLegacyCallbackFlag?: null | boolean
      • Optional configurationApiFlag?: null | boolean
      • Optional configurationAutoChildFlag?: null | boolean
      • Optional configurationCallbackUrl?: string
        description

        Max length: 1000;

      • Optional configurationChildlingFlag?: null | boolean
        description

        True if integrator is allowed to child configurations

      • Optional configurationLegacyCallbackFlag?: null | boolean
      • Optional contactApiFlag?: null | boolean
      • Optional contactCallbackUrl?: string
        description

        Max length: 1000;

      • Optional contactLegacyCallbackFlag?: null | boolean
      • Optional dateInactivated?: string

        Format: date-time

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

        Format: int32

      • Optional inactivatedBy?: { _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 inactiveFlag?: null | boolean
      • Optional invoiceApiFlag?: null | boolean
      • Optional managedServicesApiFlag?: null | boolean
      • Optional managedServicesAutoChildFlag?: null | boolean
      • Optional managedServicesChildingFlag?: null | boolean
        description

        True if integrator is allowed to child configurations

      • Optional marketingApiFlag?: null | boolean
      • 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 memberApiFlag?: null | boolean
      • Optional opportunityApiFlag?: null | boolean
      • Optional opportunityCallbackUrl?: string
        description

        Max length: 1000;

      • Optional opportunityConversionApiFlag?: null | boolean
        description

        True if the member has access to the Opportunity Conversion Api

      • Optional opportunityLegacyCallbackFlag?: null | boolean
      • Optional password?: string
        description

        The password will never be returned in response Max length: 50;

      • Optional productApiFlag?: null | boolean
      • Optional productCallbackUrl?: string
        description

        Max length: 1000;

      • Optional productLegacyCallbackFlag?: null | boolean
      • Optional projectApiFlag?: null | boolean
      • Optional projectCallbackUrl?: string
        description

        Max length: 1000;

      • Optional projectLegacyCallbackFlag?: null | boolean
      • Optional purchasingApiFlag?: null | boolean
      • Optional purchasingCallbackUrl?: string
        description

        Max length: 1000;

      • Optional purchasingLegacyCallbackFlag?: null | boolean
      • Optional reportingApiFlag?: null | boolean
      • Optional scheduleApiFlag?: null | boolean
      • Optional scheduleCallbackUrl?: string
        description

        Max length: 1000;

      • Optional scheduleLegacyCallbackFlag?: null | boolean
      • Optional serviceBoardCallbackUrl?: string
        description

        Max length: 1000;

      • Optional serviceBoardLegacyCallbackFlag?: null | boolean
      • Optional serviceTicketApiFlag?: null | boolean
      • Optional systemApiFlag?: null | boolean
      • Optional timeEntryApiFlag?: null | boolean
      • Optional timeEntryCallbackUrl?: string
        description

        Max length: 1000;

      • Optional timeEntryLegacyCallbackFlag?: null | boolean
      • username: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; activityApiFlag?: null | boolean; activityCallbackUrl?: string; activityLegacyCallbackFlag?: null | boolean; agreementApiFlag?: null | boolean; agreementCallbackLegacyFlag?: null | boolean; agreementCallbackUrl?: string; board?: { _info?: {}; id?: null | number; name?: string }; canAccessAllApisFlag?: null | boolean; canAccessAllRecordsFlag?: null | boolean; companyApiFlag?: null | boolean; companyCallbackUrl?: string; companyLegacyCallbackFlag?: null | boolean; configurationApiFlag?: null | boolean; configurationAutoChildFlag?: null | boolean; configurationCallbackUrl?: string; configurationChildlingFlag?: null | boolean; configurationLegacyCallbackFlag?: null | boolean; contactApiFlag?: null | boolean; contactCallbackUrl?: string; contactLegacyCallbackFlag?: null | boolean; dateInactivated?: string; documentApiFlag?: null | boolean; id?: number; inactivatedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; inactiveFlag?: null | boolean; invoiceApiFlag?: null | boolean; managedServicesApiFlag?: null | boolean; managedServicesAutoChildFlag?: null | boolean; managedServicesChildingFlag?: null | boolean; marketingApiFlag?: null | boolean; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memberApiFlag?: null | boolean; opportunityApiFlag?: null | boolean; opportunityCallbackUrl?: string; opportunityConversionApiFlag?: null | boolean; opportunityLegacyCallbackFlag?: null | boolean; password?: string; productApiFlag?: null | boolean; productCallbackUrl?: string; productLegacyCallbackFlag?: null | boolean; projectApiFlag?: null | boolean; projectCallbackUrl?: string; projectLegacyCallbackFlag?: null | boolean; purchasingApiFlag?: null | boolean; purchasingCallbackUrl?: string; purchasingLegacyCallbackFlag?: null | boolean; reportingApiFlag?: null | boolean; scheduleApiFlag?: null | boolean; scheduleCallbackUrl?: string; scheduleLegacyCallbackFlag?: null | boolean; serviceBoardCallbackUrl?: string; serviceBoardLegacyCallbackFlag?: null | boolean; serviceTicketApiFlag?: null | boolean; systemApiFlag?: null | boolean; timeEntryApiFlag?: null | boolean; timeEntryCallbackUrl?: string; timeEntryLegacyCallbackFlag?: null | boolean; username: string }>

putSystemLdapConfigurationsById

  • putSystemLdapConfigurationsById(id: number, ldapConfiguration: { _info?: {}; domain: string; id?: number; name: string; server: string }): Promise<{ _info?: {}; domain: string; id?: number; name: string; server: string }>

  • Parameters

    • id: number
    • ldapConfiguration: { _info?: {}; domain: string; id?: number; name: string; server: string }
      • Optional _info?: {}
        • [key: string]: string
      • domain: string
        description

        Domain Name of the server. Max length: 50;

      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 100;

      • server: string
        description

        FQDN of the Server. Max length: 200;

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

putSystemLinksById

  • putSystemLinksById(id: number, link: { _info?: {}; id?: number; name: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service"; tableReferenceId?: null | number; url?: string }): Promise<{ _info?: {}; id?: number; name: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service"; tableReferenceId?: null | number; url?: string }>

  • Parameters

    • id: number
    • link: { _info?: {}; id?: number; name: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service"; tableReferenceId?: null | number; url?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 50;

      • Optional screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service"
      • Optional tableReferenceId?: null | number

        Format: int32

      • Optional url?: string
        description

        Max length: 1000;

    Returns Promise<{ _info?: {}; id?: number; name: string; screenLink?: null | "Company" | "Contact" | "Invoice" | "SalesOrder" | "PurchaseOrder" | "Service"; tableReferenceId?: null | number; url?: string }>

putSystemLocationsById

  • putSystemLocationsById(id: number, location: { _info?: {}; calendar?: { _info?: {}; id?: null | number; name?: string }; clientFlag?: null | boolean; departmentIds?: number[]; id?: number; locationFlag?: null | boolean; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; overrideAddressLine1?: string; overrideAddressLine2?: string; overrideCity?: string; overrideCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; overrideFaxNumber?: string; overridePhoneNumber?: string; overrideState?: string; overrideZip?: string; owaUrl?: string; ownerLevelId?: null | number; payrollXref?: string; reportsTo?: { _info?: {}; id?: null | number; name?: string }; salesRep?: string; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; workRoleIds?: number[] }): Promise<{ _info?: {}; calendar?: { _info?: {}; id?: null | number; name?: string }; clientFlag?: null | boolean; departmentIds?: number[]; id?: number; locationFlag?: null | boolean; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; overrideAddressLine1?: string; overrideAddressLine2?: string; overrideCity?: string; overrideCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; overrideFaxNumber?: string; overridePhoneNumber?: string; overrideState?: string; overrideZip?: string; owaUrl?: string; ownerLevelId?: null | number; payrollXref?: string; reportsTo?: { _info?: {}; id?: null | number; name?: string }; salesRep?: string; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; workRoleIds?: number[] }>

  • Parameters

    • id: number
    • location: { _info?: {}; calendar?: { _info?: {}; id?: null | number; name?: string }; clientFlag?: null | boolean; departmentIds?: number[]; id?: number; locationFlag?: null | boolean; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; overrideAddressLine1?: string; overrideAddressLine2?: string; overrideCity?: string; overrideCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; overrideFaxNumber?: string; overridePhoneNumber?: string; overrideState?: string; overrideZip?: string; owaUrl?: string; ownerLevelId?: null | number; payrollXref?: string; reportsTo?: { _info?: {}; id?: null | number; name?: string }; salesRep?: string; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; workRoleIds?: number[] }
      • Optional _info?: {}
        • [key: string]: string
      • Optional calendar?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional clientFlag?: null | boolean
      • Optional departmentIds?: number[]
      • Optional id?: number

        Format: int32

      • Optional locationFlag?: null | boolean
      • Optional manager?: { _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
      • name: string
        description

        Max length: 50;

      • Optional overrideAddressLine1?: string
        description

        Max length: 50;

      • Optional overrideAddressLine2?: string
        description

        Max length: 50;

      • Optional overrideCity?: string
        description

        Max length: 50;

      • Optional overrideCountry?: { _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 overrideFaxNumber?: string
        description

        Max length: 15;

      • Optional overridePhoneNumber?: string
        description

        Max length: 15;

      • Optional overrideState?: string
        description

        Max length: 50;

      • Optional overrideZip?: string
        description

        Max length: 12;

      • Optional owaUrl?: string
        description

        Max length: 100;

      • Optional ownerLevelId?: null | number

        Format: int32

      • Optional payrollXref?: string
        description

        Max length: 10;

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

          Format: int32

        • Optional name?: string
      • Optional salesRep?: string
        description

        Max length: 50;

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

          Format: int32

        • 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 workRoleIds?: number[]

    Returns Promise<{ _info?: {}; calendar?: { _info?: {}; id?: null | number; name?: string }; clientFlag?: null | boolean; departmentIds?: number[]; id?: number; locationFlag?: null | boolean; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; overrideAddressLine1?: string; overrideAddressLine2?: string; overrideCity?: string; overrideCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; overrideFaxNumber?: string; overridePhoneNumber?: string; overrideState?: string; overrideZip?: string; owaUrl?: string; ownerLevelId?: null | number; payrollXref?: string; reportsTo?: { _info?: {}; id?: null | number; name?: string }; salesRep?: string; structureLevel?: { _info?: {}; id?: null | number; name?: string }; timeZoneSetup?: { _info?: {}; id?: null | number; name?: string }; workRoleIds?: number[] }>

putSystemManagementNetworkSecuritiesById

  • putSystemManagementNetworkSecuritiesById(id: number, managementNetworkSecurity: { _info?: {}; id?: number; name: string; password?: string; site: string; username?: string }): Promise<{ _info?: {}; id?: number; name: string; password?: string; site: string; username?: string }>

  • Parameters

    • id: number
    • managementNetworkSecurity: { _info?: {}; id?: number; name: string; password?: string; site: string; username?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 30;

      • Optional password?: string
        description

        Max length: 50;

      • site: string
        description

        Max length: 100;

      • Optional username?: string
        description

        Max length: 50;

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

putSystemMembersById

  • putSystemMembersById(id: number, member: { _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • member: { _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional adminFlag?: null | boolean
      • agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"
      • Optional allowExpensesEnteredAgainstCompaniesFlag?: null | boolean
      • Optional allowInCellEntryOnTimeSheet?: null | boolean
      • Optional authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"
      • Optional autoPopupQuickNotesWithStopwatch?: null | boolean
      • Optional autoStartStopwatch?: null | boolean
      • Optional billableForecast?: null | number

        Format: double

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

          Format: int32

        • Optional name?: string
      • Optional calendarSyncIntegrationFlag?: null | boolean
      • Optional clientId?: string
      • companyActivityTabFormat: null | "SummaryList" | "DetailList"
      • Optional copyColumnLayoutsAndFilters?: boolean
      • Optional copyPodLayouts?: boolean
      • Optional copySharedDefaultViews?: boolean
      • 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 dailyCapacity?: null | number

        Format: double

      • Optional daysTolerance?: null | number

        Format: int32

      • 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
      • defaultEmail: null | "Mobile" | "Office" | "Home"
      • Optional defaultLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • defaultPhone: null | "Mobile" | "Office" | "Home"
      • Optional disableOnlineFlag?: null | boolean
      • Optional employeeIdentifer?: string
        description

        Max length: 10;

      • Optional enableLdapAuthenticationFlag?: null | boolean
      • Optional enableMobileFlag?: null | boolean
      • Optional enableMobileGpsFlag?: null | boolean
      • Optional enterTimeAgainstCompanyFlag?: null | boolean
      • Optional excludedProjectBoardIds?: number[]
      • Optional excludedServiceBoardIds?: number[]
      • Optional expenseApprover?: { _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
      • firstName: string
        description

        Max length: 30;

      • Optional fromMemberRecId?: number

        Format: int32

      • Optional globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"
      • Optional globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"
      • Optional hideMemberInDispatchPortalFlag?: null | boolean
      • hireDate: string

        Format: date-time

      • Optional homeEmail?: string
        description

        Max length: 250;

      • Optional homeExtension?: string
        description

        Max length: 10;

      • Optional homePhone?: string
        description

        Max length: 15;

      • Optional hourlyCost?: null | number

        Format: double

      • Optional hourlyRate?: null | number

        Format: double

      • Optional id?: number

        Format: int32

      • identifier: string
        description

        Max length: 15;

      • Optional inactiveDate?: string

        Format: date-time

      • Optional inactiveFlag?: null | boolean
      • Optional includeInUtilizationReportingFlag?: null | boolean
      • invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"
      • invoiceTimeTabFormat: null | "SummaryList" | "DetailList"
      • invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"
      • Optional lastLogin?: string
      • lastName: string
        description

        Max length: 30;

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

          Format: int32

        • Optional name?: string
        • Optional server?: string
      • Optional ldapUserName?: string
        description

        Max length: 50;

      • licenseClass: null | "A" | "C" | "F" | "X"
        description

        F = Full Member, A = API Member, C = StreamlineIT Member, X = Subcontractor Member

      • Optional mapiName?: string
      • Optional memberPersonas?: number[]
      • Optional middleInitial?: string
        description

        Max length: 1;

      • Optional minimumHours?: null | number

        Format: double

      • Optional mobileEmail?: string
        description

        Max length: 250;

      • Optional mobileExtension?: string
        description

        Max length: 10;

      • Optional mobilePhone?: string
        description

        Max length: 15;

      • Optional notes?: string
      • Optional office365?: { id?: string; name?: string }
        • Optional id?: string
        • Optional name?: string
      • Optional officeEmail?: string
        description

        Max length: 250;

      • Optional officeExtension?: string
        description

        Max length: 10;

      • Optional officePhone?: string
        description

        Max length: 15;

      • Optional partnerPortalFlag?: null | boolean
      • Optional password?: string
        description

        ConditionallyRequired. API Member will get random password generated Max length: 60;

      • Optional phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"
      • Optional phoneSource?: string
      • Optional photo?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional primaryEmail?: string
        description

        Max length: 250;

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

          Format: int32

        • Optional name?: string
      • Optional projectDefaultDepartment?: { _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 projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional reportsTo?: { _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 requireExpenseEntryFlag?: null | boolean
      • Optional requireStartAndEndTimeOnTimeEntryFlag?: null | boolean
      • Optional requireTimeSheetEntryFlag?: null | boolean
      • Optional restrictDefaultSalesTerritoryFlag?: null | boolean
      • Optional restrictDefaultWarehouseBinFlag?: null | boolean
      • Optional restrictDefaultWarehouseFlag?: null | boolean
      • Optional restrictDepartmentFlag?: null | boolean
      • Optional restrictLocationFlag?: null | boolean
      • Optional restrictProjectDefaultDepartmentFlag?: null | boolean
      • Optional restrictProjectDefaultLocationFlag?: null | boolean
      • Optional restrictScheduleFlag?: null | boolean
      • Optional restrictServiceDefaultDepartmentFlag?: null | boolean
      • Optional restrictServiceDefaultLocationFlag?: null | boolean
      • Optional salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

        Format: double

      • Optional scheduleDefaultDepartment?: { _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 scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional serviceDefaultDepartment?: { _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 serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional signature?: string
      • Optional ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional email?: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional stsUserAdminUrl?: string
      • Optional timeApprover?: { _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 timeReminderEmailFlag?: null | boolean
      • Optional timeSheetStartDate?: string

        Format: date-time

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

          Format: int32

        • Optional name?: string
      • Optional timebasedOneTimePasswordActivated?: null | boolean
      • Optional title?: string
        description

        Max length: 50;

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

          Format: int32

        • Optional name?: string
      • Optional useBrowserLanguageFlag?: null | boolean
      • Optional vendorNumber?: string
      • Optional warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; adminFlag?: null | boolean; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableLdapAuthenticationFlag?: null | boolean; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; excludedProjectBoardIds?: number[]; excludedServiceBoardIds?: number[]; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; hourlyCost?: null | number; hourlyRate?: null | number; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; ldapConfiguration?: { _info?: {}; id?: null | number; name?: string; server?: string }; ldapUserName?: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; restrictDefaultSalesTerritoryFlag?: null | boolean; restrictDefaultWarehouseBinFlag?: null | boolean; restrictDefaultWarehouseFlag?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictLocationFlag?: null | boolean; restrictProjectDefaultDepartmentFlag?: null | boolean; restrictProjectDefaultLocationFlag?: null | boolean; restrictScheduleFlag?: null | boolean; restrictServiceDefaultDepartmentFlag?: null | boolean; restrictServiceDefaultLocationFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; securityLocation?: { _info?: {}; id?: null | number; name?: string }; securityRole?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; ssoSettings?: { _info?: {}; email?: string; id?: null | number; ssoUserId?: string; userName?: string }; structureLevel?: { _info?: {}; id?: null | number; name?: string }; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

putSystemMembersByParentIdAccrualsById

  • putSystemMembersByParentIdAccrualsById(id: number, parentId: number, memberAccrual: { _info?: {}; accrualType: null | "Holiday" | "PTO" | "Sick" | "Vacation"; hours: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; reason: string; year: null | number }): Promise<{ _info?: {}; accrualType: null | "Holiday" | "PTO" | "Sick" | "Vacation"; hours: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; reason: string; year: null | number }>

  • Parameters

    • id: number
    • parentId: number
    • memberAccrual: { _info?: {}; accrualType: null | "Holiday" | "PTO" | "Sick" | "Vacation"; hours: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; reason: string; year: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • accrualType: null | "Holiday" | "PTO" | "Sick" | "Vacation"
      • hours: null | number

        Format: double

      • 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
      • reason: string
      • year: null | number

        Format: int32

    Returns Promise<{ _info?: {}; accrualType: null | "Holiday" | "PTO" | "Sick" | "Vacation"; hours: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; reason: string; year: null | number }>

putSystemMembersByParentIdCertificationsById

  • putSystemMembersByParentIdCertificationsById(id: number, parentId: number, memberCertification: { _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }): Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }>

  • Parameters

    • id: number
    • parentId: number
    • memberCertification: { _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • certification: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional certificationNumber?: 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 dateExpires?: string

        Format: date-time

      • Optional dateReceived?: string

        Format: date-time

      • 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 notes?: string
      • Optional percentComplete?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }>

putSystemMembersByParentIdDelegationsById

  • putSystemMembersByParentIdDelegationsById(id: number, parentId: number, memberDelegation: { _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • memberDelegation: { _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • dateEnd: string

        Format: date-time

      • dateStart: string

        Format: date-time

      • Optional delegatedTo?: { _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
      • delegationType: null | "Project" | "Approval"
      • 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

    Returns Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

putSystemMembersByParentIdManagedDeviceAccountsBulk

  • putSystemMembersByParentIdManagedDeviceAccountsBulk(parentId: number, managedDeviceAccounts: { _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; password?: string; username?: string }[]): 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 }[] }>

  • Parameters

    • parentId: number
    • managedDeviceAccounts: { _info?: {}; id?: number; managedDevicesIntegration?: { _info?: {}; id?: null | number; name?: string }; password?: string; username?: string }[]

    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 }[] }>

putSystemMembersByParentIdMycertificationsById

  • putSystemMembersByParentIdMycertificationsById(id: number, parentId: number, memberCertification: { _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }): Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }>

  • Parameters

    • id: number
    • parentId: number
    • memberCertification: { _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • certification: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional certificationNumber?: 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 dateExpires?: string

        Format: date-time

      • Optional dateReceived?: string

        Format: date-time

      • 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 notes?: string
      • Optional percentComplete?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; certification: { _info?: {}; id?: null | number; name?: string }; certificationNumber?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateExpires?: string; dateReceived?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; percentComplete?: null | number }>

putSystemMembersByParentIdNotificationSettingsById

  • putSystemMembersByParentIdNotificationSettingsById(id: number, parentId: number, memberNotificationSetting: { _info?: {}; id?: number; notificationTrigger: null | "ExpenseReport" | "ActivityStatusReq" | "CustomerUpdated" | "TicketStatusChange" | "TicketStatusRequest" | "TimeNagApprover" | "TimeNagMember" | "TimeSheet" | "WorkflowRules"; notificationType: null | "Email" | "Push" }): Promise<{ _info?: {}; id?: number; notificationTrigger: null | "ExpenseReport" | "ActivityStatusReq" | "CustomerUpdated" | "TicketStatusChange" | "TicketStatusRequest" | "TimeNagApprover" | "TimeNagMember" | "TimeSheet" | "WorkflowRules"; notificationType: null | "Email" | "Push" }>

  • Parameters

    • id: number
    • parentId: number
    • memberNotificationSetting: { _info?: {}; id?: number; notificationTrigger: null | "ExpenseReport" | "ActivityStatusReq" | "CustomerUpdated" | "TicketStatusChange" | "TicketStatusRequest" | "TimeNagApprover" | "TimeNagMember" | "TimeSheet" | "WorkflowRules"; notificationType: null | "Email" | "Push" }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • notificationTrigger: null | "ExpenseReport" | "ActivityStatusReq" | "CustomerUpdated" | "TicketStatusChange" | "TicketStatusRequest" | "TimeNagApprover" | "TimeNagMember" | "TimeSheet" | "WorkflowRules"
      • notificationType: null | "Email" | "Push"

    Returns Promise<{ _info?: {}; id?: number; notificationTrigger: null | "ExpenseReport" | "ActivityStatusReq" | "CustomerUpdated" | "TicketStatusChange" | "TicketStatusRequest" | "TimeNagApprover" | "TimeNagMember" | "TimeSheet" | "WorkflowRules"; notificationType: null | "Email" | "Push" }>

putSystemMembersByParentIdSkillsById

  • putSystemMembersByParentIdSkillsById(id: number, parentId: number, memberSkill: { _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }): Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }>

  • Parameters

    • id: number
    • parentId: number
    • memberSkill: { _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional certifiedFlag?: 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 notes?: string
      • skill: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"
      • Optional yearsExperience?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }>

putSystemMembersTypesById

  • putSystemMembersTypesById(id: number, type: { _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string }): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name: string }>

  • Parameters

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

        Format: int32

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

        Max length: 30;

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

putSystemMenuentriesById

  • putSystemMenuentriesById(id: number, menuEntry: { _info?: {}; addAllLocations?: null | boolean; caption: string; clientId?: string; id?: number; largeMenuIconId?: null | number; link: string; locationIds?: number[]; menuLocation?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag: null | boolean; origin?: string; removeAllLocations?: null | boolean; smallMenuIconId?: null | number }): Promise<{ _info?: {}; addAllLocations?: null | boolean; caption: string; clientId?: string; id?: number; largeMenuIconId?: null | number; link: string; locationIds?: number[]; menuLocation?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag: null | boolean; origin?: string; removeAllLocations?: null | boolean; smallMenuIconId?: null | number }>

  • Parameters

    • id: number
    • menuEntry: { _info?: {}; addAllLocations?: null | boolean; caption: string; clientId?: string; id?: number; largeMenuIconId?: null | number; link: string; locationIds?: number[]; menuLocation?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag: null | boolean; origin?: string; removeAllLocations?: null | boolean; smallMenuIconId?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addAllLocations?: null | boolean
      • caption: string
        description

        Max length: 50;

      • Optional clientId?: string
        description

        Only required if not already set Max length: 36;

      • Optional id?: number

        Format: int32

      • Optional largeMenuIconId?: null | number

        Format: int32

      • link: string
        description

        Max length: 2000;

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

          Format: int32

        • Optional name?: string
      • newWindowFlag: null | boolean
      • Optional origin?: string
        description

        Max length: 2000;

      • Optional removeAllLocations?: null | boolean
      • Optional smallMenuIconId?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; addAllLocations?: null | boolean; caption: string; clientId?: string; id?: number; largeMenuIconId?: null | number; link: string; locationIds?: number[]; menuLocation?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag: null | boolean; origin?: string; removeAllLocations?: null | boolean; smallMenuIconId?: null | number }>

putSystemMyAccountById

  • putSystemMyAccountById(id: number, myAccount: { _info?: {}; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • myAccount: { _info?: {}; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"
      • Optional allowExpensesEnteredAgainstCompaniesFlag?: null | boolean
      • Optional allowInCellEntryOnTimeSheet?: null | boolean
      • Optional authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"
      • Optional autoPopupQuickNotesWithStopwatch?: null | boolean
      • Optional autoStartStopwatch?: null | boolean
      • Optional billableForecast?: null | number

        Format: double

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

          Format: int32

        • Optional name?: string
      • Optional calendarSyncIntegrationFlag?: null | boolean
      • Optional clientId?: string
      • companyActivityTabFormat: null | "SummaryList" | "DetailList"
      • Optional copyColumnLayoutsAndFilters?: boolean
      • Optional copyPodLayouts?: boolean
      • Optional copySharedDefaultViews?: boolean
      • 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 dailyCapacity?: null | number

        Format: double

      • Optional daysTolerance?: null | number

        Format: int32

      • 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
      • defaultEmail: null | "Mobile" | "Office" | "Home"
      • Optional defaultLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • defaultPhone: null | "Mobile" | "Office" | "Home"
      • Optional disableOnlineFlag?: null | boolean
      • Optional employeeIdentifer?: string
        description

        Max length: 10;

      • Optional enableMobileFlag?: null | boolean
      • Optional enableMobileGpsFlag?: null | boolean
      • Optional enterTimeAgainstCompanyFlag?: null | boolean
      • Optional expenseApprover?: { _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
      • firstName: string
        description

        Max length: 30;

      • Optional fromMemberRecId?: number

        Format: int32

      • Optional globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"
      • Optional globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"
      • Optional hideMemberInDispatchPortalFlag?: null | boolean
      • hireDate: string

        Format: date-time

      • Optional homeEmail?: string
        description

        Max length: 250;

      • Optional homeExtension?: string
        description

        Max length: 10;

      • Optional homePhone?: string
        description

        Max length: 15;

      • Optional id?: number

        Format: int32

      • identifier: string
        description

        Max length: 15;

      • Optional inactiveDate?: string

        Format: date-time

      • Optional inactiveFlag?: null | boolean
      • Optional includeInUtilizationReportingFlag?: null | boolean
      • invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"
      • invoiceTimeTabFormat: null | "SummaryList" | "DetailList"
      • invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"
      • Optional lastLogin?: string
      • lastName: string
        description

        Max length: 30;

      • licenseClass: null | "A" | "C" | "F" | "X"
        description

        F = Full Member, A = API Member, C = StreamlineIT Member, X = Subcontractor Member

      • Optional mapiName?: string
      • Optional memberPersonas?: number[]
      • Optional middleInitial?: string
        description

        Max length: 1;

      • Optional minimumHours?: null | number

        Format: double

      • Optional mobileEmail?: string
        description

        Max length: 250;

      • Optional mobileExtension?: string
        description

        Max length: 10;

      • Optional mobilePhone?: string
        description

        Max length: 15;

      • Optional notes?: string
      • Optional office365?: { id?: string; name?: string }
        • Optional id?: string
        • Optional name?: string
      • Optional officeEmail?: string
        description

        Max length: 250;

      • Optional officeExtension?: string
        description

        Max length: 10;

      • Optional officePhone?: string
        description

        Max length: 15;

      • Optional partnerPortalFlag?: null | boolean
      • Optional password?: string
        description

        ConditionallyRequired. API Member will get random password generated Max length: 60;

      • Optional phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"
      • Optional phoneSource?: string
      • Optional photo?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional primaryEmail?: string
        description

        Max length: 250;

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

          Format: int32

        • Optional name?: string
      • Optional projectDefaultDepartment?: { _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 projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional reportsTo?: { _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 requireExpenseEntryFlag?: null | boolean
      • Optional requireStartAndEndTimeOnTimeEntryFlag?: null | boolean
      • Optional requireTimeSheetEntryFlag?: null | boolean
      • Optional salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

        Format: double

      • Optional scheduleDefaultDepartment?: { _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 scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional serviceDefaultDepartment?: { _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 serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional signature?: string
      • Optional stsUserAdminUrl?: string
      • Optional timeApprover?: { _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 timeReminderEmailFlag?: null | boolean
      • Optional timeSheetStartDate?: string

        Format: date-time

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

          Format: int32

        • Optional name?: string
      • Optional timebasedOneTimePasswordActivated?: null | boolean
      • Optional title?: string
        description

        Max length: 50;

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

          Format: int32

        • Optional name?: string
      • Optional useBrowserLanguageFlag?: null | boolean
      • Optional vendorNumber?: string
      • Optional warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; agreementInvoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; allowExpensesEnteredAgainstCompaniesFlag?: null | boolean; allowInCellEntryOnTimeSheet?: null | boolean; authenticationServiceType?: null | "Email" | "AuthAnvil" | "GoogleAuthenticator"; autoPopupQuickNotesWithStopwatch?: null | boolean; autoStartStopwatch?: null | boolean; billableForecast?: null | number; calendar?: { _info?: {}; id?: null | number; name?: string }; calendarSyncIntegrationFlag?: null | boolean; clientId?: string; companyActivityTabFormat: null | "SummaryList" | "DetailList"; copyColumnLayoutsAndFilters?: boolean; copyPodLayouts?: boolean; copySharedDefaultViews?: boolean; 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?: {} }[]; dailyCapacity?: null | number; daysTolerance?: null | number; defaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultEmail: null | "Mobile" | "Office" | "Home"; defaultLocation?: { _info?: {}; id?: null | number; name?: string }; defaultPhone: null | "Mobile" | "Office" | "Home"; disableOnlineFlag?: null | boolean; employeeIdentifer?: string; enableMobileFlag?: null | boolean; enableMobileGpsFlag?: null | boolean; enterTimeAgainstCompanyFlag?: null | boolean; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; firstName: string; fromMemberRecId?: number; globalSearchDefaultSort?: null | "None" | "LastUpdatedDesc" | "LastUpdatedAsc" | "CreatedDesc" | "CreatedAsc"; globalSearchDefaultTicketFilter?: null | "OpenRecords" | "ClosedRecords" | "AllRecords"; hideMemberInDispatchPortalFlag?: null | boolean; hireDate: string; homeEmail?: string; homeExtension?: string; homePhone?: string; id?: number; identifier: string; inactiveDate?: string; inactiveFlag?: null | boolean; includeInUtilizationReportingFlag?: null | boolean; invoiceScreenDefaultTabFormat: null | "ShowInvoicingTab" | "ShowAgreementInvoicingTab"; invoiceTimeTabFormat: null | "SummaryList" | "DetailList"; invoicingDisplayOptions: null | "RemainOnInvoicingScreen" | "ShowRecentInvoices"; lastLogin?: string; lastName: string; licenseClass: null | "A" | "C" | "F" | "X"; mapiName?: string; memberPersonas?: number[]; middleInitial?: string; minimumHours?: null | number; mobileEmail?: string; mobileExtension?: string; mobilePhone?: string; notes?: string; office365?: { id?: string; name?: string }; officeEmail?: string; officeExtension?: string; officePhone?: string; partnerPortalFlag?: null | boolean; password?: string; phoneIntegrationType?: null | "TAPI" | "SKYPE" | "NONE"; phoneSource?: string; photo?: { _info?: {}; id?: null | number; name?: string }; primaryEmail?: string; projectDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; projectDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; reportsTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; requireExpenseEntryFlag?: null | boolean; requireStartAndEndTimeOnTimeEntryFlag?: null | boolean; requireTimeSheetEntryFlag?: null | boolean; salesDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; scheduleCapacity?: null | number; scheduleDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; scheduleDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceBoardTeamIds?: number[]; serviceDefaultBoard?: { _info?: {}; id?: null | number; name?: string }; serviceDefaultDepartment?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceDefaultLocation?: { _info?: {}; id?: null | number; name?: string }; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; signature?: string; stsUserAdminUrl?: string; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; timeReminderEmailFlag?: null | boolean; timeSheetStartDate?: string; timeZone?: { _info?: {}; id?: null | number; name?: string }; timebasedOneTimePasswordActivated?: null | boolean; title?: string; toastNotificationFlag?: null | boolean; token?: string; type?: { _info?: {}; id?: null | number; name?: string }; useBrowserLanguageFlag?: null | boolean; vendorNumber?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string }; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

putSystemMyAccountByParentIdDelegationsById

  • putSystemMyAccountByParentIdDelegationsById(id: number, parentId: number, memberDelegation: { _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • memberDelegation: { _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • dateEnd: string

        Format: date-time

      • dateStart: string

        Format: date-time

      • Optional delegatedTo?: { _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
      • delegationType: null | "Project" | "Approval"
      • 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

    Returns Promise<{ _info?: {}; dateEnd: string; dateStart: string; delegatedTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; delegationType: null | "Project" | "Approval"; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

putSystemMyAccountByParentIdSkillsById

  • putSystemMyAccountByParentIdSkillsById(id: number, parentId: number, memberSkill: { _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }): Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }>

  • Parameters

    • id: number
    • parentId: number
    • memberSkill: { _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional certifiedFlag?: 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 notes?: string
      • skill: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"
      • Optional yearsExperience?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; certifiedFlag?: null | boolean; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notes?: string; skill: { _info?: {}; id?: null | number; name?: string }; skillLevel: null | "Beginner" | "Intermediate" | "Advanced" | "Expert"; yearsExperience?: null | number }>

putSystemMyCompanyCorporateStructureById

  • putSystemMyCompanyCorporateStructureById(id: number, corporateStructure: { _info?: {}; baseCurrency: { _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 }; chiefOperatingOfficer?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; controller?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatcher?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; fiscalYearStart: null | "January" | "February" | "March" | "April" | "May" | "June" | "July" | "August" | "September" | "October" | "November" | "December"; groupCaption: string; id?: number; level1Name?: string; level2Name?: string; level3Name?: string; level4Name?: string; level5Name?: string; levelCount?: null | "Level1" | "Level2" | "Level3" | "Level4" | "Level5"; locationCaption: string; president?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; baseCurrency: { _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 }; chiefOperatingOfficer?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; controller?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatcher?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; fiscalYearStart: null | "January" | "February" | "March" | "April" | "May" | "June" | "July" | "August" | "September" | "October" | "November" | "December"; groupCaption: string; id?: number; level1Name?: string; level2Name?: string; level3Name?: string; level4Name?: string; level5Name?: string; levelCount?: null | "Level1" | "Level2" | "Level3" | "Level4" | "Level5"; locationCaption: string; president?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • id: number
    • corporateStructure: { _info?: {}; baseCurrency: { _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 }; chiefOperatingOfficer?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; controller?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatcher?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; fiscalYearStart: null | "January" | "February" | "March" | "April" | "May" | "June" | "July" | "August" | "September" | "October" | "November" | "December"; groupCaption: string; id?: number; level1Name?: string; level2Name?: string; level3Name?: string; level4Name?: string; level5Name?: string; levelCount?: null | "Level1" | "Level2" | "Level3" | "Level4" | "Level5"; locationCaption: string; president?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • baseCurrency: { _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 chiefOperatingOfficer?: { _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 controller?: { _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 dispatcher?: { _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 dutyManager?: { _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
      • fiscalYearStart: null | "January" | "February" | "March" | "April" | "May" | "June" | "July" | "August" | "September" | "October" | "November" | "December"
      • groupCaption: string
        description

        Max length: 50;

      • Optional id?: number

        Format: int32

      • Optional level1Name?: string
        description

        Max length: 20;

      • Optional level2Name?: string
        description

        Max length: 20;

      • Optional level3Name?: string
        description

        Max length: 20;

      • Optional level4Name?: string
        description

        Max length: 20;

      • Optional level5Name?: string
        description

        Max length: 20;

      • Optional levelCount?: null | "Level1" | "Level2" | "Level3" | "Level4" | "Level5"
      • locationCaption: string
        description

        Max length: 50;

      • Optional president?: { _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 serviceManager?: { _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?: {}; baseCurrency: { _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 }; chiefOperatingOfficer?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; controller?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dispatcher?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dutyManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; fiscalYearStart: null | "January" | "February" | "March" | "April" | "May" | "June" | "July" | "August" | "September" | "October" | "November" | "December"; groupCaption: string; id?: number; level1Name?: string; level2Name?: string; level3Name?: string; level4Name?: string; level5Name?: string; levelCount?: null | "Level1" | "Level2" | "Level3" | "Level4" | "Level5"; locationCaption: string; president?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; serviceManager?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

putSystemMyCompanyCrmById

  • putSystemMyCompanyCrmById(id: number, crm: { _info?: {}; accountManagerRole?: { _info?: {}; id?: null | number; name?: string }; companyIdGenerationFlag?: null | boolean; companyListCount?: null | number; defaultYear?: null | boolean; excludeSpacesFlag?: null | boolean; field10Caption?: string; field1Caption?: string; field2Caption?: string; field3Caption?: string; field4Caption?: string; field5Caption?: string; field6Caption?: string; field7Caption?: string; field8Caption?: string; field9Caption?: string; id?: number; lockProbabilityFlag?: null | boolean; other1Caption?: string; other2Caption?: string; primaryRepCaption?: string; salesRepRole?: { _info?: {}; id?: null | number; name?: string }; secondaryRepCaption?: string; technicalContactRole?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; accountManagerRole?: { _info?: {}; id?: null | number; name?: string }; companyIdGenerationFlag?: null | boolean; companyListCount?: null | number; defaultYear?: null | boolean; excludeSpacesFlag?: null | boolean; field10Caption?: string; field1Caption?: string; field2Caption?: string; field3Caption?: string; field4Caption?: string; field5Caption?: string; field6Caption?: string; field7Caption?: string; field8Caption?: string; field9Caption?: string; id?: number; lockProbabilityFlag?: null | boolean; other1Caption?: string; other2Caption?: string; primaryRepCaption?: string; salesRepRole?: { _info?: {}; id?: null | number; name?: string }; secondaryRepCaption?: string; technicalContactRole?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • crm: { _info?: {}; accountManagerRole?: { _info?: {}; id?: null | number; name?: string }; companyIdGenerationFlag?: null | boolean; companyListCount?: null | number; defaultYear?: null | boolean; excludeSpacesFlag?: null | boolean; field10Caption?: string; field1Caption?: string; field2Caption?: string; field3Caption?: string; field4Caption?: string; field5Caption?: string; field6Caption?: string; field7Caption?: string; field8Caption?: string; field9Caption?: string; id?: number; lockProbabilityFlag?: null | boolean; other1Caption?: string; other2Caption?: string; primaryRepCaption?: string; salesRepRole?: { _info?: {}; id?: null | number; name?: string }; secondaryRepCaption?: string; technicalContactRole?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional accountManagerRole?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional companyIdGenerationFlag?: null | boolean
      • Optional companyListCount?: null | number

        Format: int32

      • Optional defaultYear?: null | boolean
      • Optional excludeSpacesFlag?: null | boolean
      • Optional field10Caption?: string
        description

        Max length: 25;

      • Optional field1Caption?: string
        description

        Max length: 25;

      • Optional field2Caption?: string
        description

        Max length: 25;

      • Optional field3Caption?: string
        description

        Max length: 25;

      • Optional field4Caption?: string
        description

        Max length: 25;

      • Optional field5Caption?: string
        description

        Max length: 25;

      • Optional field6Caption?: string
        description

        Max length: 25;

      • Optional field7Caption?: string
        description

        Max length: 25;

      • Optional field8Caption?: string
        description

        Max length: 25;

      • Optional field9Caption?: string
        description

        Max length: 25;

      • Optional id?: number

        Format: int32

      • Optional lockProbabilityFlag?: null | boolean
      • Optional other1Caption?: string
        description

        Max length: 50;

      • Optional other2Caption?: string
        description

        Max length: 50;

      • Optional primaryRepCaption?: string
        description

        Max length: 50;

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

          Format: int32

        • Optional name?: string
      • Optional secondaryRepCaption?: string
        description

        Max length: 50;

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

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; accountManagerRole?: { _info?: {}; id?: null | number; name?: string }; companyIdGenerationFlag?: null | boolean; companyListCount?: null | number; defaultYear?: null | boolean; excludeSpacesFlag?: null | boolean; field10Caption?: string; field1Caption?: string; field2Caption?: string; field3Caption?: string; field4Caption?: string; field5Caption?: string; field6Caption?: string; field7Caption?: string; field8Caption?: string; field9Caption?: string; id?: number; lockProbabilityFlag?: null | boolean; other1Caption?: string; other2Caption?: string; primaryRepCaption?: string; salesRepRole?: { _info?: {}; id?: null | number; name?: string }; secondaryRepCaption?: string; technicalContactRole?: { _info?: {}; id?: null | number; name?: string } }>

putSystemMyCompanyOtherById

  • putSystemMyCompanyOtherById(id: number, other: { _info?: {}; contactSync?: null | "FL" | "LF" | "CFL" | "CLF"; defaultAddressFormat?: { _info?: {}; id?: null | number; name?: string }; defaultCalendar?: { _info?: {}; id?: null | number; name?: string }; defaultFromAddress: string; defaultLdap?: { _info?: {}; id?: null | number; name?: string; server?: string }; disableZAdminLoginFlag?: null | boolean; id?: number; includePortalLinkFlag?: null | boolean; locale?: { _info?: {}; id?: null | number; name?: string }; logoPath?: string; portalUrlOverride: string; serverTimeZone?: { _info?: {}; id?: null | number; name?: string }; siteUrl: string; syncLeadsFlag?: null | boolean; updateMemberTimeZonesFlag?: null | boolean; useExpandedFormatActivityFlag?: null | boolean; useExpandedFormatTimeFlag?: null | boolean; useSslFlag?: null | boolean }): Promise<{ _info?: {}; contactSync?: null | "FL" | "LF" | "CFL" | "CLF"; defaultAddressFormat?: { _info?: {}; id?: null | number; name?: string }; defaultCalendar?: { _info?: {}; id?: null | number; name?: string }; defaultFromAddress: string; defaultLdap?: { _info?: {}; id?: null | number; name?: string; server?: string }; disableZAdminLoginFlag?: null | boolean; id?: number; includePortalLinkFlag?: null | boolean; locale?: { _info?: {}; id?: null | number; name?: string }; logoPath?: string; portalUrlOverride: string; serverTimeZone?: { _info?: {}; id?: null | number; name?: string }; siteUrl: string; syncLeadsFlag?: null | boolean; updateMemberTimeZonesFlag?: null | boolean; useExpandedFormatActivityFlag?: null | boolean; useExpandedFormatTimeFlag?: null | boolean; useSslFlag?: null | boolean }>

  • Parameters

    • id: number
    • other: { _info?: {}; contactSync?: null | "FL" | "LF" | "CFL" | "CLF"; defaultAddressFormat?: { _info?: {}; id?: null | number; name?: string }; defaultCalendar?: { _info?: {}; id?: null | number; name?: string }; defaultFromAddress: string; defaultLdap?: { _info?: {}; id?: null | number; name?: string; server?: string }; disableZAdminLoginFlag?: null | boolean; id?: number; includePortalLinkFlag?: null | boolean; locale?: { _info?: {}; id?: null | number; name?: string }; logoPath?: string; portalUrlOverride: string; serverTimeZone?: { _info?: {}; id?: null | number; name?: string }; siteUrl: string; syncLeadsFlag?: null | boolean; updateMemberTimeZonesFlag?: null | boolean; useExpandedFormatActivityFlag?: null | boolean; useExpandedFormatTimeFlag?: null | boolean; useSslFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional contactSync?: null | "FL" | "LF" | "CFL" | "CLF"
      • Optional defaultAddressFormat?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

        • Optional name?: string
      • defaultFromAddress: string
        description

        Max length: 50;

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

          Format: int32

        • Optional name?: string
        • Optional server?: string
      • Optional disableZAdminLoginFlag?: null | boolean
      • Optional id?: number

        Format: int32

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

          Format: int32

        • Optional name?: string
      • Optional logoPath?: string
        description

        Max length: 200;

      • portalUrlOverride: string
        description

        Max length: 100;

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

          Format: int32

        • Optional name?: string
      • siteUrl: string
        description

        Max length: 100;

      • Optional syncLeadsFlag?: null | boolean
      • Optional updateMemberTimeZonesFlag?: null | boolean
        description

        If true, all Members time zone will also be set to serverTimeZone. Otherwise, only My Company time zone will be updated.

      • Optional useExpandedFormatActivityFlag?: null | boolean
      • Optional useExpandedFormatTimeFlag?: null | boolean
      • Optional useSslFlag?: null | boolean

    Returns Promise<{ _info?: {}; contactSync?: null | "FL" | "LF" | "CFL" | "CLF"; defaultAddressFormat?: { _info?: {}; id?: null | number; name?: string }; defaultCalendar?: { _info?: {}; id?: null | number; name?: string }; defaultFromAddress: string; defaultLdap?: { _info?: {}; id?: null | number; name?: string; server?: string }; disableZAdminLoginFlag?: null | boolean; id?: number; includePortalLinkFlag?: null | boolean; locale?: { _info?: {}; id?: null | number; name?: string }; logoPath?: string; portalUrlOverride: string; serverTimeZone?: { _info?: {}; id?: null | number; name?: string }; siteUrl: string; syncLeadsFlag?: null | boolean; updateMemberTimeZonesFlag?: null | boolean; useExpandedFormatActivityFlag?: null | boolean; useExpandedFormatTimeFlag?: null | boolean; useSslFlag?: null | boolean }>

putSystemMyCompanyTimeExpenseById

  • putSystemMyCompanyTimeExpenseById(id: number, timeExpense: { _info?: {}; defaultSpecialInvoiceType?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; disableTimeEntryFlag?: null | boolean; id?: number; internalCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; invoiceStart?: null | number; requireExpenseNoteFlag?: null | boolean; requireTimeNoteFlag?: null | boolean; roundingFactor?: null | number; tier1ApprovalFlag?: null | boolean; tier2ApprovalFlag?: null | boolean }): Promise<{ _info?: {}; defaultSpecialInvoiceType?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; disableTimeEntryFlag?: null | boolean; id?: number; internalCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; invoiceStart?: null | number; requireExpenseNoteFlag?: null | boolean; requireTimeNoteFlag?: null | boolean; roundingFactor?: null | number; tier1ApprovalFlag?: null | boolean; tier2ApprovalFlag?: null | boolean }>

  • Parameters

    • id: number
    • timeExpense: { _info?: {}; defaultSpecialInvoiceType?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; disableTimeEntryFlag?: null | boolean; id?: number; internalCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; invoiceStart?: null | number; requireExpenseNoteFlag?: null | boolean; requireTimeNoteFlag?: null | boolean; roundingFactor?: null | number; tier1ApprovalFlag?: null | boolean; tier2ApprovalFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional defaultSpecialInvoiceType?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"
      • Optional disableTimeEntryFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional internalCompany?: { _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 invoiceStart?: null | number

        Format: int32

      • Optional requireExpenseNoteFlag?: null | boolean
      • Optional requireTimeNoteFlag?: null | boolean
      • Optional roundingFactor?: null | number

        Format: double

      • Optional tier1ApprovalFlag?: null | boolean
      • Optional tier2ApprovalFlag?: null | boolean

    Returns Promise<{ _info?: {}; defaultSpecialInvoiceType?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; disableTimeEntryFlag?: null | boolean; id?: number; internalCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; invoiceStart?: null | number; requireExpenseNoteFlag?: null | boolean; requireTimeNoteFlag?: null | boolean; roundingFactor?: null | number; tier1ApprovalFlag?: null | boolean; tier2ApprovalFlag?: null | boolean }>

putSystemMycompanyDocumentsById

  • putSystemMycompanyDocumentsById(id: number, document: { _info?: {}; docPath?: string; id?: number; isPublicFlag?: null | boolean; templateOutputPath?: string; templatePath?: string; uploadAsLinkFlag?: null | boolean }): Promise<{ _info?: {}; docPath?: string; id?: number; isPublicFlag?: null | boolean; templateOutputPath?: string; templatePath?: string; uploadAsLinkFlag?: null | boolean }>

  • Parameters

    • id: number
    • document: { _info?: {}; docPath?: string; id?: number; isPublicFlag?: null | boolean; templateOutputPath?: string; templatePath?: string; uploadAsLinkFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional docPath?: string
        description

        Max length: 100;

      • Optional id?: number

        Format: int32

      • Optional isPublicFlag?: null | boolean
      • Optional templateOutputPath?: string
        description

        Max length: 200;

      • Optional templatePath?: string
        description

        Max length: 200;

      • Optional uploadAsLinkFlag?: null | boolean

    Returns Promise<{ _info?: {}; docPath?: string; id?: number; isPublicFlag?: null | boolean; templateOutputPath?: string; templatePath?: string; uploadAsLinkFlag?: null | boolean }>

putSystemMycompanyReportingServicesById

  • putSystemMycompanyReportingServicesById(id: number, service: { _info?: {}; id?: number; reportingDomain?: string; reportingPassword?: string; reportingUrl?: string; reportingUserName?: string }): Promise<{ _info?: {}; id?: number; reportingDomain?: string; reportingPassword?: string; reportingUrl?: string; reportingUserName?: string }>

  • Parameters

    • id: number
    • service: { _info?: {}; id?: number; reportingDomain?: string; reportingPassword?: string; reportingUrl?: string; reportingUserName?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional reportingDomain?: string
        description

        Max length: 50;

      • Optional reportingPassword?: string
        description

        To blank out the password, enter an empty string here. Max length: 50;

      • Optional reportingUrl?: string
        description

        Max length: 100;

      • Optional reportingUserName?: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; id?: number; reportingDomain?: string; reportingPassword?: string; reportingUrl?: string; reportingUserName?: string }>

putSystemMycompanyServicesById

  • putSystemMycompanyServicesById(id: number, service: { _info?: {}; allowCCFlag?: null | boolean; allowTOFlag?: null | boolean; calendarSetup?: { _info?: {}; id?: null | number }; contactColor?: string; contactColorDisableFlag?: null | boolean; headerColor?: string; headerColorDisableFlag?: null | boolean; hideDelimiterFlag?: null | boolean; id?: number; memberColor?: string; memberColorDisableFlag?: null | boolean; scheduleSpan: "Standard" | "OfficeHours" | "Overnight"; srNotify: null | "All" | "None" | "NewAndClosedRequests" | "ClosedRequestsOnly" | "NewRequestsOnly"; unknownColor?: string; unknownColorDisableFlag?: null | boolean }): Promise<{ _info?: {}; allowCCFlag?: null | boolean; allowTOFlag?: null | boolean; calendarSetup?: { _info?: {}; id?: null | number }; contactColor?: string; contactColorDisableFlag?: null | boolean; headerColor?: string; headerColorDisableFlag?: null | boolean; hideDelimiterFlag?: null | boolean; id?: number; memberColor?: string; memberColorDisableFlag?: null | boolean; scheduleSpan: "Standard" | "OfficeHours" | "Overnight"; srNotify: null | "All" | "None" | "NewAndClosedRequests" | "ClosedRequestsOnly" | "NewRequestsOnly"; unknownColor?: string; unknownColorDisableFlag?: null | boolean }>

  • Parameters

    • id: number
    • service: { _info?: {}; allowCCFlag?: null | boolean; allowTOFlag?: null | boolean; calendarSetup?: { _info?: {}; id?: null | number }; contactColor?: string; contactColorDisableFlag?: null | boolean; headerColor?: string; headerColorDisableFlag?: null | boolean; hideDelimiterFlag?: null | boolean; id?: number; memberColor?: string; memberColorDisableFlag?: null | boolean; scheduleSpan: "Standard" | "OfficeHours" | "Overnight"; srNotify: null | "All" | "None" | "NewAndClosedRequests" | "ClosedRequestsOnly" | "NewRequestsOnly"; unknownColor?: string; unknownColorDisableFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional allowCCFlag?: null | boolean
      • Optional allowTOFlag?: null | boolean
      • Optional calendarSetup?: { _info?: {}; id?: null | number }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

      • Optional contactColor?: string
        description

        Max length: 50;

      • Optional contactColorDisableFlag?: null | boolean
      • Optional headerColor?: string
        description

        Max length: 50;

      • Optional headerColorDisableFlag?: null | boolean
      • Optional hideDelimiterFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional memberColor?: string
        description

        Max length: 50;

      • Optional memberColorDisableFlag?: null | boolean
      • scheduleSpan: "Standard" | "OfficeHours" | "Overnight"
      • srNotify: null | "All" | "None" | "NewAndClosedRequests" | "ClosedRequestsOnly" | "NewRequestsOnly"
      • Optional unknownColor?: string
        description

        Max length: 50;

      • Optional unknownColorDisableFlag?: null | boolean

    Returns Promise<{ _info?: {}; allowCCFlag?: null | boolean; allowTOFlag?: null | boolean; calendarSetup?: { _info?: {}; id?: null | number }; contactColor?: string; contactColorDisableFlag?: null | boolean; headerColor?: string; headerColorDisableFlag?: null | boolean; hideDelimiterFlag?: null | boolean; id?: number; memberColor?: string; memberColorDisableFlag?: null | boolean; scheduleSpan: "Standard" | "OfficeHours" | "Overnight"; srNotify: null | "All" | "None" | "NewAndClosedRequests" | "ClosedRequestsOnly" | "NewRequestsOnly"; unknownColor?: string; unknownColorDisableFlag?: null | boolean }>

putSystemOffice365EmailSetupsById

  • putSystemOffice365EmailSetupsById(id: number, entity: { _info?: {}; authorizedFlag?: null | boolean; clientId?: string; clientSecret?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; processedFolder: string; tenantId?: string; username: string }): Promise<{ _info?: {}; authorizedFlag?: null | boolean; clientId?: string; clientSecret?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; processedFolder: string; tenantId?: string; username: string }>

  • Parameters

    • id: number
    • entity: { _info?: {}; authorizedFlag?: null | boolean; clientId?: string; clientSecret?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; processedFolder: string; tenantId?: string; username: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional authorizedFlag?: null | boolean
      • Optional clientId?: string
        description

        Max length: 36;

      • Optional clientSecret?: string
        description

        Max length: 4000;

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

          Format: int32

        • Optional name?: string
      • failedFolder: string
        description

        Max length: 40;

      • Optional id?: number

        Format: int32

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

        Max length: 40;

      • name: string
        description

        Max length: 200;

      • processedFolder: string
        description

        Max length: 40;

      • Optional tenantId?: string
        description

        Max length: 36;

      • username: string
        description

        Max length: 100;

    Returns Promise<{ _info?: {}; authorizedFlag?: null | boolean; clientId?: string; clientSecret?: string; emailConnector?: { _info?: {}; id?: null | number; name?: string }; failedFolder: string; id?: number; inactiveFlag?: null | boolean; inboxFolder: string; name: string; processedFolder: string; tenantId?: string; username: string }>

putSystemOsgradeweightsById

  • putSystemOsgradeweightsById(id: number, osGradeWeight: { _info?: {}; id?: number; osGradeWeight?: number; osName?: string }): Promise<{ _info?: {}; id?: number; osGradeWeight?: number; osName?: string }>

  • Parameters

    • id: number
    • osGradeWeight: { _info?: {}; id?: number; osGradeWeight?: number; osName?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional osGradeWeight?: number

        Format: double

      • Optional osName?: string

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

putSystemPortalReportsById

  • putSystemPortalReportsById(id: number, portalReport: { _info?: {}; customFlag?: null | boolean; displayFlag?: null | boolean; id?: number; name: string; openSameWindowFlag?: null | boolean; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; url: string }): Promise<{ _info?: {}; customFlag?: null | boolean; displayFlag?: null | boolean; id?: number; name: string; openSameWindowFlag?: null | boolean; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; url: string }>

  • Parameters

    • id: number
    • portalReport: { _info?: {}; customFlag?: null | boolean; displayFlag?: null | boolean; id?: number; name: string; openSameWindowFlag?: null | boolean; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; url: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional customFlag?: null | boolean
      • Optional displayFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 255;

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

          Format: int32

        • Optional name?: string
      • url: string
        description

        Max length: 255;

    Returns Promise<{ _info?: {}; customFlag?: null | boolean; displayFlag?: null | boolean; id?: number; name: string; openSameWindowFlag?: null | boolean; portalConfiguration?: { _info?: {}; id?: null | number; name?: string }; url: string }>

putSystemQuoteLinkSetupById

  • putSystemQuoteLinkSetupById(id: number, quoteLink: { _info?: {}; allLocationsFlag?: null | boolean; id?: number; link: string; location?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag?: null | boolean }): Promise<{ _info?: {}; allLocationsFlag?: null | boolean; id?: number; link: string; location?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag?: null | boolean }>

  • Parameters

    • id: number
    • quoteLink: { _info?: {}; allLocationsFlag?: null | boolean; id?: number; link: string; location?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional allLocationsFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • link: string
        description

        Max length: 2000;

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

          Format: int32

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

    Returns Promise<{ _info?: {}; allLocationsFlag?: null | boolean; id?: number; link: string; location?: { _info?: {}; id?: null | number; name?: string }; newWindowFlag?: null | boolean }>

putSystemReportCardsById

  • putSystemReportCardsById(id: number, reportCard: { _info?: {}; id?: number; name: string }): Promise<{ _info?: {}; id?: number; name: string }>

  • Parameters

    • id: number
    • reportCard: { _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 }>

putSystemReportCardsByParentIdDetailsById

  • putSystemReportCardsByParentIdDetailsById(id: number, parentId: number, reportCardDetail: { _info?: {}; id?: number; kpi?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; sortOrder?: null | number }): Promise<{ _info?: {}; id?: number; kpi?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; sortOrder?: null | number }>

  • Parameters

    • id: number
    • parentId: number
    • reportCardDetail: { _info?: {}; id?: number; kpi?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; sortOrder?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

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

          Format: int32

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

          Format: int32

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

        Format: int32

    Returns Promise<{ _info?: {}; id?: number; kpi?: { _info?: {}; id?: null | number; name?: string }; reportCard?: { _info?: {}; id?: null | number; name?: string }; sortOrder?: null | number }>

putSystemSettingsById

  • putSystemSettingsById(id: number, systemSetting: { _info?: {}; description?: string; id?: number; value: string; valueType?: string }): Promise<{ _info?: {}; description?: string; id?: number; value: string; valueType?: string }>

  • Parameters

    • id: number
    • systemSetting: { _info?: {}; description?: string; id?: number; value: string; valueType?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional description?: string
      • Optional id?: number

        Format: int32

      • value: string
      • Optional valueType?: string

    Returns Promise<{ _info?: {}; description?: string; id?: number; value: string; valueType?: string }>

putSystemSkillCategoriesById

  • putSystemSkillCategoriesById(id: number, skillCategory: { _info?: {}; id?: number; name: string }): Promise<{ _info?: {}; id?: number; name: string }>

  • Parameters

    • id: number
    • skillCategory: { _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 }>

putSystemSkillsById

  • putSystemSkillsById(id: number, skill: { _info?: {}; category?: { _info?: {}; id?: null | number; name?: string }; id?: number; name: string }): Promise<{ _info?: {}; category?: { _info?: {}; id?: null | number; name?: string }; id?: number; name: string }>

  • Parameters

    • id: number
    • skill: { _info?: {}; category?: { _info?: {}; id?: null | number; name?: string }; id?: number; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional category?: { _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

      • name: string
        description

        Max length: 50;

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

putSystemSsoConfigurationsById

  • putSystemSsoConfigurationsById(id: number, ssoConfiguration: { _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }): Promise<{ _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }>

  • Parameters

    • id: number
    • ssoConfiguration: { _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional allMembersSubmitted?: boolean
      • Optional clientId?: string
        description

        Client identity for this configuration of ConnectWise SSO Max length: 1000;

      • Optional id?: number

        Format: int32

        description

        Unique identifier of the SSO Configuration

      • Optional inactiveFlag?: null | boolean
        description

        Whether the SSO configuration is not active

      • Optional isSsoOnByDefault?: boolean
      • locationIds: number[]
        description

        The locations where the SAML Idp Configuration is used

      • name: string
        description

        Descriptor of the SSO Configuration Max length: 100;

      • Optional samlCertificateIssuedTo?: string
        description

        Who the SAML certificate was issued to. Metadata on SAML_Idp_Certificate

      • Optional samlCertificateName?: string
        description

        Name of the SAML certificate. Metadata on SAML_Idp_Certificate

      • Optional samlCertificateThumbprint?: string
        description

        Thumbprint of the SAML certificate. Metadata on SAML_Idp_Certificate

      • Optional samlCertificateValidFrom?: string

        Format: date-time

        description

        Date when the SAML certificate becomes valid. Metadata on SAML_Idp_Certificate

      • Optional samlCertificateValidTo?: string

        Format: date-time

        description

        Date when the SAML certificate is no longer valid. Metadata on SAML_Idp_Certificate

      • Optional samlEntityId?: string
        description

        SAML Identity Provider Id Max length: 1000;

      • Optional samlIdpCertificate?: string
        description

        Public certificate for Identity Provider signatures

      • Optional samlSignInUrl?: string
        description

        Sign in url for the SAML Identity Provider Max length: 1000;

      • ssoType: null | "CWSSO" | "SAML"
        description

        Type of SSO Configuration

      • Optional stsBaseUrl?: string
        description

        Sign in URL for ConnectWise SSO

      • Optional stsUserAdminUrl?: string
        description

        User Admin Url for ConnectWise SSO

      • Optional submittedMemberCount?: number

        Format: int32

      • Optional token?: string

    Returns Promise<{ _info?: {}; allMembersSubmitted?: boolean; clientId?: string; id?: number; inactiveFlag?: null | boolean; isSsoOnByDefault?: boolean; locationIds: number[]; name: string; samlCertificateIssuedTo?: string; samlCertificateName?: string; samlCertificateThumbprint?: string; samlCertificateValidFrom?: string; samlCertificateValidTo?: string; samlEntityId?: string; samlIdpCertificate?: string; samlSignInUrl?: string; ssoType: null | "CWSSO" | "SAML"; stsBaseUrl?: string; stsUserAdminUrl?: string; submittedMemberCount?: number; token?: string }>

putSystemStandardNotesById

  • putSystemStandardNotesById(id: number, standardNote: { _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; contents: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string }): Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; contents: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string }>

  • Parameters

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

          Format: int32

        • Optional name?: string
      • contents: 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
      • name: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; contents: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string }>

putSystemSurveysByGrandparentIdQuestionsByParentIdValuesById

  • putSystemSurveysByGrandparentIdQuestionsByParentIdValuesById(id: number, parentId: number, grandparentId: number, surveyQuestionValue: { _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; pointValue?: null | number; question?: { _info?: {}; id?: null | number; question?: string }; survey?: { _info?: {}; id?: null | number; name?: string }; value: string }): Promise<{ _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; pointValue?: null | number; question?: { _info?: {}; id?: null | number; question?: string }; survey?: { _info?: {}; id?: null | number; name?: string }; value: string }>

  • Parameters

    • id: number
    • parentId: number
    • grandparentId: number
    • surveyQuestionValue: { _info?: {}; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; pointValue?: null | number; question?: { _info?: {}; id?: null | number; question?: string }; survey?: { _info?: {}; id?: null | number; name?: string }; value: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional defaultFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • Optional pointValue?: null | number

        Format: int32

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

          Format: int32

        • Optional question?: string
      • Optional survey?: { _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: 1000;

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

putSystemSurveysById

  • putSystemSurveysById(id: number, survey: { _info?: {}; id?: number; inactiveFlag?: null | boolean; instructions?: string; name: string }): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; instructions?: string; name: string }>

  • Parameters

    • id: number
    • survey: { _info?: {}; id?: number; inactiveFlag?: null | boolean; instructions?: string; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

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

        Max length: 1000;

      • name: string
        description

        Max length: 50;

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

putSystemSurveysByParentIdQuestionsById

  • putSystemSurveysByParentIdQuestionsById(id: number, parentId: number, surveyQuestion: { _info?: {}; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Button" | "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; survey?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Button" | "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; survey?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • surveyQuestion: { _info?: {}; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Button" | "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; survey?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • entryType: null | "Date" | "EntryField" | "List" | "Option"
      • fieldType: null | "TextArea" | "Button" | "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

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

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; entryType: null | "Date" | "EntryField" | "List" | "Option"; fieldType: null | "TextArea" | "Button" | "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; survey?: { _info?: {}; id?: null | number; name?: string } }>

putSystemTimeZoneSetupsById

  • putSystemTimeZoneSetupsById(id: number, timeZoneSetup: { _info?: {}; daylightSavingsFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; name: string; offset?: null | number; timeZone?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; daylightSavingsFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; name: string; offset?: null | number; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • timeZoneSetup: { _info?: {}; daylightSavingsFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; name: string; offset?: null | number; timeZone?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional daylightSavingsFlag?: null | boolean
        description

        Determined based on system library value for specified timeZone. Not able to be used in query params at this time

      • Optional defaultFlag?: null | boolean
        description

        Identifies the default system time zone setup

      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 50;

      • Optional offset?: null | number

        Format: double

        description

        The hours offset from UTC (+/-)

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

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; daylightSavingsFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; name: string; offset?: null | number; timeZone?: { _info?: {}; id?: null | number; name?: string } }>

putSystemTodayPageCategoriesById

  • putSystemTodayPageCategoriesById(id: number, todayPageCategory: { _info?: {}; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; sortOrder: null | number }): Promise<{ _info?: {}; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; sortOrder: null | number }>

  • Parameters

    • id: number
    • todayPageCategory: { _info?: {}; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; sortOrder: null | number }
      • Optional _info?: {}
        • [key: string]: 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
      • name: string
        description

        Max length: 30;

      • sortOrder: null | number

        Format: int32

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

putSystemUserDefinedFieldsById

  • putSystemUserDefinedFieldsById(id: number, userDefinedField: { _info?: {}; addAllBusinessUnits?: null | boolean; addAllLocations?: null | boolean; businessUnitIds?: number[]; buttonUrl?: string; caption: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId: null | number; readOnlyFlag?: null | boolean; removeAllBusinessUnits?: null | boolean; removeAllLocations?: null | boolean; requiredFlag?: null | boolean; sequenceNumber: null | number }): Promise<{ _info?: {}; addAllBusinessUnits?: null | boolean; addAllLocations?: null | boolean; businessUnitIds?: number[]; buttonUrl?: string; caption: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId: null | number; readOnlyFlag?: null | boolean; removeAllBusinessUnits?: null | boolean; removeAllLocations?: null | boolean; requiredFlag?: null | boolean; sequenceNumber: null | number }>

  • Parameters

    • id: number
    • userDefinedField: { _info?: {}; addAllBusinessUnits?: null | boolean; addAllLocations?: null | boolean; businessUnitIds?: number[]; buttonUrl?: string; caption: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId: null | number; readOnlyFlag?: null | boolean; removeAllBusinessUnits?: null | boolean; removeAllLocations?: null | boolean; requiredFlag?: null | boolean; sequenceNumber: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addAllBusinessUnits?: null | boolean
      • Optional addAllLocations?: null | boolean
      • Optional businessUnitIds?: number[]
      • Optional buttonUrl?: string
        description

        Only available with Button Field Type. Required when entryTypeIdentifier is button Max length: 1000;

      • caption: string
        description

        Field caption Max length: 25;

      • Optional dateCreated?: string

        Format: date-time

        description

        Date in UTC the custom field was created

      • Optional displayOnScreenFlag?: null | boolean
      • Optional entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"
      • fieldTypeIdentifier: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"
      • Optional helpText?: string
        description

        Help text to accompany the custom field Max length: 1000;

      • Optional id?: number

        Format: int32

        description

        ID of the custom user defined field

      • Optional listViewFlag?: null | boolean
        description

        Denotes that this custom field is included on a list view

      • Optional locationIds?: number[]
      • Optional numberDecimals?: null | number

        Format: int32

        description

        Only valid for Number or percent

      • Optional options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]
      • podId: null | number

        Format: int32

        description

        Id of the Pod where the custom field will be placed

      • Optional readOnlyFlag?: null | boolean
      • Optional removeAllBusinessUnits?: null | boolean
      • Optional removeAllLocations?: null | boolean
      • Optional requiredFlag?: null | boolean
      • sequenceNumber: null | number

        Format: int32

        description

        Must be between 1 and 500. This defines the order in which the custom fields will appear

    Returns Promise<{ _info?: {}; addAllBusinessUnits?: null | boolean; addAllLocations?: null | boolean; businessUnitIds?: number[]; buttonUrl?: string; caption: string; dateCreated?: string; displayOnScreenFlag?: null | boolean; entryTypeIdentifier?: null | "Date" | "EntryField" | "List" | "Option"; fieldTypeIdentifier: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; helpText?: string; id?: number; listViewFlag?: null | boolean; locationIds?: number[]; numberDecimals?: null | number; options?: { defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; optionValue?: string; sortOrder?: null | number }[]; podId: null | number; readOnlyFlag?: null | boolean; removeAllBusinessUnits?: null | boolean; removeAllLocations?: null | boolean; requiredFlag?: null | boolean; sequenceNumber: null | number }>

putSystemWorkflowActionsByParentIdAutomateParametersById

  • putSystemWorkflowActionsByParentIdAutomateParametersById(id: number, parentId: number, workflowActionAutomateParameter: { id?: number; name: string; value?: string }): Promise<{ id?: number; name: string; value?: string }>

  • Parameters

    • id: number
    • parentId: number
    • workflowActionAutomateParameter: { id?: number; name: string; value?: string }
      • Optional id?: number

        Format: int32

      • name: string
      • Optional value?: string

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

putSystemWorkflowsByGrandparentIdEventsByParentIdActionsById

  • putSystemWorkflowsByGrandparentIdEventsByParentIdActionsById(id: number, parentId: number, grandparentId: number, workflowAction: { _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachConfigurationsFor?: null | "Company" | "Contact"; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; attachments?: number[]; auditNotesFlag?: null | boolean; automateScript?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; board?: { _info?: {}; id?: null | number; name?: string }; boardStatus?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; configurationStatus?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; detailNotesFlag?: null | boolean; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; internalNotesFlag?: null | boolean; invoiceMinDays?: null | number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectStatus?: { _info?: {}; id?: null | number; name?: string }; salesOrderStatus?: { _info?: {}; id?: null | number; name?: string }; scriptFailStatus?: { _info?: {}; id?: null | number; name?: string }; scriptSuccessStatus?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificTeamTo?: { _info?: {}; id?: null | number; isProjectTeamFlag?: boolean; name?: string }; subject?: string; updateOwnerFlag?: null | boolean }): Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachConfigurationsFor?: null | "Company" | "Contact"; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; attachments?: number[]; auditNotesFlag?: null | boolean; automateScript?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; board?: { _info?: {}; id?: null | number; name?: string }; boardStatus?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; configurationStatus?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; detailNotesFlag?: null | boolean; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; internalNotesFlag?: null | boolean; invoiceMinDays?: null | number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectStatus?: { _info?: {}; id?: null | number; name?: string }; salesOrderStatus?: { _info?: {}; id?: null | number; name?: string }; scriptFailStatus?: { _info?: {}; id?: null | number; name?: string }; scriptSuccessStatus?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificTeamTo?: { _info?: {}; id?: null | number; isProjectTeamFlag?: boolean; name?: string }; subject?: string; updateOwnerFlag?: null | boolean }>

  • Parameters

    • id: number
    • parentId: number
    • grandparentId: number
    • workflowAction: { _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachConfigurationsFor?: null | "Company" | "Contact"; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; attachments?: number[]; auditNotesFlag?: null | boolean; automateScript?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; board?: { _info?: {}; id?: null | number; name?: string }; boardStatus?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; configurationStatus?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; detailNotesFlag?: null | boolean; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; internalNotesFlag?: null | boolean; invoiceMinDays?: null | number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectStatus?: { _info?: {}; id?: null | number; name?: string }; salesOrderStatus?: { _info?: {}; id?: null | number; name?: string }; scriptFailStatus?: { _info?: {}; id?: null | number; name?: string }; scriptSuccessStatus?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificTeamTo?: { _info?: {}; id?: null | number; isProjectTeamFlag?: boolean; name?: string }; subject?: string; updateOwnerFlag?: null | boolean }
      • 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 attachConfigurationsFor?: null | "Company" | "Contact"
        description

        Required when notifyType is set to: "Attach Configuration"

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

          Format: int32

        • Optional name?: string
      • Optional attachments?: number[]
      • Optional auditNotesFlag?: null | boolean
      • Optional automateScript?: { _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 board?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional boardStatus?: { _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 configurationStatus?: { _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 daysToExecute?: null | number

        Format: int32

      • Optional detailNotesFlag?: null | boolean
      • Optional emailFrom?: string
        description

        Required when notifyFrom is set to: "Email Address" Max length: 250;

      • Optional emailRecipient?: string
        description

        Required when notifyWho is set to: "Email Address" 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 internalNotesFlag?: null | boolean
      • Optional invoiceMinDays?: null | 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: { _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
      • Optional projectStatus?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

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

          Format: int32

        • 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 serviceType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: 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 specificTeamTo?: { _info?: {}; id?: null | number; isProjectTeamFlag?: boolean; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional isProjectTeamFlag?: boolean
        • Optional name?: string
      • Optional subject?: string
        description

        Required when notifyType is set to: "Create Activity", "Send Email", "Assign Resource" Max length: 100;

      • Optional updateOwnerFlag?: null | boolean

    Returns Promise<{ _info?: {}; activityStatus?: { _info?: {}; id?: null | number; name?: string }; activityType?: { _info?: {}; id?: null | number; name?: string }; attachConfigurationsFor?: null | "Company" | "Contact"; attachedTrack?: { _info?: {}; id?: null | number; name?: string }; attachments?: number[]; auditNotesFlag?: null | boolean; automateScript?: { _info?: {}; id?: null | number; name?: string }; bccContact?: { _info?: {}; id?: null | number; name?: string }; board?: { _info?: {}; id?: null | number; name?: string }; boardStatus?: { _info?: {}; id?: null | number; name?: string }; ccContact?: { _info?: {}; id?: null | number; name?: string }; companyStatus?: { _info?: {}; id?: null | number; name?: string }; configurationStatus?: { _info?: {}; id?: null | number; name?: string }; configurationType?: { _info?: {}; id?: null | number; name?: string }; daysToExecute?: null | number; detailNotesFlag?: null | boolean; emailFrom?: string; emailRecipient?: string; group?: { _info?: {}; id?: null | number; name?: string }; id?: number; internalNotesFlag?: null | boolean; invoiceMinDays?: null | number; notes?: string; notifyFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyType: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; projectStatus?: { _info?: {}; id?: null | number; name?: string }; salesOrderStatus?: { _info?: {}; id?: null | number; name?: string }; scriptFailStatus?: { _info?: {}; id?: null | number; name?: string }; scriptSuccessStatus?: { _info?: {}; id?: null | number; name?: string }; serviceItem?: { _info?: {}; id?: null | number; name?: string }; servicePriority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; serviceSubType?: { _info?: {}; id?: null | number; name?: string }; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; serviceTemplate?: { _info?: {}; id?: null | number; name?: string; summary?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; specificMemberFrom?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificMemberTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; specificTeamTo?: { _info?: {}; id?: null | number; isProjectTeamFlag?: boolean; name?: string }; subject?: string; updateOwnerFlag?: null | boolean }>

putSystemWorkflowsById

  • putSystemWorkflowsById(id: number, workflow: { _info?: {}; activateFlag?: null | boolean; batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"; batchInterval?: null | number; batchLastRan?: string; batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"; board?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; tableType?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; activateFlag?: null | boolean; batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"; batchInterval?: null | number; batchLastRan?: string; batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"; board?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; tableType?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

  • Parameters

    • id: number
    • workflow: { _info?: {}; activateFlag?: null | boolean; batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"; batchInterval?: null | number; batchLastRan?: string; batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"; board?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; tableType?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional activateFlag?: null | boolean
        description

        Batches can not be turned on until after the workflow is created and it has atleast one event associated with it

      • Optional batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"
        description

        If not specified, defaults to Minutes. Months is not supported as month length varies

      • Optional batchInterval?: null | number

        Format: int32

      • Optional batchLastRan?: string

        Format: date-time

      • Optional batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"
        description

        If activateFlag is true, batchSchedule is required

      • Optional board?: { _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
      • name: string
        description

        Max length: 100;

      • Optional tableType?: { _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?: {}; activateFlag?: null | boolean; batchFrequencyUnit?: null | "Hours" | "Minutes" | "Days"; batchInterval?: null | number; batchLastRan?: string; batchSchedule?: null | "AnyTime" | "MyCompanyOfficeHours" | "SlaHours"; board?: { _info?: {}; id?: null | number; name?: string }; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; tableType?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

putSystemWorkflowsByParentIdEventsById

  • putSystemWorkflowsByParentIdEventsById(id: number, parentId: number, workflowEvent: { _info?: {}; eventCondition: string; executionTime?: null | "Once" | "MultipleTimes" | "Continuously"; frequencyOfExecution?: null | number; frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"; id?: number; maxNumberOfExecution?: null | number; name?: string }): Promise<{ _info?: {}; eventCondition: string; executionTime?: null | "Once" | "MultipleTimes" | "Continuously"; frequencyOfExecution?: null | number; frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"; id?: number; maxNumberOfExecution?: null | number; name?: string }>

  • Parameters

    • id: number
    • parentId: number
    • workflowEvent: { _info?: {}; eventCondition: string; executionTime?: null | "Once" | "MultipleTimes" | "Continuously"; frequencyOfExecution?: null | number; frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"; id?: number; maxNumberOfExecution?: null | number; name?: string }
      • Optional _info?: {}
        • [key: string]: string
      • eventCondition: string
      • Optional executionTime?: null | "Once" | "MultipleTimes" | "Continuously"
        description

        Defaults to Once when not specified

      • Optional frequencyOfExecution?: null | number

        Format: int32

        description

        Required when exectionTimes is set to MultipleTimes or Continuously

      • Optional frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"
        description

        Required when exectionTimes is set to MultipleTimes or Continuously

      • Optional id?: number

        Format: int32

      • Optional maxNumberOfExecution?: null | number

        Format: int32

        description

        Required when exectionTimes is set to MultipleTimes

      • Optional name?: string

    Returns Promise<{ _info?: {}; eventCondition: string; executionTime?: null | "Once" | "MultipleTimes" | "Continuously"; frequencyOfExecution?: null | number; frequencyUnit?: null | "Hours" | "Minutes" | "Days" | "Months"; id?: number; maxNumberOfExecution?: null | number; name?: string }>

putSystemWorkflowsUserdefinedfieldsById

  • putSystemWorkflowsUserdefinedfieldsById(id: number, workflowActionUserDefinedField: { _info?: {}; actionId?: number; caption?: string; entryTypeId?: string; eventId?: number; fieldTypeId?: string; id?: number; inactiveFlag?: null | boolean; overwriteFlag?: null | boolean; podDescription?: string; requiredFlag?: null | boolean; userDefinedFieldId?: number; value?: string }): Promise<{ _info?: {}; actionId?: number; caption?: string; entryTypeId?: string; eventId?: number; fieldTypeId?: string; id?: number; inactiveFlag?: null | boolean; overwriteFlag?: null | boolean; podDescription?: string; requiredFlag?: null | boolean; userDefinedFieldId?: number; value?: string }>

  • Parameters

    • id: number
    • workflowActionUserDefinedField: { _info?: {}; actionId?: number; caption?: string; entryTypeId?: string; eventId?: number; fieldTypeId?: string; id?: number; inactiveFlag?: null | boolean; overwriteFlag?: null | boolean; podDescription?: string; requiredFlag?: null | boolean; userDefinedFieldId?: number; value?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional actionId?: number

        Format: int32

      • Optional caption?: string
      • Optional entryTypeId?: string
      • Optional eventId?: number

        Format: int32

      • Optional fieldTypeId?: string
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • Optional overwriteFlag?: null | boolean
      • Optional podDescription?: string
      • Optional requiredFlag?: null | boolean
      • Optional userDefinedFieldId?: number

        Format: int32

      • Optional value?: string

    Returns Promise<{ _info?: {}; actionId?: number; caption?: string; entryTypeId?: string; eventId?: number; fieldTypeId?: string; id?: number; inactiveFlag?: null | boolean; overwriteFlag?: null | boolean; podDescription?: string; requiredFlag?: null | boolean; userDefinedFieldId?: number; value?: string }>

Generated using TypeDoc