SalesAPI | connectwise-rest

Sales module

Hierarchy

default
- SalesAPI

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SalesAPI(props: CWMOptions): SalesAPI

Overrides Manage.constructor
- Defined in src/Manage/SalesAPI.ts:100
Parameters
- props: CWMOptions
Returns SalesAPI

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

- (args: RequestOptions): Promise<any>
- Parameters
  - args: RequestOptions
  Returns Promise<any>

Methods

deleteSalesActivitiesById

deleteSalesActivitiesById(id: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:128
Parameters
- id: number
Returns Promise<undefined>

deleteSalesActivitiesStatusesById

deleteSalesActivitiesStatusesById(id: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:186
Parameters
- id: number
Returns Promise<undefined>

deleteSalesActivitiesTypesById

deleteSalesActivitiesTypesById(id: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:276
Parameters
- id: number
Returns Promise<undefined>

deleteSalesCommissionsById

deleteSalesCommissionsById(id: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:356
Parameters
- id: number
Returns Promise<undefined>

deleteSalesOpportunitiesById

deleteSalesOpportunitiesById(id: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:433
Parameters
- id: number
Returns Promise<undefined>

deleteSalesOpportunitiesByParentIdContactsById

deleteSalesOpportunitiesByParentIdContactsById(id: number, parentId: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:537
Parameters
- id: number
- parentId: number
Returns Promise<undefined>

deleteSalesOpportunitiesByParentIdForecast

deleteSalesOpportunitiesByParentIdForecast(parentId: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:604
Parameters
- parentId: number
Returns Promise<undefined>

deleteSalesOpportunitiesByParentIdForecastById

deleteSalesOpportunitiesByParentIdForecastById(id: number, parentId: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:654
Parameters
- id: number
- parentId: number
Returns Promise<undefined>

deleteSalesOpportunitiesByParentIdNotesById

deleteSalesOpportunitiesByParentIdNotesById(id: number, parentId: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:743
Parameters
- id: number
- parentId: number
Returns Promise<undefined>

deleteSalesOpportunitiesByParentIdTeamById

deleteSalesOpportunitiesByParentIdTeamById(id: number, parentId: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:819
Parameters
- id: number
- parentId: number
Returns Promise<undefined>

deleteSalesOpportunitiesRatingsById

deleteSalesOpportunitiesRatingsById(id: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:903
Parameters
- id: number
Returns Promise<undefined>

deleteSalesOpportunitiesStatusesById

deleteSalesOpportunitiesStatusesById(id: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:996
Parameters
- id: number
Returns Promise<undefined>

deleteSalesOpportunitiesTypesById

deleteSalesOpportunitiesTypesById(id: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:1111
Parameters
- id: number
Returns Promise<undefined>

deleteSalesOrdersById

deleteSalesOrdersById(id: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:1223
Parameters
- id: number
Returns Promise<undefined>

deleteSalesOrdersStatusesById

deleteSalesOrdersStatusesById(id: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:1285
Parameters
- id: number
Returns Promise<undefined>

deleteSalesOrdersStatusesByParentIdEmailtemplatesById

deleteSalesOrdersStatusesByParentIdEmailtemplatesById(id: number, parentId: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:1378
Parameters
- id: number
- parentId: number
Returns Promise<undefined>

deleteSalesOrdersStatusesByParentIdNotificationsById

deleteSalesOrdersStatusesByParentIdNotificationsById(id: number, parentId: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:1457
Parameters
- id: number
- parentId: number
Returns Promise<undefined>

deleteSalesProbabilitiesById

deleteSalesProbabilitiesById(id: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:1550
Parameters
- id: number
Returns Promise<undefined>

deleteSalesQuotasById

deleteSalesQuotasById(id: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:1635
Parameters
- id: number
Returns Promise<undefined>

deleteSalesRolesById

deleteSalesRolesById(id: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:1690
Parameters
- id: number
Returns Promise<undefined>

deleteSalesSalesTeamsById

deleteSalesSalesTeamsById(id: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:1745
Parameters
- id: number
Returns Promise<undefined>

deleteSalesSalesTeamsByParentIdMembersById

deleteSalesSalesTeamsByParentIdMembersById(id: number, parentId: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:1802
Parameters
- id: number
- parentId: number
Returns Promise<undefined>

deleteSalesStagesById

deleteSalesStagesById(id: number): Promise<undefined>

- Defined in src/Manage/SalesAPI.ts:1895
Parameters
- id: number
Returns Promise<undefined>

getSalesActivities

getSalesActivities(params?: CommonParameters): Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; assignTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; assignedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; campaign?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateEnd?: string; dateStart?: string; email?: string; id?: number; mobileGuid?: null | string; name: string; notes?: string; notifyFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; phoneNumber?: string; reminder?: { _info?: {}; id?: null | number; name?: string }; scheduleStatus?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; type?: { _info?: {}; id?: null | number; name?: string }; where?: { _info?: {}; id?: null | number; name?: string } }[]>

- Defined in src/Manage/SalesAPI.ts:104
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; assignTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; assignedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; campaign?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateEnd?: string; dateStart?: string; email?: string; id?: number; mobileGuid?: null | string; name: string; notes?: string; notifyFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; phoneNumber?: string; reminder?: { _info?: {}; id?: null | number; name?: string }; scheduleStatus?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; type?: { _info?: {}; id?: null | number; name?: string }; where?: { _info?: {}; id?: null | number; name?: string } }[]>

getSalesActivitiesById

getSalesActivitiesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; assignTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; assignedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; campaign?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateEnd?: string; dateStart?: string; email?: string; id?: number; mobileGuid?: null | string; name: string; notes?: string; notifyFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; phoneNumber?: string; reminder?: { _info?: {}; id?: null | number; name?: string }; scheduleStatus?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; type?: { _info?: {}; id?: null | number; name?: string }; where?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:120
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; assignTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; assignedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; campaign?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateEnd?: string; dateStart?: string; email?: string; id?: number; mobileGuid?: null | string; name: string; notes?: string; notifyFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; phoneNumber?: string; reminder?: { _info?: {}; id?: null | number; name?: string }; scheduleStatus?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; type?: { _info?: {}; id?: null | number; name?: string }; where?: { _info?: {}; id?: null | number; name?: string } }>

getSalesActivitiesCount

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

- Defined in src/Manage/SalesAPI.ts:151
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesActivitiesStatuses

getSalesActivitiesStatuses(params?: CommonParameters): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; spawnFollowupFlag?: null | boolean }[]>

- Defined in src/Manage/SalesAPI.ts:159
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; spawnFollowupFlag?: null | boolean }[]>

getSalesActivitiesStatusesById

getSalesActivitiesStatusesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; spawnFollowupFlag?: null | boolean }>

- Defined in src/Manage/SalesAPI.ts:175
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; spawnFollowupFlag?: null | boolean }>

getSalesActivitiesStatusesByIdInfo

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

- Defined in src/Manage/SalesAPI.ts:215
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name?: string }>

getSalesActivitiesStatusesCount

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

- Defined in src/Manage/SalesAPI.ts:226
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesActivitiesStatusesInfo

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

- Defined in src/Manage/SalesAPI.ts:234
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name?: string }[]>

getSalesActivitiesStatusesInfoCount

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

- Defined in src/Manage/SalesAPI.ts:244
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesActivitiesTypes

getSalesActivitiesTypes(params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; historyFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; memoFlag?: null | boolean; name: string; points?: null | number }[]>

- Defined in src/Manage/SalesAPI.ts:252
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; historyFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; memoFlag?: null | boolean; name: string; points?: null | number }[]>

getSalesActivitiesTypesById

getSalesActivitiesTypesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; historyFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; memoFlag?: null | boolean; name: string; points?: null | number }>

- Defined in src/Manage/SalesAPI.ts:268
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; historyFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; memoFlag?: null | boolean; name: string; points?: null | number }>

getSalesActivitiesTypesByIdUsages

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

- Defined in src/Manage/SalesAPI.ts:302
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getSalesActivitiesTypesByIdUsagesList

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

- Defined in src/Manage/SalesAPI.ts:313
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getSalesActivitiesTypesCount

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

- Defined in src/Manage/SalesAPI.ts:324
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesCommissions

getSalesCommissions(params?: CommonParameters): Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementType?: { _info?: {}; id?: null | number; name?: string }; agreementsFlag?: null | boolean; billingMethod?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; commissionBasis?: null | "GrossProfit" | "SalesAmount"; commissionPercent?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateEnd?: string; dateStart?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; invoiceOption?: null | "AllInvoices" | "PaidInvoices"; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; myOpportunitiesFlag?: null | boolean; numberOfMonths?: null | number; productCategory?: { _info?: {}; id?: null | number; name?: string }; productSubCategory?: { _info?: {}; id?: null | number; name?: string }; productsFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; projectBoard?: { _info?: {}; id?: null | number; name?: string }; projectType?: { _info?: {}; id?: null | number; name?: string }; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; servicesFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; territory?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string } }[]>

- Defined in src/Manage/SalesAPI.ts:332
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementType?: { _info?: {}; id?: null | number; name?: string }; agreementsFlag?: null | boolean; billingMethod?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; commissionBasis?: null | "GrossProfit" | "SalesAmount"; commissionPercent?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateEnd?: string; dateStart?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; invoiceOption?: null | "AllInvoices" | "PaidInvoices"; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; myOpportunitiesFlag?: null | boolean; numberOfMonths?: null | number; productCategory?: { _info?: {}; id?: null | number; name?: string }; productSubCategory?: { _info?: {}; id?: null | number; name?: string }; productsFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; projectBoard?: { _info?: {}; id?: null | number; name?: string }; projectType?: { _info?: {}; id?: null | number; name?: string }; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; servicesFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; territory?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string } }[]>

getSalesCommissionsById

getSalesCommissionsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementType?: { _info?: {}; id?: null | number; name?: string }; agreementsFlag?: null | boolean; billingMethod?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; commissionBasis?: null | "GrossProfit" | "SalesAmount"; commissionPercent?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateEnd?: string; dateStart?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; invoiceOption?: null | "AllInvoices" | "PaidInvoices"; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; myOpportunitiesFlag?: null | boolean; numberOfMonths?: null | number; productCategory?: { _info?: {}; id?: null | number; name?: string }; productSubCategory?: { _info?: {}; id?: null | number; name?: string }; productsFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; projectBoard?: { _info?: {}; id?: null | number; name?: string }; projectType?: { _info?: {}; id?: null | number; name?: string }; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; servicesFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; territory?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string } }>

- Defined in src/Manage/SalesAPI.ts:348
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementType?: { _info?: {}; id?: null | number; name?: string }; agreementsFlag?: null | boolean; billingMethod?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; commissionBasis?: null | "GrossProfit" | "SalesAmount"; commissionPercent?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateEnd?: string; dateStart?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; invoiceOption?: null | "AllInvoices" | "PaidInvoices"; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; myOpportunitiesFlag?: null | boolean; numberOfMonths?: null | number; productCategory?: { _info?: {}; id?: null | number; name?: string }; productSubCategory?: { _info?: {}; id?: null | number; name?: string }; productsFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; projectBoard?: { _info?: {}; id?: null | number; name?: string }; projectType?: { _info?: {}; id?: null | number; name?: string }; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; servicesFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; territory?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string } }>

getSalesCommissionsByIdUsages

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

- Defined in src/Manage/SalesAPI.ts:382
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getSalesCommissionsByIdUsagesList

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

- Defined in src/Manage/SalesAPI.ts:390
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getSalesCommissionsCount

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

- Defined in src/Manage/SalesAPI.ts:401
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesOpportunities

getSalesOpportunities(params?: CommonParameters): Promise<{ _info?: {}; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; campaign?: { _info?: {}; id?: null | number; name?: string }; closedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; closedDate?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateBecameLead?: string; expectedCloseDate?: string; id?: number; locationId?: null | number; name: string; notes?: string; pipelineChangeDate?: string; primarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority?: { _info?: {}; id?: null | number; name?: string }; probability?: { _info?: {}; id?: null | number; name?: string }; rating?: { _info?: {}; id?: null | number; name?: string }; secondarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; source?: string; stage?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; technicalContact?: { _info?: {}; id?: null | number; name?: string }; totalSalesTax?: null | number; type?: { _info?: {}; id?: null | number; name?: string } }[]>

- Defined in src/Manage/SalesAPI.ts:409
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; campaign?: { _info?: {}; id?: null | number; name?: string }; closedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; closedDate?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateBecameLead?: string; expectedCloseDate?: string; id?: number; locationId?: null | number; name: string; notes?: string; pipelineChangeDate?: string; primarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority?: { _info?: {}; id?: null | number; name?: string }; probability?: { _info?: {}; id?: null | number; name?: string }; rating?: { _info?: {}; id?: null | number; name?: string }; secondarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; source?: string; stage?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; technicalContact?: { _info?: {}; id?: null | number; name?: string }; totalSalesTax?: null | number; type?: { _info?: {}; id?: null | number; name?: string } }[]>

getSalesOpportunitiesById

getSalesOpportunitiesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; campaign?: { _info?: {}; id?: null | number; name?: string }; closedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; closedDate?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateBecameLead?: string; expectedCloseDate?: string; id?: number; locationId?: null | number; name: string; notes?: string; pipelineChangeDate?: string; primarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority?: { _info?: {}; id?: null | number; name?: string }; probability?: { _info?: {}; id?: null | number; name?: string }; rating?: { _info?: {}; id?: null | number; name?: string }; secondarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; source?: string; stage?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; technicalContact?: { _info?: {}; id?: null | number; name?: string }; totalSalesTax?: null | number; type?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:425
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; campaign?: { _info?: {}; id?: null | number; name?: string }; closedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; closedDate?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateBecameLead?: string; expectedCloseDate?: string; id?: number; locationId?: null | number; name: string; notes?: string; pipelineChangeDate?: string; primarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority?: { _info?: {}; id?: null | number; name?: string }; probability?: { _info?: {}; id?: null | number; name?: string }; rating?: { _info?: {}; id?: null | number; name?: string }; secondarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; source?: string; stage?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; technicalContact?: { _info?: {}; id?: null | number; name?: string }; totalSalesTax?: null | number; type?: { _info?: {}; id?: null | number; name?: string } }>

getSalesOpportunitiesByParentIdContacts

getSalesOpportunitiesByParentIdContacts(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; id?: number; notes?: string; opportunityId?: null | number; phoneNumber?: string; referralFlag?: null | boolean; role?: { _info?: {}; id?: null | number; name?: string } }[]>

- Defined in src/Manage/SalesAPI.ts:503
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; id?: number; notes?: string; opportunityId?: null | number; phoneNumber?: string; referralFlag?: null | boolean; role?: { _info?: {}; id?: null | number; name?: string } }[]>

getSalesOpportunitiesByParentIdContactsById

getSalesOpportunitiesByParentIdContactsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; id?: number; notes?: string; opportunityId?: null | number; phoneNumber?: string; referralFlag?: null | boolean; role?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:525
Parameters
- id: number
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; id?: number; notes?: string; opportunityId?: null | number; phoneNumber?: string; referralFlag?: null | boolean; role?: { _info?: {}; id?: null | number; name?: string } }>

getSalesOpportunitiesByParentIdContactsCount

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

- Defined in src/Manage/SalesAPI.ts:571
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesOpportunitiesByParentIdForecast

getSalesOpportunitiesByParentIdForecast(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; expectedProbability?: number; expenseRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastItems?: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }[]; forecastRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastTotalWithTaxes?: null | number; id?: number; inclusiveRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; lostRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; openRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue1?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue2?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; productRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; recurringTotal?: null | number; salesTaxRevenue?: null | number; serviceRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; wonRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number } }[]>

- Defined in src/Manage/SalesAPI.ts:582
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; agreementRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; expectedProbability?: number; expenseRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastItems?: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }[]; forecastRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastTotalWithTaxes?: null | number; id?: number; inclusiveRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; lostRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; openRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue1?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue2?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; productRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; recurringTotal?: null | number; salesTaxRevenue?: null | number; serviceRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; wonRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number } }[]>

getSalesOpportunitiesByParentIdForecastById

getSalesOpportunitiesByParentIdForecastById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }>

- Defined in src/Manage/SalesAPI.ts:630
Parameters
- id: number
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }>

getSalesOpportunitiesByParentIdForecastCount

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

- Defined in src/Manage/SalesAPI.ts:698
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesOpportunitiesByParentIdNotes

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

- Defined in src/Manage/SalesAPI.ts:709
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; enteredBy?: string; flagged?: null | boolean; id?: number; mobileGuid?: null | string; opportunityId?: null | number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }[]>

getSalesOpportunitiesByParentIdNotesById

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

- Defined in src/Manage/SalesAPI.ts:731
Parameters
- id: number
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; enteredBy?: string; flagged?: null | boolean; id?: number; mobileGuid?: null | string; opportunityId?: null | number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

getSalesOpportunitiesByParentIdNotesCount

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

- Defined in src/Manage/SalesAPI.ts:777
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; enteredBy?: string; flagged?: null | boolean; id?: number; mobileGuid?: null | string; opportunityId?: null | number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }[]>

getSalesOpportunitiesByParentIdTeam

getSalesOpportunitiesByParentIdTeam(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; commissionPercent?: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; opportunityId?: null | number; referralFlag?: null | boolean; responsibleFlag?: null | boolean; salesTeam?: { _info?: {}; id?: null | number; identifier?: string }; type: null | "Team" | "Individual" }[]>

- Defined in src/Manage/SalesAPI.ts:788
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; commissionPercent?: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; opportunityId?: null | number; referralFlag?: null | boolean; responsibleFlag?: null | boolean; salesTeam?: { _info?: {}; id?: null | number; identifier?: string }; type: null | "Team" | "Individual" }[]>

getSalesOpportunitiesByParentIdTeamById

getSalesOpportunitiesByParentIdTeamById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; commissionPercent?: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; opportunityId?: null | number; referralFlag?: null | boolean; responsibleFlag?: null | boolean; salesTeam?: { _info?: {}; id?: null | number; identifier?: string }; type: null | "Team" | "Individual" }>

- Defined in src/Manage/SalesAPI.ts:807
Parameters
- id: number
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; commissionPercent?: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; opportunityId?: null | number; referralFlag?: null | boolean; responsibleFlag?: null | boolean; salesTeam?: { _info?: {}; id?: null | number; identifier?: string }; type: null | "Team" | "Individual" }>

getSalesOpportunitiesByParentIdTeamCount

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

- Defined in src/Manage/SalesAPI.ts:849
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesOpportunitiesCount

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

- Defined in src/Manage/SalesAPI.ts:860
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesOpportunitiesDefault

getSalesOpportunitiesDefault(params?: CommonParameters): Promise<{ _info?: {}; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; campaign?: { _info?: {}; id?: null | number; name?: string }; closedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; closedDate?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateBecameLead?: string; expectedCloseDate?: string; id?: number; locationId?: null | number; name: string; notes?: string; pipelineChangeDate?: string; primarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority?: { _info?: {}; id?: null | number; name?: string }; probability?: { _info?: {}; id?: null | number; name?: string }; rating?: { _info?: {}; id?: null | number; name?: string }; secondarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; source?: string; stage?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; technicalContact?: { _info?: {}; id?: null | number; name?: string }; totalSalesTax?: null | number; type?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:868
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; campaign?: { _info?: {}; id?: null | number; name?: string }; closedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; closedDate?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateBecameLead?: string; expectedCloseDate?: string; id?: number; locationId?: null | number; name: string; notes?: string; pipelineChangeDate?: string; primarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority?: { _info?: {}; id?: null | number; name?: string }; probability?: { _info?: {}; id?: null | number; name?: string }; rating?: { _info?: {}; id?: null | number; name?: string }; secondarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; source?: string; stage?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; technicalContact?: { _info?: {}; id?: null | number; name?: string }; totalSalesTax?: null | number; type?: { _info?: {}; id?: null | number; name?: string } }>

getSalesOpportunitiesRatings

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

- Defined in src/Manage/SalesAPI.ts:876
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; name: string; sortOrder?: null | number }[]>

getSalesOpportunitiesRatingsById

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

- Defined in src/Manage/SalesAPI.ts:892
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; name: string; sortOrder?: null | number }>

getSalesOpportunitiesRatingsByIdInfo

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

- Defined in src/Manage/SalesAPI.ts:932
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; name?: string; sortOrder?: null | number }>

getSalesOpportunitiesRatingsCount

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

- Defined in src/Manage/SalesAPI.ts:943
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesOpportunitiesRatingsInfo

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

- Defined in src/Manage/SalesAPI.ts:951
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; name?: string; sortOrder?: null | number }[]>

getSalesOpportunitiesRatingsInfoCount

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

- Defined in src/Manage/SalesAPI.ts:961
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesOpportunitiesStatuses

getSalesOpportunitiesStatuses(params?: CommonParameters): Promise<{ _info?: {}; closedFlag?: null | boolean; dateEntered?: string; defaultFlag?: null | boolean; enteredBy?: string; id?: number; inactiveFlag?: null | boolean; lostFlag?: null | boolean; name: string; wonFlag?: null | boolean }[]>

- Defined in src/Manage/SalesAPI.ts:969
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; dateEntered?: string; defaultFlag?: null | boolean; enteredBy?: string; id?: number; inactiveFlag?: null | boolean; lostFlag?: null | boolean; name: string; wonFlag?: null | boolean }[]>

getSalesOpportunitiesStatusesById

getSalesOpportunitiesStatusesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; closedFlag?: null | boolean; dateEntered?: string; defaultFlag?: null | boolean; enteredBy?: string; id?: number; inactiveFlag?: null | boolean; lostFlag?: null | boolean; name: string; wonFlag?: null | boolean }>

- Defined in src/Manage/SalesAPI.ts:985
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; dateEntered?: string; defaultFlag?: null | boolean; enteredBy?: string; id?: number; inactiveFlag?: null | boolean; lostFlag?: null | boolean; name: string; wonFlag?: null | boolean }>

getSalesOpportunitiesStatusesByIdInfo

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

- Defined in src/Manage/SalesAPI.ts:1025
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name?: string }>

getSalesOpportunitiesStatusesByIdUsages

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

- Defined in src/Manage/SalesAPI.ts:1036
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getSalesOpportunitiesStatusesByIdUsagesList

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

- Defined in src/Manage/SalesAPI.ts:1047
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getSalesOpportunitiesStatusesCount

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

- Defined in src/Manage/SalesAPI.ts:1058
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesOpportunitiesStatusesInfo

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

- Defined in src/Manage/SalesAPI.ts:1066
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name?: string }[]>

getSalesOpportunitiesStatusesInfoCount

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

- Defined in src/Manage/SalesAPI.ts:1076
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesOpportunitiesTypes

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

- Defined in src/Manage/SalesAPI.ts:1084
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; description: string; id?: number; inactiveFlag?: null | boolean }[]>

getSalesOpportunitiesTypesById

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

- Defined in src/Manage/SalesAPI.ts:1100
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; description: string; id?: number; inactiveFlag?: null | boolean }>

getSalesOpportunitiesTypesByIdInfo

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

- Defined in src/Manage/SalesAPI.ts:1140
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; description?: string; id?: number; inactiveFlag?: null | boolean }>

getSalesOpportunitiesTypesByIdUsages

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

- Defined in src/Manage/SalesAPI.ts:1151
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getSalesOpportunitiesTypesByIdUsagesList

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

- Defined in src/Manage/SalesAPI.ts:1162
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getSalesOpportunitiesTypesCount

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

- Defined in src/Manage/SalesAPI.ts:1173
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesOpportunitiesTypesInfo

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

- Defined in src/Manage/SalesAPI.ts:1181
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; description?: string; id?: number; inactiveFlag?: null | boolean }[]>

getSalesOpportunitiesTypesInfoCount

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

- Defined in src/Manage/SalesAPI.ts:1191
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesOrders

getSalesOrders(params?: CommonParameters): Promise<{ _info?: {}; billClosedFlag?: null | boolean; billShippedFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; configIds?: number[]; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; documentIds?: number[]; dueDate?: string; email?: string; id?: number; invoiceIds?: number[]; location?: { _info?: {}; id?: null | number; name?: string }; notes?: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; orderDate?: string; phone?: string; phoneExt?: string; poNumber?: string; productIds?: number[]; restrictDownpaymentFlag?: null | boolean; salesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; subTotal?: number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxTotal?: null | number; topCommentFlag?: null | boolean; total?: null | number }[]>

- Defined in src/Manage/SalesAPI.ts:1199
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; billClosedFlag?: null | boolean; billShippedFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; configIds?: number[]; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; documentIds?: number[]; dueDate?: string; email?: string; id?: number; invoiceIds?: number[]; location?: { _info?: {}; id?: null | number; name?: string }; notes?: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; orderDate?: string; phone?: string; phoneExt?: string; poNumber?: string; productIds?: number[]; restrictDownpaymentFlag?: null | boolean; salesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; subTotal?: number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxTotal?: null | number; topCommentFlag?: null | boolean; total?: null | number }[]>

getSalesOrdersById

getSalesOrdersById(id: number, params?: CommonParameters): Promise<{ _info?: {}; billClosedFlag?: null | boolean; billShippedFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; configIds?: number[]; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; documentIds?: number[]; dueDate?: string; email?: string; id?: number; invoiceIds?: number[]; location?: { _info?: {}; id?: null | number; name?: string }; notes?: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; orderDate?: string; phone?: string; phoneExt?: string; poNumber?: string; productIds?: number[]; restrictDownpaymentFlag?: null | boolean; salesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; subTotal?: number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxTotal?: null | number; topCommentFlag?: null | boolean; total?: null | number }>

- Defined in src/Manage/SalesAPI.ts:1215
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; billClosedFlag?: null | boolean; billShippedFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; configIds?: number[]; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; documentIds?: number[]; dueDate?: string; email?: string; id?: number; invoiceIds?: number[]; location?: { _info?: {}; id?: null | number; name?: string }; notes?: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; orderDate?: string; phone?: string; phoneExt?: string; poNumber?: string; productIds?: number[]; restrictDownpaymentFlag?: null | boolean; salesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; subTotal?: number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxTotal?: null | number; topCommentFlag?: null | boolean; total?: null | number }>

getSalesOrdersCount

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

- Defined in src/Manage/SalesAPI.ts:1253
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesOrdersStatuses

getSalesOrdersStatuses(params?: CommonParameters): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; name: string; sortOrder?: null | number }[]>

- Defined in src/Manage/SalesAPI.ts:1261
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; name: string; sortOrder?: null | number }[]>

getSalesOrdersStatusesById

getSalesOrdersStatusesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; name: string; sortOrder?: null | number }>

- Defined in src/Manage/SalesAPI.ts:1277
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; name: string; sortOrder?: null | number }>

getSalesOrdersStatusesByIdInfo

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

- Defined in src/Manage/SalesAPI.ts:1311
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name?: string }>

getSalesOrdersStatusesByIdUsages

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

- Defined in src/Manage/SalesAPI.ts:1322
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getSalesOrdersStatusesByIdUsagesList

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

- Defined in src/Manage/SalesAPI.ts:1333
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getSalesOrdersStatusesByParentIdEmailtemplates

getSalesOrdersStatusesByParentIdEmailtemplates(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; body: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; lastName?: string; status?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }[]>

- Defined in src/Manage/SalesAPI.ts:1344
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; body: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; lastName?: string; status?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }[]>

getSalesOrdersStatusesByParentIdEmailtemplatesById

getSalesOrdersStatusesByParentIdEmailtemplatesById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; body: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; lastName?: string; status?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }>

- Defined in src/Manage/SalesAPI.ts:1366
Parameters
- id: number
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; body: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; lastName?: string; status?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }>

getSalesOrdersStatusesByParentIdEmailtemplatesCount

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

- Defined in src/Manage/SalesAPI.ts:1412
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesOrdersStatusesByParentIdNotifications

getSalesOrdersStatusesByParentIdNotifications(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; email?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; workflowStep?: null | number }[]>

- Defined in src/Manage/SalesAPI.ts:1423
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; email?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; workflowStep?: null | number }[]>

getSalesOrdersStatusesByParentIdNotificationsById

getSalesOrdersStatusesByParentIdNotificationsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; email?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; workflowStep?: null | number }>

- Defined in src/Manage/SalesAPI.ts:1445
Parameters
- id: number
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; email?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; workflowStep?: null | number }>

getSalesOrdersStatusesByParentIdNotificationsCount

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

- Defined in src/Manage/SalesAPI.ts:1491
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesOrdersStatusesCount

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

- Defined in src/Manage/SalesAPI.ts:1502
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesOrdersStatusesInfo

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

- Defined in src/Manage/SalesAPI.ts:1510
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name?: string }[]>

getSalesOrdersStatusesInfoCount

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

- Defined in src/Manage/SalesAPI.ts:1518
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesProbabilities

getSalesProbabilities(params?: CommonParameters): Promise<{ _info?: {}; id?: number; probability: number }[]>

- Defined in src/Manage/SalesAPI.ts:1526
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; probability: number }[]>

getSalesProbabilitiesById

getSalesProbabilitiesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; probability: number }>

- Defined in src/Manage/SalesAPI.ts:1542
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; probability: number }>

getSalesProbabilitiesByIdInfo

getSalesProbabilitiesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; probability?: number }>

- Defined in src/Manage/SalesAPI.ts:1576
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; probability?: number }>

getSalesProbabilitiesCount

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

- Defined in src/Manage/SalesAPI.ts:1587
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesProbabilitiesInfo

getSalesProbabilitiesInfo(params?: CommonParameters): Promise<{ _info?: {}; id?: number; probability?: number }[]>

- Defined in src/Manage/SalesAPI.ts:1595
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; probability?: number }[]>

getSalesProbabilitiesInfoCount

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

- Defined in src/Manage/SalesAPI.ts:1603
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesQuotas

getSalesQuotas(params?: CommonParameters): Promise<{ _info?: {}; aprilMargin?: null | number; aprilRevenue?: null | number; augustMargin?: null | number; augustRevenue?: null | number; category?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; decemberMargin?: null | number; decemberRevenue?: null | number; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; februaryMargin?: null | number; februaryRevenue?: null | number; forecastYear?: null | number; id?: number; januaryMargin?: null | number; januaryRevenue?: null | number; julyMargin?: null | number; julyRevenue?: null | number; juneMargin?: null | number; juneRevenue?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; marchMargin?: null | number; marchRevenue?: null | number; mayMargin?: null | number; mayRevenue?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; novemberMargin?: null | number; novemberRevenue?: null | number; octoberMargin?: null | number; octoberRevenue?: null | number; septemberMargin?: null | number; septemberRevenue?: null | number; subCategory?: { _info?: {}; id?: null | number; name?: string } }[]>

- Defined in src/Manage/SalesAPI.ts:1611
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; aprilMargin?: null | number; aprilRevenue?: null | number; augustMargin?: null | number; augustRevenue?: null | number; category?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; decemberMargin?: null | number; decemberRevenue?: null | number; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; februaryMargin?: null | number; februaryRevenue?: null | number; forecastYear?: null | number; id?: number; januaryMargin?: null | number; januaryRevenue?: null | number; julyMargin?: null | number; julyRevenue?: null | number; juneMargin?: null | number; juneRevenue?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; marchMargin?: null | number; marchRevenue?: null | number; mayMargin?: null | number; mayRevenue?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; novemberMargin?: null | number; novemberRevenue?: null | number; octoberMargin?: null | number; octoberRevenue?: null | number; septemberMargin?: null | number; septemberRevenue?: null | number; subCategory?: { _info?: {}; id?: null | number; name?: string } }[]>

getSalesQuotasById

getSalesQuotasById(id: number, params?: CommonParameters): Promise<{ _info?: {}; aprilMargin?: null | number; aprilRevenue?: null | number; augustMargin?: null | number; augustRevenue?: null | number; category?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; decemberMargin?: null | number; decemberRevenue?: null | number; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; februaryMargin?: null | number; februaryRevenue?: null | number; forecastYear?: null | number; id?: number; januaryMargin?: null | number; januaryRevenue?: null | number; julyMargin?: null | number; julyRevenue?: null | number; juneMargin?: null | number; juneRevenue?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; marchMargin?: null | number; marchRevenue?: null | number; mayMargin?: null | number; mayRevenue?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; novemberMargin?: null | number; novemberRevenue?: null | number; octoberMargin?: null | number; octoberRevenue?: null | number; septemberMargin?: null | number; septemberRevenue?: null | number; subCategory?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:1627
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; aprilMargin?: null | number; aprilRevenue?: null | number; augustMargin?: null | number; augustRevenue?: null | number; category?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; decemberMargin?: null | number; decemberRevenue?: null | number; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; februaryMargin?: null | number; februaryRevenue?: null | number; forecastYear?: null | number; id?: number; januaryMargin?: null | number; januaryRevenue?: null | number; julyMargin?: null | number; julyRevenue?: null | number; juneMargin?: null | number; juneRevenue?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; marchMargin?: null | number; marchRevenue?: null | number; mayMargin?: null | number; mayRevenue?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; novemberMargin?: null | number; novemberRevenue?: null | number; octoberMargin?: null | number; octoberRevenue?: null | number; septemberMargin?: null | number; septemberRevenue?: null | number; subCategory?: { _info?: {}; id?: null | number; name?: string } }>

getSalesQuotasCount

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

- Defined in src/Manage/SalesAPI.ts:1658
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesRoles

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

- Defined in src/Manage/SalesAPI.ts:1666
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; name: string }[]>

getSalesRolesById

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

- Defined in src/Manage/SalesAPI.ts:1682
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; name: string }>

getSalesRolesCount

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

- Defined in src/Manage/SalesAPI.ts:1713
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesSalesTeams

getSalesSalesTeams(params?: CommonParameters): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; salesTeamDescription: string; salesTeamIdentifier: string; salesTeamLocation?: { _info?: {}; id?: null | number; name?: string } }[]>

- Defined in src/Manage/SalesAPI.ts:1721
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; salesTeamDescription: string; salesTeamIdentifier: string; salesTeamLocation?: { _info?: {}; id?: null | number; name?: string } }[]>

getSalesSalesTeamsById

getSalesSalesTeamsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; salesTeamDescription: string; salesTeamIdentifier: string; salesTeamLocation?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:1737
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; salesTeamDescription: string; salesTeamIdentifier: string; salesTeamLocation?: { _info?: {}; id?: null | number; name?: string } }>

getSalesSalesTeamsByParentIdMembers

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

- Defined in src/Manage/SalesAPI.ts:1768
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; allowAccessFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]>

getSalesSalesTeamsByParentIdMembersById

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

- Defined in src/Manage/SalesAPI.ts:1790
Parameters
- id: number
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; allowAccessFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

getSalesSalesTeamsByParentIdMembersCount

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

- Defined in src/Manage/SalesAPI.ts:1836
Parameters
- parentId: number
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesSalesTeamsCount

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

- Defined in src/Manage/SalesAPI.ts:1847
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesScheduleHolidaylistsInfoCount

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

- Defined in src/Manage/SalesAPI.ts:1855
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesServicePriorityInfoCount

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

- Defined in src/Manage/SalesAPI.ts:1863
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesStages

getSalesStages(params?: CommonParameters): Promise<{ _info?: {}; color?: string; id?: number; name: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }[]>

- Defined in src/Manage/SalesAPI.ts:1871
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; color?: string; id?: number; name: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }[]>

getSalesStagesById

getSalesStagesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; color?: string; id?: number; name: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }>

- Defined in src/Manage/SalesAPI.ts:1887
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; color?: string; id?: number; name: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }>

getSalesStagesByIdInfo

getSalesStagesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; color?: string; id?: number; name?: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }>

- Defined in src/Manage/SalesAPI.ts:1921
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; color?: string; id?: number; name?: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }>

getSalesStagesByIdUsages

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

- Defined in src/Manage/SalesAPI.ts:1929
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getSalesStagesByIdUsagesList

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

- Defined in src/Manage/SalesAPI.ts:1937
Parameters
- id: number
- params: CommonParameters = {}
Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getSalesStagesCount

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

- Defined in src/Manage/SalesAPI.ts:1945
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

getSalesStagesInfo

getSalesStagesInfo(params?: CommonParameters): Promise<{ _info?: {}; color?: string; id?: number; name?: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }[]>

- Defined in src/Manage/SalesAPI.ts:1953
Parameters
- params: CommonParameters = {}
Returns Promise<{ _info?: {}; color?: string; id?: number; name?: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }[]>

getSalesStagesInfoCount

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

- Defined in src/Manage/SalesAPI.ts:1961
Parameters
- params: CommonParameters = {}
Returns Promise<{ count?: number }>

patchSalesActivitiesById

patchSalesActivitiesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; assignTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; assignedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; campaign?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateEnd?: string; dateStart?: string; email?: string; id?: number; mobileGuid?: null | string; name: string; notes?: string; notifyFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; phoneNumber?: string; reminder?: { _info?: {}; id?: null | number; name?: string }; scheduleStatus?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; type?: { _info?: {}; id?: null | number; name?: string }; where?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:143
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; assignTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; assignedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; campaign?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateEnd?: string; dateStart?: string; email?: string; id?: number; mobileGuid?: null | string; name: string; notes?: string; notifyFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; phoneNumber?: string; reminder?: { _info?: {}; id?: null | number; name?: string }; scheduleStatus?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; type?: { _info?: {}; id?: null | number; name?: string }; where?: { _info?: {}; id?: null | number; name?: string } }>

patchSalesActivitiesStatusesById

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

- Defined in src/Manage/SalesAPI.ts:204
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; spawnFollowupFlag?: null | boolean }>

patchSalesActivitiesTypesById

patchSalesActivitiesTypesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; historyFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; memoFlag?: null | boolean; name: string; points?: null | number }>

- Defined in src/Manage/SalesAPI.ts:291
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; historyFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; memoFlag?: null | boolean; name: string; points?: null | number }>

patchSalesCommissionsById

patchSalesCommissionsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementType?: { _info?: {}; id?: null | number; name?: string }; agreementsFlag?: null | boolean; billingMethod?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; commissionBasis?: null | "GrossProfit" | "SalesAmount"; commissionPercent?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateEnd?: string; dateStart?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; invoiceOption?: null | "AllInvoices" | "PaidInvoices"; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; myOpportunitiesFlag?: null | boolean; numberOfMonths?: null | number; productCategory?: { _info?: {}; id?: null | number; name?: string }; productSubCategory?: { _info?: {}; id?: null | number; name?: string }; productsFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; projectBoard?: { _info?: {}; id?: null | number; name?: string }; projectType?: { _info?: {}; id?: null | number; name?: string }; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; servicesFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; territory?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string } }>

- Defined in src/Manage/SalesAPI.ts:371
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementType?: { _info?: {}; id?: null | number; name?: string }; agreementsFlag?: null | boolean; billingMethod?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; commissionBasis?: null | "GrossProfit" | "SalesAmount"; commissionPercent?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateEnd?: string; dateStart?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; invoiceOption?: null | "AllInvoices" | "PaidInvoices"; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; myOpportunitiesFlag?: null | boolean; numberOfMonths?: null | number; productCategory?: { _info?: {}; id?: null | number; name?: string }; productSubCategory?: { _info?: {}; id?: null | number; name?: string }; productsFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; projectBoard?: { _info?: {}; id?: null | number; name?: string }; projectType?: { _info?: {}; id?: null | number; name?: string }; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; servicesFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; territory?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string } }>

patchSalesOpportunitiesById

patchSalesOpportunitiesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; campaign?: { _info?: {}; id?: null | number; name?: string }; closedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; closedDate?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateBecameLead?: string; expectedCloseDate?: string; id?: number; locationId?: null | number; name: string; notes?: string; pipelineChangeDate?: string; primarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority?: { _info?: {}; id?: null | number; name?: string }; probability?: { _info?: {}; id?: null | number; name?: string }; rating?: { _info?: {}; id?: null | number; name?: string }; secondarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; source?: string; stage?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; technicalContact?: { _info?: {}; id?: null | number; name?: string }; totalSalesTax?: null | number; type?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:448
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; campaign?: { _info?: {}; id?: null | number; name?: string }; closedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; closedDate?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateBecameLead?: string; expectedCloseDate?: string; id?: number; locationId?: null | number; name: string; notes?: string; pipelineChangeDate?: string; primarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority?: { _info?: {}; id?: null | number; name?: string }; probability?: { _info?: {}; id?: null | number; name?: string }; rating?: { _info?: {}; id?: null | number; name?: string }; secondarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; source?: string; stage?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; technicalContact?: { _info?: {}; id?: null | number; name?: string }; totalSalesTax?: null | number; type?: { _info?: {}; id?: null | number; name?: string } }>

patchSalesOpportunitiesByParentIdContactsById

patchSalesOpportunitiesByParentIdContactsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; id?: number; notes?: string; opportunityId?: null | number; phoneNumber?: string; referralFlag?: null | boolean; role?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:559
Parameters
- id: number
- parentId: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; id?: number; notes?: string; opportunityId?: null | number; phoneNumber?: string; referralFlag?: null | boolean; role?: { _info?: {}; id?: null | number; name?: string } }>

patchSalesOpportunitiesByParentIdForecast

patchSalesOpportunitiesByParentIdForecast(parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; agreementRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; expectedProbability?: number; expenseRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastItems?: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }[]; forecastRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastTotalWithTaxes?: null | number; id?: number; inclusiveRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; lostRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; openRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue1?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue2?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; productRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; recurringTotal?: null | number; salesTaxRevenue?: null | number; serviceRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; wonRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number } }>

- Defined in src/Manage/SalesAPI.ts:619
Parameters
- parentId: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; agreementRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; expectedProbability?: number; expenseRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastItems?: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }[]; forecastRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastTotalWithTaxes?: null | number; id?: number; inclusiveRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; lostRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; openRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue1?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue2?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; productRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; recurringTotal?: null | number; salesTaxRevenue?: null | number; serviceRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; wonRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number } }>

patchSalesOpportunitiesByParentIdForecastById

patchSalesOpportunitiesByParentIdForecastById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }>

- Defined in src/Manage/SalesAPI.ts:676
Parameters
- id: number
- parentId: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }>

patchSalesOpportunitiesByParentIdNotesById

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

- Defined in src/Manage/SalesAPI.ts:765
Parameters
- id: number
- parentId: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; enteredBy?: string; flagged?: null | boolean; id?: number; mobileGuid?: null | string; opportunityId?: null | number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

patchSalesOpportunitiesByParentIdTeamById

patchSalesOpportunitiesByParentIdTeamById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; commissionPercent?: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; opportunityId?: null | number; referralFlag?: null | boolean; responsibleFlag?: null | boolean; salesTeam?: { _info?: {}; id?: null | number; identifier?: string }; type: null | "Team" | "Individual" }>

- Defined in src/Manage/SalesAPI.ts:837
Parameters
- id: number
- parentId: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; commissionPercent?: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; opportunityId?: null | number; referralFlag?: null | boolean; responsibleFlag?: null | boolean; salesTeam?: { _info?: {}; id?: null | number; identifier?: string }; type: null | "Team" | "Individual" }>

patchSalesOpportunitiesRatingsById

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

- Defined in src/Manage/SalesAPI.ts:921
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; id?: number; name: string; sortOrder?: null | number }>

patchSalesOpportunitiesStatusesById

patchSalesOpportunitiesStatusesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; closedFlag?: null | boolean; dateEntered?: string; defaultFlag?: null | boolean; enteredBy?: string; id?: number; inactiveFlag?: null | boolean; lostFlag?: null | boolean; name: string; wonFlag?: null | boolean }>

- Defined in src/Manage/SalesAPI.ts:1014
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; dateEntered?: string; defaultFlag?: null | boolean; enteredBy?: string; id?: number; inactiveFlag?: null | boolean; lostFlag?: null | boolean; name: string; wonFlag?: null | boolean }>

patchSalesOpportunitiesTypesById

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

- Defined in src/Manage/SalesAPI.ts:1129
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; description: string; id?: number; inactiveFlag?: null | boolean }>

patchSalesOrdersById

patchSalesOrdersById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; billClosedFlag?: null | boolean; billShippedFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; configIds?: number[]; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; documentIds?: number[]; dueDate?: string; email?: string; id?: number; invoiceIds?: number[]; location?: { _info?: {}; id?: null | number; name?: string }; notes?: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; orderDate?: string; phone?: string; phoneExt?: string; poNumber?: string; productIds?: number[]; restrictDownpaymentFlag?: null | boolean; salesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; subTotal?: number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxTotal?: null | number; topCommentFlag?: null | boolean; total?: null | number }>

- Defined in src/Manage/SalesAPI.ts:1238
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; billClosedFlag?: null | boolean; billShippedFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; configIds?: number[]; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; documentIds?: number[]; dueDate?: string; email?: string; id?: number; invoiceIds?: number[]; location?: { _info?: {}; id?: null | number; name?: string }; notes?: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; orderDate?: string; phone?: string; phoneExt?: string; poNumber?: string; productIds?: number[]; restrictDownpaymentFlag?: null | boolean; salesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; subTotal?: number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxTotal?: null | number; topCommentFlag?: null | boolean; total?: null | number }>

patchSalesOrdersStatusesById

patchSalesOrdersStatusesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; name: string; sortOrder?: null | number }>

- Defined in src/Manage/SalesAPI.ts:1300
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; name: string; sortOrder?: null | number }>

patchSalesOrdersStatusesByParentIdEmailtemplatesById

patchSalesOrdersStatusesByParentIdEmailtemplatesById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; body: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; lastName?: string; status?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }>

- Defined in src/Manage/SalesAPI.ts:1400
Parameters
- id: number
- parentId: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; body: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; lastName?: string; status?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }>

patchSalesOrdersStatusesByParentIdNotificationsById

patchSalesOrdersStatusesByParentIdNotificationsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; email?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; workflowStep?: null | number }>

- Defined in src/Manage/SalesAPI.ts:1479
Parameters
- id: number
- parentId: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; email?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; workflowStep?: null | number }>

patchSalesProbabilitiesById

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

- Defined in src/Manage/SalesAPI.ts:1565
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; id?: number; probability: number }>

patchSalesQuotasById

patchSalesQuotasById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; aprilMargin?: null | number; aprilRevenue?: null | number; augustMargin?: null | number; augustRevenue?: null | number; category?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; decemberMargin?: null | number; decemberRevenue?: null | number; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; februaryMargin?: null | number; februaryRevenue?: null | number; forecastYear?: null | number; id?: number; januaryMargin?: null | number; januaryRevenue?: null | number; julyMargin?: null | number; julyRevenue?: null | number; juneMargin?: null | number; juneRevenue?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; marchMargin?: null | number; marchRevenue?: null | number; mayMargin?: null | number; mayRevenue?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; novemberMargin?: null | number; novemberRevenue?: null | number; octoberMargin?: null | number; octoberRevenue?: null | number; septemberMargin?: null | number; septemberRevenue?: null | number; subCategory?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:1650
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; aprilMargin?: null | number; aprilRevenue?: null | number; augustMargin?: null | number; augustRevenue?: null | number; category?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; decemberMargin?: null | number; decemberRevenue?: null | number; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; februaryMargin?: null | number; februaryRevenue?: null | number; forecastYear?: null | number; id?: number; januaryMargin?: null | number; januaryRevenue?: null | number; julyMargin?: null | number; julyRevenue?: null | number; juneMargin?: null | number; juneRevenue?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; marchMargin?: null | number; marchRevenue?: null | number; mayMargin?: null | number; mayRevenue?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; novemberMargin?: null | number; novemberRevenue?: null | number; octoberMargin?: null | number; octoberRevenue?: null | number; septemberMargin?: null | number; septemberRevenue?: null | number; subCategory?: { _info?: {}; id?: null | number; name?: string } }>

patchSalesRolesById

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

- Defined in src/Manage/SalesAPI.ts:1705
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; id?: number; name: string }>

patchSalesSalesTeamsById

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

- Defined in src/Manage/SalesAPI.ts:1760
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; salesTeamDescription: string; salesTeamIdentifier: string; salesTeamLocation?: { _info?: {}; id?: null | number; name?: string } }>

patchSalesSalesTeamsByParentIdMembersById

patchSalesSalesTeamsByParentIdMembersById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; allowAccessFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:1824
Parameters
- id: number
- parentId: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; allowAccessFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

patchSalesStagesById

patchSalesStagesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; color?: string; id?: number; name: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }>

- Defined in src/Manage/SalesAPI.ts:1910
Parameters
- id: number
- patchOperations: { op?: string; path?: string; value?: {} }[]
Returns Promise<{ _info?: {}; color?: string; id?: number; name: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }>

postSalesActivities

postSalesActivities(activity: { _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; assignTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; assignedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; campaign?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateEnd?: string; dateStart?: string; email?: string; id?: number; mobileGuid?: null | string; name: string; notes?: string; notifyFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; phoneNumber?: string; reminder?: { _info?: {}; id?: null | number; name?: string }; scheduleStatus?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; type?: { _info?: {}; id?: null | number; name?: string }; where?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; assignTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; assignedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; campaign?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateEnd?: string; dateStart?: string; email?: string; id?: number; mobileGuid?: null | string; name: string; notes?: string; notifyFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; phoneNumber?: string; reminder?: { _info?: {}; id?: null | number; name?: string }; scheduleStatus?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; type?: { _info?: {}; id?: null | number; name?: string }; where?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:112
Parameters
- activity: { _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; assignTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; assignedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; campaign?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateEnd?: string; dateStart?: string; email?: string; id?: number; mobileGuid?: null | string; name: string; notes?: string; notifyFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; phoneNumber?: string; reminder?: { _info?: {}; id?: null | number; name?: string }; scheduleStatus?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; type?: { _info?: {}; id?: null | number; name?: string }; where?: { _info?: {}; id?: null | number; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
    - Optional type?: string
  - Optional assignTo?: { _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 assignedBy?: { _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 campaign?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: 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 contact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional currencyCode?: string
    - Optional currencyIdentifier?: string
    - Optional decimalSeparator?: string
    - Optional displayIdFlag?: boolean
    - Optional displaySymbolFlag?: boolean
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
    - Optional negativeParenthesesFlag?: boolean
    - Optional numberOfDecimals?: number
      
      Format: int32
    - Optional rightAlign?: boolean
    - Optional symbol?: string
    - Optional thousandsSeparator?: string
  - Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
  - Optional dateEnd?: string
    
    Format: date-time
  - Optional dateStart?: string
    
    Format: date-time
  - Optional email?: string
    description
    Max length: 250;
  - Optional id?: number
    
    Format: int32
  - Optional mobileGuid?: null | string
    
    Format: uuid
  - name: string
    description
    Max length: 100;
  - Optional notes?: string
  - Optional notifyFlag?: null | boolean
  - Optional opportunity?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional phoneNumber?: string
    description
    Max length: 30;
  - Optional reminder?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional scheduleStatus?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional status?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional ticket?: { _info?: {}; id?: null | number; summary?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional summary?: string
  - Optional type?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional where?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
Returns Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; assignTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; assignedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; campaign?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateEnd?: string; dateStart?: string; email?: string; id?: number; mobileGuid?: null | string; name: string; notes?: string; notifyFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; phoneNumber?: string; reminder?: { _info?: {}; id?: null | number; name?: string }; scheduleStatus?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; type?: { _info?: {}; id?: null | number; name?: string }; where?: { _info?: {}; id?: null | number; name?: string } }>

postSalesActivitiesStatuses

postSalesActivitiesStatuses(activityStatus: { _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; spawnFollowupFlag?: null | boolean }): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; spawnFollowupFlag?: null | boolean }>

- Defined in src/Manage/SalesAPI.ts:167
Parameters
- activityStatus: { _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; spawnFollowupFlag?: null | boolean }
  - Optional _info?: {}
    - [key: string]: string
  - Optional closedFlag?: null | boolean
  - Optional defaultFlag?: null | boolean
  - Optional id?: number
    
    Format: int32
  - Optional inactiveFlag?: null | boolean
  - name: string
    description
    Max length: 30;
  - Optional spawnFollowupFlag?: null | boolean
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; spawnFollowupFlag?: null | boolean }>

postSalesActivitiesTypes

postSalesActivitiesTypes(activityType: { _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; historyFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; memoFlag?: null | boolean; name: string; points?: null | number }): Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; historyFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; memoFlag?: null | boolean; name: string; points?: null | number }>

- Defined in src/Manage/SalesAPI.ts:260
Parameters
- activityType: { _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; historyFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; memoFlag?: null | boolean; name: string; points?: null | number }
  - Optional _info?: {}
    - [key: string]: string
  - Optional defaultFlag?: null | boolean
  - Optional emailFlag?: null | boolean
  - Optional historyFlag?: null | boolean
  - Optional id?: number
    
    Format: int32
  - Optional inactiveFlag?: null | boolean
  - Optional memoFlag?: null | boolean
  - name: string
    description
    Max length: 50;
  - Optional points?: null | number
    
    Format: int32
Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; historyFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; memoFlag?: null | boolean; name: string; points?: null | number }>

postSalesCommissions

postSalesCommissions(commission: { _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementType?: { _info?: {}; id?: null | number; name?: string }; agreementsFlag?: null | boolean; billingMethod?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; commissionBasis?: null | "GrossProfit" | "SalesAmount"; commissionPercent?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateEnd?: string; dateStart?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; invoiceOption?: null | "AllInvoices" | "PaidInvoices"; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; myOpportunitiesFlag?: null | boolean; numberOfMonths?: null | number; productCategory?: { _info?: {}; id?: null | number; name?: string }; productSubCategory?: { _info?: {}; id?: null | number; name?: string }; productsFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; projectBoard?: { _info?: {}; id?: null | number; name?: string }; projectType?: { _info?: {}; id?: null | number; name?: string }; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; servicesFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; territory?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string } }): Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementType?: { _info?: {}; id?: null | number; name?: string }; agreementsFlag?: null | boolean; billingMethod?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; commissionBasis?: null | "GrossProfit" | "SalesAmount"; commissionPercent?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateEnd?: string; dateStart?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; invoiceOption?: null | "AllInvoices" | "PaidInvoices"; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; myOpportunitiesFlag?: null | boolean; numberOfMonths?: null | number; productCategory?: { _info?: {}; id?: null | number; name?: string }; productSubCategory?: { _info?: {}; id?: null | number; name?: string }; productsFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; projectBoard?: { _info?: {}; id?: null | number; name?: string }; projectType?: { _info?: {}; id?: null | number; name?: string }; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; servicesFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; territory?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string } }>

- Defined in src/Manage/SalesAPI.ts:340
Parameters
- commission: { _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementType?: { _info?: {}; id?: null | number; name?: string }; agreementsFlag?: null | boolean; billingMethod?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; commissionBasis?: null | "GrossProfit" | "SalesAmount"; commissionPercent?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateEnd?: string; dateStart?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; invoiceOption?: null | "AllInvoices" | "PaidInvoices"; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; myOpportunitiesFlag?: null | boolean; numberOfMonths?: null | number; productCategory?: { _info?: {}; id?: null | number; name?: string }; productSubCategory?: { _info?: {}; id?: null | number; name?: string }; productsFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; projectBoard?: { _info?: {}; id?: null | number; name?: string }; projectType?: { _info?: {}; id?: null | number; name?: string }; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; servicesFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; territory?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
    - Optional type?: string
  - Optional agreementType?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional agreementsFlag?: null | boolean
  - Optional billingMethod?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"
  - Optional commissionBasis?: null | "GrossProfit" | "SalesAmount"
  - Optional commissionPercent?: null | number
    
    Format: double
  - 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 dateEnd?: string
    
    Format: date-time
  - Optional dateStart?: string
    
    Format: date-time
  - 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 invoiceOption?: null | "AllInvoices" | "PaidInvoices"
  - Optional item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional serializedFlag?: null | boolean
  - Optional location?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - Optional myOpportunitiesFlag?: null | boolean
  - Optional numberOfMonths?: null | number
    
    Format: int32
  - Optional productCategory?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional productSubCategory?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional productsFlag?: null | boolean
  - Optional project?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional projectBoard?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional projectType?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional serviceBoard?: { _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
  - Optional servicesFlag?: null | boolean
  - Optional site?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional territory?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional ticket?: { _info?: {}; id?: null | number; summary?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional summary?: string
Returns Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementType?: { _info?: {}; id?: null | number; name?: string }; agreementsFlag?: null | boolean; billingMethod?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; commissionBasis?: null | "GrossProfit" | "SalesAmount"; commissionPercent?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateEnd?: string; dateStart?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; invoiceOption?: null | "AllInvoices" | "PaidInvoices"; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; myOpportunitiesFlag?: null | boolean; numberOfMonths?: null | number; productCategory?: { _info?: {}; id?: null | number; name?: string }; productSubCategory?: { _info?: {}; id?: null | number; name?: string }; productsFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; projectBoard?: { _info?: {}; id?: null | number; name?: string }; projectType?: { _info?: {}; id?: null | number; name?: string }; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; servicesFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; territory?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string } }>

postSalesOpportunities

postSalesOpportunities(opportunity: { _info?: {}; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; campaign?: { _info?: {}; id?: null | number; name?: string }; closedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; closedDate?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateBecameLead?: string; expectedCloseDate?: string; id?: number; locationId?: null | number; name: string; notes?: string; pipelineChangeDate?: string; primarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority?: { _info?: {}; id?: null | number; name?: string }; probability?: { _info?: {}; id?: null | number; name?: string }; rating?: { _info?: {}; id?: null | number; name?: string }; secondarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; source?: string; stage?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; technicalContact?: { _info?: {}; id?: null | number; name?: string }; totalSalesTax?: null | number; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; campaign?: { _info?: {}; id?: null | number; name?: string }; closedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; closedDate?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateBecameLead?: string; expectedCloseDate?: string; id?: number; locationId?: null | number; name: string; notes?: string; pipelineChangeDate?: string; primarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority?: { _info?: {}; id?: null | number; name?: string }; probability?: { _info?: {}; id?: null | number; name?: string }; rating?: { _info?: {}; id?: null | number; name?: string }; secondarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; source?: string; stage?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; technicalContact?: { _info?: {}; id?: null | number; name?: string }; totalSalesTax?: null | number; type?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:417
Parameters
- opportunity: { _info?: {}; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; campaign?: { _info?: {}; id?: null | number; name?: string }; closedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; closedDate?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateBecameLead?: string; expectedCloseDate?: string; id?: number; locationId?: null | number; name: string; notes?: string; pipelineChangeDate?: string; primarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority?: { _info?: {}; id?: null | number; name?: string }; probability?: { _info?: {}; id?: null | number; name?: string }; rating?: { _info?: {}; id?: null | number; name?: string }; secondarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; source?: string; stage?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; technicalContact?: { _info?: {}; id?: null | number; name?: string }; totalSalesTax?: null | number; type?: { _info?: {}; id?: null | number; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - Optional billToContact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional billToSite?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional billingTerms?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional businessUnitId?: null | number
    
    Format: int32
    
    description
    Required On Updates;
  - Optional campaign?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional closedBy?: { _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 closedDate?: string
    
    Format: date-time
  - Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - Optional companyLocationId?: null | number
    
    Format: int32
  - Optional contact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional currencyCode?: string
    - Optional currencyIdentifier?: string
    - Optional decimalSeparator?: string
    - Optional displayIdFlag?: boolean
    - Optional displaySymbolFlag?: boolean
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
    - Optional negativeParenthesesFlag?: boolean
    - Optional numberOfDecimals?: number
      
      Format: int32
    - Optional rightAlign?: boolean
    - Optional symbol?: string
    - Optional thousandsSeparator?: string
  - Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
  - Optional customerPO?: string
    description
    Max length: 25;
  - Optional dateBecameLead?: string
    
    Format: date-time
  - Optional expectedCloseDate?: string
    
    Format: date-time
    
    description
    Required On Updates;
  - Optional id?: number
    
    Format: int32
  - Optional locationId?: null | number
    
    Format: int32
    
    description
    Required On Updates;
  - name: string
    description
    Max length: 100;
  - Optional notes?: string
  - Optional pipelineChangeDate?: string
    
    Format: date-time
  - Optional primarySalesRep?: { _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 priority?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional probability?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional rating?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional secondarySalesRep?: { _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 shipToCompany?: { _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 shipToContact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional shipToSite?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional site?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional source?: string
    description
    Max length: 50;
  - Optional stage?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional status?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional taxCode?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional technicalContact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional totalSalesTax?: null | number
    
    Format: double
  - Optional type?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
Returns Promise<{ _info?: {}; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; campaign?: { _info?: {}; id?: null | number; name?: string }; closedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; closedDate?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateBecameLead?: string; expectedCloseDate?: string; id?: number; locationId?: null | number; name: string; notes?: string; pipelineChangeDate?: string; primarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority?: { _info?: {}; id?: null | number; name?: string }; probability?: { _info?: {}; id?: null | number; name?: string }; rating?: { _info?: {}; id?: null | number; name?: string }; secondarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; source?: string; stage?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; technicalContact?: { _info?: {}; id?: null | number; name?: string }; totalSalesTax?: null | number; type?: { _info?: {}; id?: null | number; name?: string } }>

postSalesOpportunitiesByIdConvertToAgreement

postSalesOpportunitiesByIdConvertToAgreement(id: number, conversion: { agreementId?: number; billCycleId?: null | number; billOneTimeFlag?: null | boolean; businessUnitId?: null | number; endDate?: string; includeAllDocumentsFlag?: null | boolean; includeAllNotesFlag?: null | boolean; includeAllProductsFlag?: null | boolean; includeDocumentIds?: number[]; includeNoteIds?: number[]; includeProductIds?: number[]; locationId?: null | number; name?: string; noEndingDateFlag?: null | boolean; startDate?: string; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; allowOverruns?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billStartDate?: string; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billableExpenseInvoice?: null | boolean; billableProductInvoice?: null | boolean; billableTimeInvoice?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: null | boolean; cancelledFlag?: null | boolean; carryOverUnused?: null | boolean; chargeToFirm?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; coverAgreementExpense?: null | boolean; coverAgreementProduct?: null | boolean; coverAgreementTime?: null | boolean; coverSalesTax?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateCancelled?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"; employeeCompRate?: null | "Actual" | "Hourly"; endDate?: string; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; internalNotes?: string; invoiceDescription?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle?: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; nextInvoiceDate?: string; noEndingDateFlag?: null | boolean; oneTimeFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; periodType?: null | "Current" | "Future" | "Both" | "Undefined"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFirstBill?: null | number; prorateFlag?: null | boolean; reasonCancelled?: string; restrictDepartmentFlag?: null | boolean; restrictDownPayment?: null | boolean; restrictLocationFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; startDate?: string; subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subContractContact?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxable?: null | boolean; topComment?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; workOrder?: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:459
Parameters
- id: number
- conversion: { agreementId?: number; billCycleId?: null | number; billOneTimeFlag?: null | boolean; businessUnitId?: null | number; endDate?: string; includeAllDocumentsFlag?: null | boolean; includeAllNotesFlag?: null | boolean; includeAllProductsFlag?: null | boolean; includeDocumentIds?: number[]; includeNoteIds?: number[]; includeProductIds?: number[]; locationId?: null | number; name?: string; noEndingDateFlag?: null | boolean; startDate?: string; type?: { _info?: {}; id?: null | number; name?: string } }
  - Optional agreementId?: number
    
    Format: int32
  - Optional billCycleId?: null | number
    
    Format: int32
  - Optional billOneTimeFlag?: null | boolean
  - Optional businessUnitId?: null | number
    
    Format: int32
  - Optional endDate?: string
  - Optional includeAllDocumentsFlag?: null | boolean
  - Optional includeAllNotesFlag?: null | boolean
  - Optional includeAllProductsFlag?: null | boolean
  - Optional includeDocumentIds?: number[]
  - Optional includeNoteIds?: number[]
  - Optional includeProductIds?: number[]
  - Optional locationId?: null | number
    
    Format: int32
  - Optional name?: string
  - Optional noEndingDateFlag?: null | boolean
  - Optional startDate?: string
  - Optional type?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
Returns Promise<{ _info?: {}; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; allowOverruns?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billStartDate?: string; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billableExpenseInvoice?: null | boolean; billableProductInvoice?: null | boolean; billableTimeInvoice?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: null | boolean; cancelledFlag?: null | boolean; carryOverUnused?: null | boolean; chargeToFirm?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; coverAgreementExpense?: null | boolean; coverAgreementProduct?: null | boolean; coverAgreementTime?: null | boolean; coverSalesTax?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateCancelled?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"; employeeCompRate?: null | "Actual" | "Hourly"; endDate?: string; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; internalNotes?: string; invoiceDescription?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle?: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; nextInvoiceDate?: string; noEndingDateFlag?: null | boolean; oneTimeFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; periodType?: null | "Current" | "Future" | "Both" | "Undefined"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFirstBill?: null | number; prorateFlag?: null | boolean; reasonCancelled?: string; restrictDepartmentFlag?: null | boolean; restrictDownPayment?: null | boolean; restrictLocationFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; startDate?: string; subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subContractContact?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxable?: null | boolean; topComment?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; workOrder?: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

postSalesOpportunitiesByIdConvertToProject

postSalesOpportunitiesByIdConvertToProject(id: number, conversion: { board?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; estimatedEnd?: string; estimatedStart?: string; includeAllDocumentsFlag?: null | boolean; includeAllNotesFlag?: null | boolean; includeAllProductsFlag?: null | boolean; includeDocumentIds?: number[]; includeNoteIds?: number[]; includeProductIds?: number[]; locationId?: null | number; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name?: string; projectId?: number; status?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; actualEnd?: string; actualHours?: null | number; actualStart?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billProjectAfterClosedFlag?: null | boolean; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billUnapprovedTimeAndExpense?: null | boolean; billingAmount?: null | number; billingAttention?: string; billingMethod: null | "FixedFee" | "NotToExceed" | "OverrideRate" | "ActualRates"; billingRateType?: null | "WorkRole" | "StaffMember"; billingStartDate?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; board?: { _info?: {}; id?: null | number; name?: string }; budgetAnalysis?: null | "ActualHours" | "BillableHours"; budgetFlag?: null | boolean; budgetHours?: null | number; closedFlag?: boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; doNotDisplayInPortalFlag?: null | boolean; downpayment?: null | number; estimatedEnd: string; estimatedExpenseCost?: null | number; estimatedExpenseRevenue?: null | number; estimatedHours?: null | number; estimatedProductCost?: null | number; estimatedProductRevenue?: null | number; estimatedStart: string; estimatedTimeCost?: null | number; estimatedTimeRevenue?: null | number; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; includeDependenciesFlag?: null | boolean; includeEstimatesFlag?: null | boolean; location?: { _info?: {}; id?: null | number; name?: string }; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentComplete?: null | number; projectTemplateId?: null | number; restrictDownPaymentFlag?: null | boolean; scheduledEnd?: string; scheduledHours?: null | number; scheduledStart?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:470
Parameters
- id: number
- conversion: { board?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; estimatedEnd?: string; estimatedStart?: string; includeAllDocumentsFlag?: null | boolean; includeAllNotesFlag?: null | boolean; includeAllProductsFlag?: null | boolean; includeDocumentIds?: number[]; includeNoteIds?: number[]; includeProductIds?: number[]; locationId?: null | number; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name?: string; projectId?: number; status?: { _info?: {}; id?: null | number; 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 businessUnitId?: null | number
    
    Format: int32
  - Optional estimatedEnd?: string
  - Optional estimatedStart?: string
  - Optional includeAllDocumentsFlag?: null | boolean
  - Optional includeAllNotesFlag?: null | boolean
  - Optional includeAllProductsFlag?: null | boolean
  - Optional includeDocumentIds?: number[]
  - Optional includeNoteIds?: number[]
  - Optional includeProductIds?: number[]
  - Optional locationId?: null | number
    
    Format: int32
  - 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
  - Optional name?: string
  - Optional projectId?: number
    
    Format: int32
  - Optional status?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
Returns Promise<{ _info?: {}; actualEnd?: string; actualHours?: null | number; actualStart?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billProjectAfterClosedFlag?: null | boolean; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billUnapprovedTimeAndExpense?: null | boolean; billingAmount?: null | number; billingAttention?: string; billingMethod: null | "FixedFee" | "NotToExceed" | "OverrideRate" | "ActualRates"; billingRateType?: null | "WorkRole" | "StaffMember"; billingStartDate?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; board?: { _info?: {}; id?: null | number; name?: string }; budgetAnalysis?: null | "ActualHours" | "BillableHours"; budgetFlag?: null | boolean; budgetHours?: null | number; closedFlag?: boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; doNotDisplayInPortalFlag?: null | boolean; downpayment?: null | number; estimatedEnd: string; estimatedExpenseCost?: null | number; estimatedExpenseRevenue?: null | number; estimatedHours?: null | number; estimatedProductCost?: null | number; estimatedProductRevenue?: null | number; estimatedStart: string; estimatedTimeCost?: null | number; estimatedTimeRevenue?: null | number; expenseApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; includeDependenciesFlag?: null | boolean; includeEstimatesFlag?: null | boolean; location?: { _info?: {}; id?: null | number; name?: string }; manager?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; name: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentComplete?: null | number; projectTemplateId?: null | number; restrictDownPaymentFlag?: null | boolean; scheduledEnd?: string; scheduledHours?: null | number; scheduledStart?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeApprover?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

postSalesOpportunitiesByIdConvertToSalesOrder

postSalesOpportunitiesByIdConvertToSalesOrder(id: number, conversion: { includeAllDocumentsFlag?: null | boolean; includeAllNotesFlag?: null | boolean; includeAllProductsFlag?: null | boolean; includeDocumentIds?: number[]; includeNoteIds?: number[]; includeProductIds?: number[]; name?: string; salesOrderId?: number }): Promise<{ _info?: {}; billClosedFlag?: null | boolean; billShippedFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; configIds?: number[]; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; documentIds?: number[]; dueDate?: string; email?: string; id?: number; invoiceIds?: number[]; location?: { _info?: {}; id?: null | number; name?: string }; notes?: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; orderDate?: string; phone?: string; phoneExt?: string; poNumber?: string; productIds?: number[]; restrictDownpaymentFlag?: null | boolean; salesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; subTotal?: number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxTotal?: null | number; topCommentFlag?: null | boolean; total?: null | number }>

- Defined in src/Manage/SalesAPI.ts:481
Parameters
- id: number
- conversion: { includeAllDocumentsFlag?: null | boolean; includeAllNotesFlag?: null | boolean; includeAllProductsFlag?: null | boolean; includeDocumentIds?: number[]; includeNoteIds?: number[]; includeProductIds?: number[]; name?: string; salesOrderId?: number }
  - Optional includeAllDocumentsFlag?: null | boolean
  - Optional includeAllNotesFlag?: null | boolean
  - Optional includeAllProductsFlag?: null | boolean
  - Optional includeDocumentIds?: number[]
  - Optional includeNoteIds?: number[]
  - Optional includeProductIds?: number[]
  - Optional name?: string
  - Optional salesOrderId?: number
    
    Format: int32
Returns Promise<{ _info?: {}; billClosedFlag?: null | boolean; billShippedFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; configIds?: number[]; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; documentIds?: number[]; dueDate?: string; email?: string; id?: number; invoiceIds?: number[]; location?: { _info?: {}; id?: null | number; name?: string }; notes?: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; orderDate?: string; phone?: string; phoneExt?: string; poNumber?: string; productIds?: number[]; restrictDownpaymentFlag?: null | boolean; salesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; subTotal?: number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxTotal?: null | number; topCommentFlag?: null | boolean; total?: null | number }>

postSalesOpportunitiesByIdConvertToServiceTicket

postSalesOpportunitiesByIdConvertToServiceTicket(id: number, conversion: { includeAllDocumentsFlag?: null | boolean; includeAllNotesFlag?: null | boolean; includeAllProductsFlag?: null | boolean; includeDocumentIds?: number[]; includeNoteIds?: number[]; includeProductIds?: number[]; summary?: string; ticketId?: number }): Promise<{ _info?: {}; actualHours?: null | number; addressLine1?: string; addressLine2?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; allowAllClientsPortalView?: null | boolean; approved?: null | boolean; automaticEmailCc?: string; automaticEmailCcFlag?: null | boolean; automaticEmailContactFlag?: null | boolean; automaticEmailResourceFlag?: null | boolean; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billingAmount?: null | number; billingMethod?: null | "FixedFee" | "NotToExceed" | "OverrideRate" | "ActualRates"; board?: { _info?: {}; id?: null | number; name?: string }; budgetHours?: null | number; city?: string; closedBy?: string; closedDate?: string; closedFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; contactEmailAddress?: string; contactEmailLookup?: string; contactName?: string; contactPhoneExtension?: string; contactPhoneNumber?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerUpdatedFlag?: null | boolean; dateResolved?: string; dateResplan?: string; dateResponded?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; duration?: null | number; estimatedExpenseCost?: null | number; estimatedExpenseRevenue?: null | number; estimatedProductCost?: null | number; estimatedProductRevenue?: null | number; estimatedStartDate?: string; estimatedTimeCost?: null | number; estimatedTimeRevenue?: null | number; externalXRef?: string; hasChildTicket?: null | boolean; hasMergedChildTicketFlag?: null | boolean; hourlyRate?: null | number; id?: number; impact?: null | "Low" | "Medium" | "High"; initialDescription?: string; initialDescriptionFrom?: string; initialInternalAnalysis?: string; initialResolution?: string; integratorTags?: string[]; isInSla?: null | boolean; item?: { _info?: {}; id?: null | number; name?: string }; knowledgeBaseCategoryId?: null | number; knowledgeBaseLinkId?: null | number; knowledgeBaseLinkType?: null | "ServiceTicket" | "ProjectTicket" | "Activity" | "ProjectIssue" | "KnowledgeBaseArticle" | "Time"; knowledgeBaseSubCategoryId?: null | number; lagDays?: null | number; lagNonworkingDaysFlag?: null | boolean; location?: { _info?: {}; id?: null | number; name?: string }; mergedParentTicket?: { _info?: {}; id?: null | number; summary?: string }; mobileGuid?: null | string; opportunity?: { _info?: {}; id?: null | number; name?: string }; owner?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; parentTicketId?: null | number; poNumber?: string; predecessorClosedFlag?: null | boolean; predecessorId?: null | number; predecessorType?: null | "Ticket" | "Phase"; priority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; processNotifications?: null | boolean; recordType?: null | "ServiceTicket" | "ProjectTicket" | "ProjectIssue"; requiredDate?: string; resPlanMinutes?: null | number; resolveMinutes?: null | number; resources?: string; respondMinutes?: null | number; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; severity?: null | "Low" | "Medium" | "High"; site?: { _info?: {}; id?: null | number; name?: string }; siteName?: string; skipCallback?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; slaStatus?: string; source?: { _info?: {}; id?: null | number; name?: string }; stateIdentifier?: string; status?: { _info?: {}; id?: null | number; name?: string }; subBillingAmount?: null | number; subBillingMethod?: null | "FixedFee" | "NotToExceed" | "OverrideRate" | "ActualRates"; subDateAccepted?: string; subType?: { _info?: {}; id?: null | number; name?: string }; summary: string; team?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string }; zip?: string }>

- Defined in src/Manage/SalesAPI.ts:492
Parameters
- id: number
- conversion: { includeAllDocumentsFlag?: null | boolean; includeAllNotesFlag?: null | boolean; includeAllProductsFlag?: null | boolean; includeDocumentIds?: number[]; includeNoteIds?: number[]; includeProductIds?: number[]; summary?: string; ticketId?: number }
  - Optional includeAllDocumentsFlag?: null | boolean
  - Optional includeAllNotesFlag?: null | boolean
  - Optional includeAllProductsFlag?: null | boolean
  - Optional includeDocumentIds?: number[]
  - Optional includeNoteIds?: number[]
  - Optional includeProductIds?: number[]
  - Optional summary?: string
  - Optional ticketId?: number
    
    Format: int32
Returns Promise<{ _info?: {}; actualHours?: null | number; addressLine1?: string; addressLine2?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; allowAllClientsPortalView?: null | boolean; approved?: null | boolean; automaticEmailCc?: string; automaticEmailCcFlag?: null | boolean; automaticEmailContactFlag?: null | boolean; automaticEmailResourceFlag?: null | boolean; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billingAmount?: null | number; billingMethod?: null | "FixedFee" | "NotToExceed" | "OverrideRate" | "ActualRates"; board?: { _info?: {}; id?: null | number; name?: string }; budgetHours?: null | number; city?: string; closedBy?: string; closedDate?: string; closedFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; contactEmailAddress?: string; contactEmailLookup?: string; contactName?: string; contactPhoneExtension?: string; contactPhoneNumber?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerUpdatedFlag?: null | boolean; dateResolved?: string; dateResplan?: string; dateResponded?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; duration?: null | number; estimatedExpenseCost?: null | number; estimatedExpenseRevenue?: null | number; estimatedProductCost?: null | number; estimatedProductRevenue?: null | number; estimatedStartDate?: string; estimatedTimeCost?: null | number; estimatedTimeRevenue?: null | number; externalXRef?: string; hasChildTicket?: null | boolean; hasMergedChildTicketFlag?: null | boolean; hourlyRate?: null | number; id?: number; impact?: null | "Low" | "Medium" | "High"; initialDescription?: string; initialDescriptionFrom?: string; initialInternalAnalysis?: string; initialResolution?: string; integratorTags?: string[]; isInSla?: null | boolean; item?: { _info?: {}; id?: null | number; name?: string }; knowledgeBaseCategoryId?: null | number; knowledgeBaseLinkId?: null | number; knowledgeBaseLinkType?: null | "ServiceTicket" | "ProjectTicket" | "Activity" | "ProjectIssue" | "KnowledgeBaseArticle" | "Time"; knowledgeBaseSubCategoryId?: null | number; lagDays?: null | number; lagNonworkingDaysFlag?: null | boolean; location?: { _info?: {}; id?: null | number; name?: string }; mergedParentTicket?: { _info?: {}; id?: null | number; summary?: string }; mobileGuid?: null | string; opportunity?: { _info?: {}; id?: null | number; name?: string }; owner?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; parentTicketId?: null | number; poNumber?: string; predecessorClosedFlag?: null | boolean; predecessorId?: null | number; predecessorType?: null | "Ticket" | "Phase"; priority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; processNotifications?: null | boolean; recordType?: null | "ServiceTicket" | "ProjectTicket" | "ProjectIssue"; requiredDate?: string; resPlanMinutes?: null | number; resolveMinutes?: null | number; resources?: string; respondMinutes?: null | number; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; severity?: null | "Low" | "Medium" | "High"; site?: { _info?: {}; id?: null | number; name?: string }; siteName?: string; skipCallback?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; slaStatus?: string; source?: { _info?: {}; id?: null | number; name?: string }; stateIdentifier?: string; status?: { _info?: {}; id?: null | number; name?: string }; subBillingAmount?: null | number; subBillingMethod?: null | "FixedFee" | "NotToExceed" | "OverrideRate" | "ActualRates"; subDateAccepted?: string; subType?: { _info?: {}; id?: null | number; name?: string }; summary: string; team?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string }; zip?: string }>

postSalesOpportunitiesByParentIdContacts

postSalesOpportunitiesByParentIdContacts(parentId: number, opportunityContact: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; id?: number; notes?: string; opportunityId?: null | number; phoneNumber?: string; referralFlag?: null | boolean; role?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; id?: number; notes?: string; opportunityId?: null | number; phoneNumber?: string; referralFlag?: null | boolean; role?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:514
Parameters
- parentId: number
- opportunityContact: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; id?: number; notes?: string; opportunityId?: null | number; phoneNumber?: string; referralFlag?: null | boolean; role?: { _info?: {}; id?: null | number; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - Optional contact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional emailAddress?: string
  - Optional id?: number
    
    Format: int32
  - Optional notes?: string
  - Optional opportunityId?: null | number
    
    Format: int32
  - Optional phoneNumber?: string
  - Optional referralFlag?: null | boolean
  - Optional role?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; id?: number; notes?: string; opportunityId?: null | number; phoneNumber?: string; referralFlag?: null | boolean; role?: { _info?: {}; id?: null | number; name?: string } }>

postSalesOpportunitiesByParentIdForecast

postSalesOpportunitiesByParentIdForecast(parentId: number, forecast: { _info?: {}; agreementRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; expectedProbability?: number; expenseRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastItems?: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }[]; forecastRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastTotalWithTaxes?: null | number; id?: number; inclusiveRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; lostRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; openRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue1?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue2?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; productRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; recurringTotal?: null | number; salesTaxRevenue?: null | number; serviceRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; wonRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number } }): Promise<{ _info?: {}; agreementRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; expectedProbability?: number; expenseRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastItems?: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }[]; forecastRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastTotalWithTaxes?: null | number; id?: number; inclusiveRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; lostRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; openRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue1?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue2?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; productRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; recurringTotal?: null | number; salesTaxRevenue?: null | number; serviceRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; wonRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number } }>

- Defined in src/Manage/SalesAPI.ts:593
Parameters
- parentId: number
- forecast: { _info?: {}; agreementRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; expectedProbability?: number; expenseRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastItems?: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }[]; forecastRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastTotalWithTaxes?: null | number; id?: number; inclusiveRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; lostRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; openRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue1?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue2?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; productRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; recurringTotal?: null | number; salesTaxRevenue?: null | number; serviceRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; wonRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional agreementRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional billingTerms?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional currencyCode?: string
    - Optional currencyIdentifier?: string
    - Optional decimalSeparator?: string
    - Optional displayIdFlag?: boolean
    - Optional displaySymbolFlag?: boolean
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
    - Optional negativeParenthesesFlag?: boolean
    - Optional numberOfDecimals?: number
      
      Format: int32
    - Optional rightAlign?: boolean
    - Optional symbol?: string
    - Optional thousandsSeparator?: string
  - Optional expectedProbability?: number
    
    Format: int32
  - Optional expenseRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional forecastItems?: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }[]
  - Optional forecastRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional forecastTotalWithTaxes?: null | number
    
    Format: double
  - Optional id?: number
    
    Format: int32
  - Optional inclusiveRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional lostRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional openRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional otherRevenue1?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional otherRevenue2?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional productRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional recurringTotal?: null | number
    
    Format: double
  - Optional salesTaxRevenue?: null | number
    
    Format: double
  - Optional serviceRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional taxCode?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional timeRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional wonRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
Returns Promise<{ _info?: {}; agreementRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; expectedProbability?: number; expenseRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastItems?: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }[]; forecastRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastTotalWithTaxes?: null | number; id?: number; inclusiveRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; lostRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; openRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue1?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue2?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; productRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; recurringTotal?: null | number; salesTaxRevenue?: null | number; serviceRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; wonRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number } }>

postSalesOpportunitiesByParentIdForecastById

postSalesOpportunitiesByParentIdForecastById(id: number, parentId: number, forecast: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }): Promise<{ _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }>

- Defined in src/Manage/SalesAPI.ts:642
Parameters
- id: number
- parentId: number
- forecast: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }
  - Optional _info?: {}
    - [key: string]: string
  - Optional billCycle?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional serializedFlag?: null | boolean
  - Optional cost?: null | number
    
    Format: double
  - Optional cycleBasis?: string
  - Optional cycles?: number
    
    Format: int32
  - Optional forecastDescription?: string
    description
    Max length: 50;
  - forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"
  - Optional id?: number
    
    Format: int32
  - Optional includeFlag?: boolean
  - Optional linkFlag?: boolean
  - Optional margin?: number
    
    Format: double
  - Optional opportunity?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional percentage?: number
    
    Format: int32
  - Optional productClass?: string
  - Optional productDescription?: string
  - Optional quantity?: number
    
    Format: double
  - Optional quoteWerksDocName?: string
    description
    Max length: 255;
  - Optional quoteWerksDocNo?: string
    description
    Max length: 20;
  - Optional quoteWerksQuantity?: number
    
    Format: int32
  - Optional recurringCost?: null | number
    
    Format: double
  - Optional recurringDateEnd?: string
    
    Format: date-time
  - Optional recurringDateStart?: string
    
    Format: date-time
  - Optional recurringFlag?: boolean
  - Optional recurringRevenue?: number
    
    Format: double
  - Optional revenue?: number
    
    Format: double
  - Optional sequenceNumber?: number
    
    Format: double
  - Optional status?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional subNumber?: number
    
    Format: int32
  - Optional taxableFlag?: boolean
Returns Promise<{ _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }>

postSalesOpportunitiesByParentIdForecastCopyById

postSalesOpportunitiesByParentIdForecastCopyById(id: number, parentId: number): Promise<{ message?: string; success?: boolean }>

- Defined in src/Manage/SalesAPI.ts:688
Parameters
- id: number
- parentId: number
Returns Promise<{ message?: string; success?: boolean }>

postSalesOpportunitiesByParentIdNotes

postSalesOpportunitiesByParentIdNotes(parentId: number, note: { _info?: {}; enteredBy?: string; flagged?: null | boolean; id?: number; mobileGuid?: null | string; opportunityId?: null | number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; enteredBy?: string; flagged?: null | boolean; id?: number; mobileGuid?: null | string; opportunityId?: null | number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:720
Parameters
- parentId: number
- note: { _info?: {}; enteredBy?: string; flagged?: null | boolean; id?: number; mobileGuid?: null | string; opportunityId?: null | number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional enteredBy?: string
  - Optional flagged?: null | boolean
  - Optional id?: number
    
    Format: int32
  - Optional mobileGuid?: null | string
    
    Format: uuid
  - Optional opportunityId?: null | number
    
    Format: int32
  - text: string
  - Optional type?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
Returns Promise<{ _info?: {}; enteredBy?: string; flagged?: null | boolean; id?: number; mobileGuid?: null | string; opportunityId?: null | number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

postSalesOpportunitiesByParentIdTeam

postSalesOpportunitiesByParentIdTeam(parentId: number, team: { _info?: {}; commissionPercent?: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; opportunityId?: null | number; referralFlag?: null | boolean; responsibleFlag?: null | boolean; salesTeam?: { _info?: {}; id?: null | number; identifier?: string }; type: null | "Team" | "Individual" }): Promise<{ _info?: {}; commissionPercent?: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; opportunityId?: null | number; referralFlag?: null | boolean; responsibleFlag?: null | boolean; salesTeam?: { _info?: {}; id?: null | number; identifier?: string }; type: null | "Team" | "Individual" }>

- Defined in src/Manage/SalesAPI.ts:799
Parameters
- parentId: number
- team: { _info?: {}; commissionPercent?: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; opportunityId?: null | number; referralFlag?: null | boolean; responsibleFlag?: null | boolean; salesTeam?: { _info?: {}; id?: null | number; identifier?: string }; type: null | "Team" | "Individual" }
  - Optional _info?: {}
    - [key: string]: string
  - Optional commissionPercent?: null | number
    
    Format: int32
  - 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 opportunityId?: null | number
    
    Format: int32
  - Optional referralFlag?: null | boolean
  - Optional responsibleFlag?: null | boolean
  - Optional salesTeam?: { _info?: {}; id?: null | number; identifier?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
  - type: null | "Team" | "Individual"
Returns Promise<{ _info?: {}; commissionPercent?: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; opportunityId?: null | number; referralFlag?: null | boolean; responsibleFlag?: null | boolean; salesTeam?: { _info?: {}; id?: null | number; identifier?: string }; type: null | "Team" | "Individual" }>

postSalesOpportunitiesRatings

postSalesOpportunitiesRatings(opportunityRating: { _info?: {}; id?: number; name: string; sortOrder?: null | number }): Promise<{ _info?: {}; id?: number; name: string; sortOrder?: null | number }>

- Defined in src/Manage/SalesAPI.ts:884
Parameters
- opportunityRating: { _info?: {}; id?: number; name: string; sortOrder?: null | number }
  - Optional _info?: {}
    - [key: string]: string
  - Optional id?: number
    
    Format: int32
  - name: string
    description
    Max length: 50;
  - Optional sortOrder?: null | number
    
    Format: int32
Returns Promise<{ _info?: {}; id?: number; name: string; sortOrder?: null | number }>

postSalesOpportunitiesStatuses

postSalesOpportunitiesStatuses(status: { _info?: {}; closedFlag?: null | boolean; dateEntered?: string; defaultFlag?: null | boolean; enteredBy?: string; id?: number; inactiveFlag?: null | boolean; lostFlag?: null | boolean; name: string; wonFlag?: null | boolean }): Promise<{ _info?: {}; closedFlag?: null | boolean; dateEntered?: string; defaultFlag?: null | boolean; enteredBy?: string; id?: number; inactiveFlag?: null | boolean; lostFlag?: null | boolean; name: string; wonFlag?: null | boolean }>

- Defined in src/Manage/SalesAPI.ts:977
Parameters
- status: { _info?: {}; closedFlag?: null | boolean; dateEntered?: string; defaultFlag?: null | boolean; enteredBy?: string; id?: number; inactiveFlag?: null | boolean; lostFlag?: null | boolean; name: string; wonFlag?: null | boolean }
  - Optional _info?: {}
    - [key: string]: string
  - Optional closedFlag?: null | boolean
  - Optional dateEntered?: string
    
    Format: date-time
  - Optional defaultFlag?: null | boolean
  - Optional enteredBy?: string
  - Optional id?: number
    
    Format: int32
  - Optional inactiveFlag?: null | boolean
  - Optional lostFlag?: null | boolean
  - name: string
    description
    Max length: 30;
  - Optional wonFlag?: null | boolean
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; dateEntered?: string; defaultFlag?: null | boolean; enteredBy?: string; id?: number; inactiveFlag?: null | boolean; lostFlag?: null | boolean; name: string; wonFlag?: null | boolean }>

postSalesOpportunitiesTypes

postSalesOpportunitiesTypes(opportunityType: { _info?: {}; description: string; id?: number; inactiveFlag?: null | boolean }): Promise<{ _info?: {}; description: string; id?: number; inactiveFlag?: null | boolean }>

- Defined in src/Manage/SalesAPI.ts:1092
Parameters
- opportunityType: { _info?: {}; description: string; id?: number; inactiveFlag?: null | boolean }
  - Optional _info?: {}
    - [key: string]: string
  - description: string
    description
    Max length: 50;
  - Optional id?: number
    
    Format: int32
  - Optional inactiveFlag?: null | boolean
Returns Promise<{ _info?: {}; description: string; id?: number; inactiveFlag?: null | boolean }>

postSalesOrders

postSalesOrders(order: { _info?: {}; billClosedFlag?: null | boolean; billShippedFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; configIds?: number[]; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; documentIds?: number[]; dueDate?: string; email?: string; id?: number; invoiceIds?: number[]; location?: { _info?: {}; id?: null | number; name?: string }; notes?: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; orderDate?: string; phone?: string; phoneExt?: string; poNumber?: string; productIds?: number[]; restrictDownpaymentFlag?: null | boolean; salesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; subTotal?: number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxTotal?: null | number; topCommentFlag?: null | boolean; total?: null | number }): Promise<{ _info?: {}; billClosedFlag?: null | boolean; billShippedFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; configIds?: number[]; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; documentIds?: number[]; dueDate?: string; email?: string; id?: number; invoiceIds?: number[]; location?: { _info?: {}; id?: null | number; name?: string }; notes?: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; orderDate?: string; phone?: string; phoneExt?: string; poNumber?: string; productIds?: number[]; restrictDownpaymentFlag?: null | boolean; salesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; subTotal?: number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxTotal?: null | number; topCommentFlag?: null | boolean; total?: null | number }>

- Defined in src/Manage/SalesAPI.ts:1207
Parameters
- order: { _info?: {}; billClosedFlag?: null | boolean; billShippedFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; configIds?: number[]; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; documentIds?: number[]; dueDate?: string; email?: string; id?: number; invoiceIds?: number[]; location?: { _info?: {}; id?: null | number; name?: string }; notes?: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; orderDate?: string; phone?: string; phoneExt?: string; poNumber?: string; productIds?: number[]; restrictDownpaymentFlag?: null | boolean; salesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; subTotal?: number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxTotal?: null | number; topCommentFlag?: null | boolean; total?: null | number }
  - Optional _info?: {}
    - [key: string]: string
  - Optional billClosedFlag?: null | boolean
  - Optional billShippedFlag?: null | boolean
  - Optional billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - Optional billToContact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional billToSite?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional billingTerms?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional bottomCommentFlag?: null | boolean
  - Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - Optional companyLocation?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional configIds?: number[]
  - Optional contact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional currencyCode?: string
    - Optional currencyIdentifier?: string
    - Optional decimalSeparator?: string
    - Optional displayIdFlag?: boolean
    - Optional displaySymbolFlag?: boolean
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
    - Optional negativeParenthesesFlag?: boolean
    - Optional numberOfDecimals?: number
      
      Format: int32
    - Optional rightAlign?: boolean
    - Optional symbol?: string
    - Optional thousandsSeparator?: string
  - Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
  - Optional 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 description?: string
  - Optional documentIds?: number[]
  - Optional dueDate?: string
    
    Format: date-time
  - Optional email?: string
  - Optional id?: number
    
    Format: int32
  - Optional invoiceIds?: number[]
  - Optional location?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional notes?: string
  - Optional opportunity?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional orderDate?: string
    
    Format: date-time
  - Optional phone?: string
  - Optional phoneExt?: string
  - Optional poNumber?: string
    description
    Max length: 50;
  - Optional productIds?: number[]
  - Optional restrictDownpaymentFlag?: null | boolean
  - Optional salesRep?: { _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 shipToCompany?: { _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 shipToContact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional shipToSite?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional site?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional status?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional subTotal?: number
    
    Format: double
  - Optional taxCode?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional taxTotal?: null | number
    
    Format: double
  - Optional topCommentFlag?: null | boolean
  - Optional total?: null | number
    
    Format: double
Returns Promise<{ _info?: {}; billClosedFlag?: null | boolean; billShippedFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; configIds?: number[]; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; documentIds?: number[]; dueDate?: string; email?: string; id?: number; invoiceIds?: number[]; location?: { _info?: {}; id?: null | number; name?: string }; notes?: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; orderDate?: string; phone?: string; phoneExt?: string; poNumber?: string; productIds?: number[]; restrictDownpaymentFlag?: null | boolean; salesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; subTotal?: number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxTotal?: null | number; topCommentFlag?: null | boolean; total?: null | number }>

postSalesOrdersByIdConvertToServiceTicket

postSalesOrdersByIdConvertToServiceTicket(id: number): Promise<{ _info?: {}; actualHours?: null | number; addressLine1?: string; addressLine2?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; allowAllClientsPortalView?: null | boolean; approved?: null | boolean; automaticEmailCc?: string; automaticEmailCcFlag?: null | boolean; automaticEmailContactFlag?: null | boolean; automaticEmailResourceFlag?: null | boolean; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billingAmount?: null | number; billingMethod?: null | "FixedFee" | "NotToExceed" | "OverrideRate" | "ActualRates"; board?: { _info?: {}; id?: null | number; name?: string }; budgetHours?: null | number; city?: string; closedBy?: string; closedDate?: string; closedFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; contactEmailAddress?: string; contactEmailLookup?: string; contactName?: string; contactPhoneExtension?: string; contactPhoneNumber?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerUpdatedFlag?: null | boolean; dateResolved?: string; dateResplan?: string; dateResponded?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; duration?: null | number; estimatedExpenseCost?: null | number; estimatedExpenseRevenue?: null | number; estimatedProductCost?: null | number; estimatedProductRevenue?: null | number; estimatedStartDate?: string; estimatedTimeCost?: null | number; estimatedTimeRevenue?: null | number; externalXRef?: string; hasChildTicket?: null | boolean; hasMergedChildTicketFlag?: null | boolean; hourlyRate?: null | number; id?: number; impact?: null | "Low" | "Medium" | "High"; initialDescription?: string; initialDescriptionFrom?: string; initialInternalAnalysis?: string; initialResolution?: string; integratorTags?: string[]; isInSla?: null | boolean; item?: { _info?: {}; id?: null | number; name?: string }; knowledgeBaseCategoryId?: null | number; knowledgeBaseLinkId?: null | number; knowledgeBaseLinkType?: null | "ServiceTicket" | "ProjectTicket" | "Activity" | "ProjectIssue" | "KnowledgeBaseArticle" | "Time"; knowledgeBaseSubCategoryId?: null | number; lagDays?: null | number; lagNonworkingDaysFlag?: null | boolean; location?: { _info?: {}; id?: null | number; name?: string }; mergedParentTicket?: { _info?: {}; id?: null | number; summary?: string }; mobileGuid?: null | string; opportunity?: { _info?: {}; id?: null | number; name?: string }; owner?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; parentTicketId?: null | number; poNumber?: string; predecessorClosedFlag?: null | boolean; predecessorId?: null | number; predecessorType?: null | "Ticket" | "Phase"; priority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; processNotifications?: null | boolean; recordType?: null | "ServiceTicket" | "ProjectTicket" | "ProjectIssue"; requiredDate?: string; resPlanMinutes?: null | number; resolveMinutes?: null | number; resources?: string; respondMinutes?: null | number; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; severity?: null | "Low" | "Medium" | "High"; site?: { _info?: {}; id?: null | number; name?: string }; siteName?: string; skipCallback?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; slaStatus?: string; source?: { _info?: {}; id?: null | number; name?: string }; stateIdentifier?: string; status?: { _info?: {}; id?: null | number; name?: string }; subBillingAmount?: null | number; subBillingMethod?: null | "FixedFee" | "NotToExceed" | "OverrideRate" | "ActualRates"; subDateAccepted?: string; subType?: { _info?: {}; id?: null | number; name?: string }; summary: string; team?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string }; zip?: string }>

- Defined in src/Manage/SalesAPI.ts:1246
Parameters
- id: number
Returns Promise<{ _info?: {}; actualHours?: null | number; addressLine1?: string; addressLine2?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; allowAllClientsPortalView?: null | boolean; approved?: null | boolean; automaticEmailCc?: string; automaticEmailCcFlag?: null | boolean; automaticEmailContactFlag?: null | boolean; automaticEmailResourceFlag?: null | boolean; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billingAmount?: null | number; billingMethod?: null | "FixedFee" | "NotToExceed" | "OverrideRate" | "ActualRates"; board?: { _info?: {}; id?: null | number; name?: string }; budgetHours?: null | number; city?: string; closedBy?: string; closedDate?: string; closedFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; contactEmailAddress?: string; contactEmailLookup?: string; contactName?: string; contactPhoneExtension?: string; contactPhoneNumber?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerUpdatedFlag?: null | boolean; dateResolved?: string; dateResplan?: string; dateResponded?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; duration?: null | number; estimatedExpenseCost?: null | number; estimatedExpenseRevenue?: null | number; estimatedProductCost?: null | number; estimatedProductRevenue?: null | number; estimatedStartDate?: string; estimatedTimeCost?: null | number; estimatedTimeRevenue?: null | number; externalXRef?: string; hasChildTicket?: null | boolean; hasMergedChildTicketFlag?: null | boolean; hourlyRate?: null | number; id?: number; impact?: null | "Low" | "Medium" | "High"; initialDescription?: string; initialDescriptionFrom?: string; initialInternalAnalysis?: string; initialResolution?: string; integratorTags?: string[]; isInSla?: null | boolean; item?: { _info?: {}; id?: null | number; name?: string }; knowledgeBaseCategoryId?: null | number; knowledgeBaseLinkId?: null | number; knowledgeBaseLinkType?: null | "ServiceTicket" | "ProjectTicket" | "Activity" | "ProjectIssue" | "KnowledgeBaseArticle" | "Time"; knowledgeBaseSubCategoryId?: null | number; lagDays?: null | number; lagNonworkingDaysFlag?: null | boolean; location?: { _info?: {}; id?: null | number; name?: string }; mergedParentTicket?: { _info?: {}; id?: null | number; summary?: string }; mobileGuid?: null | string; opportunity?: { _info?: {}; id?: null | number; name?: string }; owner?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; parentTicketId?: null | number; poNumber?: string; predecessorClosedFlag?: null | boolean; predecessorId?: null | number; predecessorType?: null | "Ticket" | "Phase"; priority?: { _info?: {}; id?: null | number; name?: string; sort?: null | number }; processNotifications?: null | boolean; recordType?: null | "ServiceTicket" | "ProjectTicket" | "ProjectIssue"; requiredDate?: string; resPlanMinutes?: null | number; resolveMinutes?: null | number; resources?: string; respondMinutes?: null | number; serviceLocation?: { _info?: {}; id?: null | number; name?: string }; severity?: null | "Low" | "Medium" | "High"; site?: { _info?: {}; id?: null | number; name?: string }; siteName?: string; skipCallback?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; slaStatus?: string; source?: { _info?: {}; id?: null | number; name?: string }; stateIdentifier?: string; status?: { _info?: {}; id?: null | number; name?: string }; subBillingAmount?: null | number; subBillingMethod?: null | "FixedFee" | "NotToExceed" | "OverrideRate" | "ActualRates"; subDateAccepted?: string; subType?: { _info?: {}; id?: null | number; name?: string }; summary: string; team?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string }; zip?: string }>

postSalesOrdersStatuses

postSalesOrdersStatuses(status: { _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; name: string; sortOrder?: null | number }): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; name: string; sortOrder?: null | number }[]>

- Defined in src/Manage/SalesAPI.ts:1269
Parameters
- status: { _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; name: string; sortOrder?: null | number }
  - Optional _info?: {}
    - [key: string]: string
  - Optional closedFlag?: null | boolean
  - Optional defaultFlag?: null | boolean
  - Optional emailTemplate?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional id?: number
    
    Format: int32
  - Optional inactiveFlag?: null | boolean
  - name: string
    description
    Max length: 50;
  - Optional sortOrder?: null | number
    
    Format: int32
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; name: string; sortOrder?: null | number }[]>

postSalesOrdersStatusesByParentIdEmailtemplates

postSalesOrdersStatusesByParentIdEmailtemplates(parentId: number, orderStatusEmailTemplate: { _info?: {}; body: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; lastName?: string; status?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }): Promise<{ _info?: {}; body: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; lastName?: string; status?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }>

- Defined in src/Manage/SalesAPI.ts:1355
Parameters
- parentId: number
- orderStatusEmailTemplate: { _info?: {}; body: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; lastName?: string; status?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }
  - Optional _info?: {}
    - [key: string]: string
  - body: string
  - Optional copySenderFlag?: null | boolean
  - Optional emailAddress?: string
    description
    Max length: 100;
  - Optional firstName?: string
    description
    Max length: 100;
  - Optional id?: number
    
    Format: int32
  - Optional lastName?: string
    description
    Max length: 100;
  - Optional status?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - subject: string
    description
    Max length: 200;
  - Optional useSenderFlag?: null | boolean
Returns Promise<{ _info?: {}; body: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; lastName?: string; status?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }>

postSalesOrdersStatusesByParentIdNotifications

postSalesOrdersStatusesByParentIdNotifications(parentId: number, orderStatusNotification: { _info?: {}; email?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; workflowStep?: null | number }): Promise<{ _info?: {}; email?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; workflowStep?: null | number }>

- Defined in src/Manage/SalesAPI.ts:1434
Parameters
- parentId: number
- orderStatusNotification: { _info?: {}; email?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; workflowStep?: null | number }
  - Optional _info?: {}
    - [key: string]: string
  - Optional email?: string
    description
    Order Status Notification sendEmail must be entered if the notify type is "Email Address" Max length: 50;
  - Optional id?: number
    
    Format: int32
  - Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - Optional notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - Optional status?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional workflowStep?: null | number
    
    Format: int32
Returns Promise<{ _info?: {}; email?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; workflowStep?: null | number }>

postSalesProbabilities

postSalesProbabilities(probability: { _info?: {}; id?: number; probability: number }): Promise<{ _info?: {}; id?: number; probability: number }>

- Defined in src/Manage/SalesAPI.ts:1534
Parameters
- probability: { _info?: {}; id?: number; probability: number }
  - Optional _info?: {}
    - [key: string]: string
  - Optional id?: number
    
    Format: int32
  - probability: number
    
    Format: int32
Returns Promise<{ _info?: {}; id?: number; probability: number }>

postSalesQuotas

postSalesQuotas(salesQuota: { _info?: {}; aprilMargin?: null | number; aprilRevenue?: null | number; augustMargin?: null | number; augustRevenue?: null | number; category?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; decemberMargin?: null | number; decemberRevenue?: null | number; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; februaryMargin?: null | number; februaryRevenue?: null | number; forecastYear?: null | number; id?: number; januaryMargin?: null | number; januaryRevenue?: null | number; julyMargin?: null | number; julyRevenue?: null | number; juneMargin?: null | number; juneRevenue?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; marchMargin?: null | number; marchRevenue?: null | number; mayMargin?: null | number; mayRevenue?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; novemberMargin?: null | number; novemberRevenue?: null | number; octoberMargin?: null | number; octoberRevenue?: null | number; septemberMargin?: null | number; septemberRevenue?: null | number; subCategory?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; aprilMargin?: null | number; aprilRevenue?: null | number; augustMargin?: null | number; augustRevenue?: null | number; category?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; decemberMargin?: null | number; decemberRevenue?: null | number; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; februaryMargin?: null | number; februaryRevenue?: null | number; forecastYear?: null | number; id?: number; januaryMargin?: null | number; januaryRevenue?: null | number; julyMargin?: null | number; julyRevenue?: null | number; juneMargin?: null | number; juneRevenue?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; marchMargin?: null | number; marchRevenue?: null | number; mayMargin?: null | number; mayRevenue?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; novemberMargin?: null | number; novemberRevenue?: null | number; octoberMargin?: null | number; octoberRevenue?: null | number; septemberMargin?: null | number; septemberRevenue?: null | number; subCategory?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:1619
Parameters
- salesQuota: { _info?: {}; aprilMargin?: null | number; aprilRevenue?: null | number; augustMargin?: null | number; augustRevenue?: null | number; category?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; decemberMargin?: null | number; decemberRevenue?: null | number; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; februaryMargin?: null | number; februaryRevenue?: null | number; forecastYear?: null | number; id?: number; januaryMargin?: null | number; januaryRevenue?: null | number; julyMargin?: null | number; julyRevenue?: null | number; juneMargin?: null | number; juneRevenue?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; marchMargin?: null | number; marchRevenue?: null | number; mayMargin?: null | number; mayRevenue?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; novemberMargin?: null | number; novemberRevenue?: null | number; octoberMargin?: null | number; octoberRevenue?: null | number; septemberMargin?: null | number; septemberRevenue?: null | number; subCategory?: { _info?: {}; id?: null | number; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional aprilMargin?: null | number
    
    Format: double
  - Optional aprilRevenue?: null | number
    
    Format: double
  - Optional augustMargin?: null | number
    
    Format: double
  - Optional augustRevenue?: null | number
    
    Format: double
  - Optional category?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional currencyCode?: string
    - Optional currencyIdentifier?: string
    - Optional decimalSeparator?: string
    - Optional displayIdFlag?: boolean
    - Optional displaySymbolFlag?: boolean
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
    - Optional negativeParenthesesFlag?: boolean
    - Optional numberOfDecimals?: number
      
      Format: int32
    - Optional rightAlign?: boolean
    - Optional symbol?: string
    - Optional thousandsSeparator?: string
  - Optional decemberMargin?: null | number
    
    Format: double
  - Optional decemberRevenue?: null | number
    
    Format: double
  - 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 februaryMargin?: null | number
    
    Format: double
  - Optional februaryRevenue?: null | number
    
    Format: double
  - Optional forecastYear?: null | number
    
    Format: int32
  - Optional id?: number
    
    Format: int32
  - Optional januaryMargin?: null | number
    
    Format: double
  - Optional januaryRevenue?: null | number
    
    Format: double
  - Optional julyMargin?: null | number
    
    Format: double
  - Optional julyRevenue?: null | number
    
    Format: double
  - Optional juneMargin?: null | number
    
    Format: double
  - Optional juneRevenue?: null | number
    
    Format: double
  - Optional location?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional marchMargin?: null | number
    
    Format: double
  - Optional marchRevenue?: null | number
    
    Format: double
  - Optional mayMargin?: null | number
    
    Format: double
  - Optional mayRevenue?: null | number
    
    Format: double
  - 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 novemberMargin?: null | number
    
    Format: double
  - Optional novemberRevenue?: null | number
    
    Format: double
  - Optional octoberMargin?: null | number
    
    Format: double
  - Optional octoberRevenue?: null | number
    
    Format: double
  - Optional septemberMargin?: null | number
    
    Format: double
  - Optional septemberRevenue?: null | number
    
    Format: double
  - Optional subCategory?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
Returns Promise<{ _info?: {}; aprilMargin?: null | number; aprilRevenue?: null | number; augustMargin?: null | number; augustRevenue?: null | number; category?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; decemberMargin?: null | number; decemberRevenue?: null | number; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; februaryMargin?: null | number; februaryRevenue?: null | number; forecastYear?: null | number; id?: number; januaryMargin?: null | number; januaryRevenue?: null | number; julyMargin?: null | number; julyRevenue?: null | number; juneMargin?: null | number; juneRevenue?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; marchMargin?: null | number; marchRevenue?: null | number; mayMargin?: null | number; mayRevenue?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; novemberMargin?: null | number; novemberRevenue?: null | number; octoberMargin?: null | number; octoberRevenue?: null | number; septemberMargin?: null | number; septemberRevenue?: null | number; subCategory?: { _info?: {}; id?: null | number; name?: string } }>

postSalesRoles

postSalesRoles(role: { _info?: {}; id?: number; name: string }): Promise<{ _info?: {}; id?: number; name: string }>

- Defined in src/Manage/SalesAPI.ts:1674
Parameters
- role: { _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 }>

postSalesSalesTeams

postSalesSalesTeams(salesTeam: { _info?: {}; id?: number; inactiveFlag?: null | boolean; salesTeamDescription: string; salesTeamIdentifier: string; salesTeamLocation?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; salesTeamDescription: string; salesTeamIdentifier: string; salesTeamLocation?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:1729
Parameters
- salesTeam: { _info?: {}; id?: number; inactiveFlag?: null | boolean; salesTeamDescription: string; salesTeamIdentifier: string; salesTeamLocation?: { _info?: {}; id?: null | number; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional id?: number
    
    Format: int32
  - Optional inactiveFlag?: null | boolean
  - salesTeamDescription: string
    description
    Max length: 50;
  - salesTeamIdentifier: string
    description
    Max length: 20;
  - Optional salesTeamLocation?: { _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; inactiveFlag?: null | boolean; salesTeamDescription: string; salesTeamIdentifier: string; salesTeamLocation?: { _info?: {}; id?: null | number; name?: string } }>

postSalesSalesTeamsByParentIdMembers

postSalesSalesTeamsByParentIdMembers(parentId: number, salesTeamMember: { _info?: {}; allowAccessFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; allowAccessFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:1779
Parameters
- parentId: number
- salesTeamMember: { _info?: {}; allowAccessFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional allowAccessFlag?: 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 id?: number
    
    Format: int32
  - Optional location?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
Returns Promise<{ _info?: {}; allowAccessFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

postSalesStages

postSalesStages(stage: { _info?: {}; color?: string; id?: number; name: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }): Promise<{ _info?: {}; color?: string; id?: number; name: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }>

- Defined in src/Manage/SalesAPI.ts:1879
Parameters
- stage: { _info?: {}; color?: string; id?: number; name: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }
  - Optional _info?: {}
    - [key: string]: string
  - Optional color?: string
    description
    Max length: 25;
  - Optional id?: number
    
    Format: int32
  - name: string
    description
    Max length: 50;
  - Optional probability?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional sequenceNumber?: null | number
    
    Format: int32
Returns Promise<{ _info?: {}; color?: string; id?: number; name: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }>

putSalesActivitiesById

putSalesActivitiesById(id: number, activity: { _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; assignTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; assignedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; campaign?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateEnd?: string; dateStart?: string; email?: string; id?: number; mobileGuid?: null | string; name: string; notes?: string; notifyFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; phoneNumber?: string; reminder?: { _info?: {}; id?: null | number; name?: string }; scheduleStatus?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; type?: { _info?: {}; id?: null | number; name?: string }; where?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; assignTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; assignedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; campaign?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateEnd?: string; dateStart?: string; email?: string; id?: number; mobileGuid?: null | string; name: string; notes?: string; notifyFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; phoneNumber?: string; reminder?: { _info?: {}; id?: null | number; name?: string }; scheduleStatus?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; type?: { _info?: {}; id?: null | number; name?: string }; where?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:135
Parameters
- id: number
- activity: { _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; assignTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; assignedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; campaign?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateEnd?: string; dateStart?: string; email?: string; id?: number; mobileGuid?: null | string; name: string; notes?: string; notifyFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; phoneNumber?: string; reminder?: { _info?: {}; id?: null | number; name?: string }; scheduleStatus?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; type?: { _info?: {}; id?: null | number; name?: string }; where?: { _info?: {}; id?: null | number; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
    - Optional type?: string
  - Optional assignTo?: { _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 assignedBy?: { _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 campaign?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: 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 contact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional currencyCode?: string
    - Optional currencyIdentifier?: string
    - Optional decimalSeparator?: string
    - Optional displayIdFlag?: boolean
    - Optional displaySymbolFlag?: boolean
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
    - Optional negativeParenthesesFlag?: boolean
    - Optional numberOfDecimals?: number
      
      Format: int32
    - Optional rightAlign?: boolean
    - Optional symbol?: string
    - Optional thousandsSeparator?: string
  - Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
  - Optional dateEnd?: string
    
    Format: date-time
  - Optional dateStart?: string
    
    Format: date-time
  - Optional email?: string
    description
    Max length: 250;
  - Optional id?: number
    
    Format: int32
  - Optional mobileGuid?: null | string
    
    Format: uuid
  - name: string
    description
    Max length: 100;
  - Optional notes?: string
  - Optional notifyFlag?: null | boolean
  - Optional opportunity?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional phoneNumber?: string
    description
    Max length: 30;
  - Optional reminder?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional scheduleStatus?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional status?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional ticket?: { _info?: {}; id?: null | number; summary?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional summary?: string
  - Optional type?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional where?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
Returns Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; assignTo?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; assignedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; campaign?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateEnd?: string; dateStart?: string; email?: string; id?: number; mobileGuid?: null | string; name: string; notes?: string; notifyFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; phoneNumber?: string; reminder?: { _info?: {}; id?: null | number; name?: string }; scheduleStatus?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; type?: { _info?: {}; id?: null | number; name?: string }; where?: { _info?: {}; id?: null | number; name?: string } }>

putSalesActivitiesStatusesById

putSalesActivitiesStatusesById(id: number, activityStatus: { _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; spawnFollowupFlag?: null | boolean }): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; spawnFollowupFlag?: null | boolean }>

- Defined in src/Manage/SalesAPI.ts:193
Parameters
- id: number
- activityStatus: { _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; spawnFollowupFlag?: null | boolean }
  - Optional _info?: {}
    - [key: string]: string
  - Optional closedFlag?: null | boolean
  - Optional defaultFlag?: null | boolean
  - Optional id?: number
    
    Format: int32
  - Optional inactiveFlag?: null | boolean
  - name: string
    description
    Max length: 30;
  - Optional spawnFollowupFlag?: null | boolean
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; spawnFollowupFlag?: null | boolean }>

putSalesActivitiesTypesById

putSalesActivitiesTypesById(id: number, activityType: { _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; historyFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; memoFlag?: null | boolean; name: string; points?: null | number }): Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; historyFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; memoFlag?: null | boolean; name: string; points?: null | number }>

- Defined in src/Manage/SalesAPI.ts:283
Parameters
- id: number
- activityType: { _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; historyFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; memoFlag?: null | boolean; name: string; points?: null | number }
  - Optional _info?: {}
    - [key: string]: string
  - Optional defaultFlag?: null | boolean
  - Optional emailFlag?: null | boolean
  - Optional historyFlag?: null | boolean
  - Optional id?: number
    
    Format: int32
  - Optional inactiveFlag?: null | boolean
  - Optional memoFlag?: null | boolean
  - name: string
    description
    Max length: 50;
  - Optional points?: null | number
    
    Format: int32
Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; historyFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; memoFlag?: null | boolean; name: string; points?: null | number }>

putSalesCommissionsById

putSalesCommissionsById(id: number, commission: { _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementType?: { _info?: {}; id?: null | number; name?: string }; agreementsFlag?: null | boolean; billingMethod?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; commissionBasis?: null | "GrossProfit" | "SalesAmount"; commissionPercent?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateEnd?: string; dateStart?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; invoiceOption?: null | "AllInvoices" | "PaidInvoices"; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; myOpportunitiesFlag?: null | boolean; numberOfMonths?: null | number; productCategory?: { _info?: {}; id?: null | number; name?: string }; productSubCategory?: { _info?: {}; id?: null | number; name?: string }; productsFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; projectBoard?: { _info?: {}; id?: null | number; name?: string }; projectType?: { _info?: {}; id?: null | number; name?: string }; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; servicesFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; territory?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string } }): Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementType?: { _info?: {}; id?: null | number; name?: string }; agreementsFlag?: null | boolean; billingMethod?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; commissionBasis?: null | "GrossProfit" | "SalesAmount"; commissionPercent?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateEnd?: string; dateStart?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; invoiceOption?: null | "AllInvoices" | "PaidInvoices"; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; myOpportunitiesFlag?: null | boolean; numberOfMonths?: null | number; productCategory?: { _info?: {}; id?: null | number; name?: string }; productSubCategory?: { _info?: {}; id?: null | number; name?: string }; productsFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; projectBoard?: { _info?: {}; id?: null | number; name?: string }; projectType?: { _info?: {}; id?: null | number; name?: string }; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; servicesFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; territory?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string } }>

- Defined in src/Manage/SalesAPI.ts:363
Parameters
- id: number
- commission: { _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementType?: { _info?: {}; id?: null | number; name?: string }; agreementsFlag?: null | boolean; billingMethod?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; commissionBasis?: null | "GrossProfit" | "SalesAmount"; commissionPercent?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateEnd?: string; dateStart?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; invoiceOption?: null | "AllInvoices" | "PaidInvoices"; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; myOpportunitiesFlag?: null | boolean; numberOfMonths?: null | number; productCategory?: { _info?: {}; id?: null | number; name?: string }; productSubCategory?: { _info?: {}; id?: null | number; name?: string }; productsFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; projectBoard?: { _info?: {}; id?: null | number; name?: string }; projectType?: { _info?: {}; id?: null | number; name?: string }; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; servicesFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; territory?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
    - Optional type?: string
  - Optional agreementType?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional agreementsFlag?: null | boolean
  - Optional billingMethod?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"
  - Optional commissionBasis?: null | "GrossProfit" | "SalesAmount"
  - Optional commissionPercent?: null | number
    
    Format: double
  - 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 dateEnd?: string
    
    Format: date-time
  - Optional dateStart?: string
    
    Format: date-time
  - 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 invoiceOption?: null | "AllInvoices" | "PaidInvoices"
  - Optional item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional serializedFlag?: null | boolean
  - Optional location?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - Optional myOpportunitiesFlag?: null | boolean
  - Optional numberOfMonths?: null | number
    
    Format: int32
  - Optional productCategory?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional productSubCategory?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional productsFlag?: null | boolean
  - Optional project?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional projectBoard?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional projectType?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional serviceBoard?: { _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
  - Optional servicesFlag?: null | boolean
  - Optional site?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional territory?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional ticket?: { _info?: {}; id?: null | number; summary?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional summary?: string
Returns Promise<{ _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementType?: { _info?: {}; id?: null | number; name?: string }; agreementsFlag?: null | boolean; billingMethod?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; commissionBasis?: null | "GrossProfit" | "SalesAmount"; commissionPercent?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateEnd?: string; dateStart?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; invoiceOption?: null | "AllInvoices" | "PaidInvoices"; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; myOpportunitiesFlag?: null | boolean; numberOfMonths?: null | number; productCategory?: { _info?: {}; id?: null | number; name?: string }; productSubCategory?: { _info?: {}; id?: null | number; name?: string }; productsFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; projectBoard?: { _info?: {}; id?: null | number; name?: string }; projectType?: { _info?: {}; id?: null | number; name?: string }; serviceBoard?: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; servicesFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; territory?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string } }>

putSalesOpportunitiesById

putSalesOpportunitiesById(id: number, opportunity: { _info?: {}; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; campaign?: { _info?: {}; id?: null | number; name?: string }; closedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; closedDate?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateBecameLead?: string; expectedCloseDate?: string; id?: number; locationId?: null | number; name: string; notes?: string; pipelineChangeDate?: string; primarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority?: { _info?: {}; id?: null | number; name?: string }; probability?: { _info?: {}; id?: null | number; name?: string }; rating?: { _info?: {}; id?: null | number; name?: string }; secondarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; source?: string; stage?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; technicalContact?: { _info?: {}; id?: null | number; name?: string }; totalSalesTax?: null | number; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; campaign?: { _info?: {}; id?: null | number; name?: string }; closedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; closedDate?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateBecameLead?: string; expectedCloseDate?: string; id?: number; locationId?: null | number; name: string; notes?: string; pipelineChangeDate?: string; primarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority?: { _info?: {}; id?: null | number; name?: string }; probability?: { _info?: {}; id?: null | number; name?: string }; rating?: { _info?: {}; id?: null | number; name?: string }; secondarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; source?: string; stage?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; technicalContact?: { _info?: {}; id?: null | number; name?: string }; totalSalesTax?: null | number; type?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:440
Parameters
- id: number
- opportunity: { _info?: {}; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; campaign?: { _info?: {}; id?: null | number; name?: string }; closedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; closedDate?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateBecameLead?: string; expectedCloseDate?: string; id?: number; locationId?: null | number; name: string; notes?: string; pipelineChangeDate?: string; primarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority?: { _info?: {}; id?: null | number; name?: string }; probability?: { _info?: {}; id?: null | number; name?: string }; rating?: { _info?: {}; id?: null | number; name?: string }; secondarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; source?: string; stage?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; technicalContact?: { _info?: {}; id?: null | number; name?: string }; totalSalesTax?: null | number; type?: { _info?: {}; id?: null | number; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - Optional billToContact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional billToSite?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional billingTerms?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional businessUnitId?: null | number
    
    Format: int32
    
    description
    Required On Updates;
  - Optional campaign?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional closedBy?: { _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 closedDate?: string
    
    Format: date-time
  - Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - Optional companyLocationId?: null | number
    
    Format: int32
  - Optional contact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional currencyCode?: string
    - Optional currencyIdentifier?: string
    - Optional decimalSeparator?: string
    - Optional displayIdFlag?: boolean
    - Optional displaySymbolFlag?: boolean
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
    - Optional negativeParenthesesFlag?: boolean
    - Optional numberOfDecimals?: number
      
      Format: int32
    - Optional rightAlign?: boolean
    - Optional symbol?: string
    - Optional thousandsSeparator?: string
  - Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
  - Optional customerPO?: string
    description
    Max length: 25;
  - Optional dateBecameLead?: string
    
    Format: date-time
  - Optional expectedCloseDate?: string
    
    Format: date-time
    
    description
    Required On Updates;
  - Optional id?: number
    
    Format: int32
  - Optional locationId?: null | number
    
    Format: int32
    
    description
    Required On Updates;
  - name: string
    description
    Max length: 100;
  - Optional notes?: string
  - Optional pipelineChangeDate?: string
    
    Format: date-time
  - Optional primarySalesRep?: { _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 priority?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional probability?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional rating?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional secondarySalesRep?: { _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 shipToCompany?: { _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 shipToContact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional shipToSite?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional site?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional source?: string
    description
    Max length: 50;
  - Optional stage?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional status?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional taxCode?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional technicalContact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional totalSalesTax?: null | number
    
    Format: double
  - Optional type?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
Returns Promise<{ _info?: {}; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; businessUnitId?: null | number; campaign?: { _info?: {}; id?: null | number; name?: string }; closedBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; closedDate?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocationId?: null | number; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateBecameLead?: string; expectedCloseDate?: string; id?: number; locationId?: null | number; name: string; notes?: string; pipelineChangeDate?: string; primarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; priority?: { _info?: {}; id?: null | number; name?: string }; probability?: { _info?: {}; id?: null | number; name?: string }; rating?: { _info?: {}; id?: null | number; name?: string }; secondarySalesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; source?: string; stage?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; technicalContact?: { _info?: {}; id?: null | number; name?: string }; totalSalesTax?: null | number; type?: { _info?: {}; id?: null | number; name?: string } }>

putSalesOpportunitiesByParentIdContactsById

putSalesOpportunitiesByParentIdContactsById(id: number, parentId: number, opportunityContact: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; id?: number; notes?: string; opportunityId?: null | number; phoneNumber?: string; referralFlag?: null | boolean; role?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; id?: number; notes?: string; opportunityId?: null | number; phoneNumber?: string; referralFlag?: null | boolean; role?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:547
Parameters
- id: number
- parentId: number
- opportunityContact: { _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; id?: number; notes?: string; opportunityId?: null | number; phoneNumber?: string; referralFlag?: null | boolean; role?: { _info?: {}; id?: null | number; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - Optional contact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional emailAddress?: string
  - Optional id?: number
    
    Format: int32
  - Optional notes?: string
  - Optional opportunityId?: null | number
    
    Format: int32
  - Optional phoneNumber?: string
  - Optional referralFlag?: null | boolean
  - Optional role?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
Returns Promise<{ _info?: {}; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; emailAddress?: string; id?: number; notes?: string; opportunityId?: null | number; phoneNumber?: string; referralFlag?: null | boolean; role?: { _info?: {}; id?: null | number; name?: string } }>

putSalesOpportunitiesByParentIdForecast

putSalesOpportunitiesByParentIdForecast(parentId: number, forecast: { _info?: {}; agreementRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; expectedProbability?: number; expenseRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastItems?: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }[]; forecastRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastTotalWithTaxes?: null | number; id?: number; inclusiveRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; lostRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; openRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue1?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue2?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; productRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; recurringTotal?: null | number; salesTaxRevenue?: null | number; serviceRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; wonRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number } }): Promise<{ _info?: {}; agreementRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; expectedProbability?: number; expenseRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastItems?: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }[]; forecastRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastTotalWithTaxes?: null | number; id?: number; inclusiveRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; lostRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; openRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue1?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue2?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; productRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; recurringTotal?: null | number; salesTaxRevenue?: null | number; serviceRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; wonRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number } }>

- Defined in src/Manage/SalesAPI.ts:611
Parameters
- parentId: number
- forecast: { _info?: {}; agreementRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; expectedProbability?: number; expenseRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastItems?: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }[]; forecastRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastTotalWithTaxes?: null | number; id?: number; inclusiveRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; lostRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; openRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue1?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue2?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; productRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; recurringTotal?: null | number; salesTaxRevenue?: null | number; serviceRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; wonRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional agreementRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional billingTerms?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional currencyCode?: string
    - Optional currencyIdentifier?: string
    - Optional decimalSeparator?: string
    - Optional displayIdFlag?: boolean
    - Optional displaySymbolFlag?: boolean
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
    - Optional negativeParenthesesFlag?: boolean
    - Optional numberOfDecimals?: number
      
      Format: int32
    - Optional rightAlign?: boolean
    - Optional symbol?: string
    - Optional thousandsSeparator?: string
  - Optional expectedProbability?: number
    
    Format: int32
  - Optional expenseRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional forecastItems?: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }[]
  - Optional forecastRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional forecastTotalWithTaxes?: null | number
    
    Format: double
  - Optional id?: number
    
    Format: int32
  - Optional inclusiveRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional lostRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional openRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional otherRevenue1?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional otherRevenue2?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional productRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional recurringTotal?: null | number
    
    Format: double
  - Optional salesTaxRevenue?: null | number
    
    Format: double
  - Optional serviceRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional taxCode?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional timeRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
  - Optional wonRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }
    - Optional _info?: {}
      - [key: string]: string
    - Optional cost?: null | number
      
      Format: double
    - Optional id?: null | number
      
      Format: int32
    - Optional margin?: null | number
      
      Format: double
    - Optional percentage?: null | number
      
      Format: double
    - Optional revenue?: null | number
      
      Format: double
Returns Promise<{ _info?: {}; agreementRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; expectedProbability?: number; expenseRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastItems?: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }[]; forecastRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; forecastTotalWithTaxes?: null | number; id?: number; inclusiveRevenueTotals?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; lostRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; openRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue1?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; otherRevenue2?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; productRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; recurringTotal?: null | number; salesTaxRevenue?: null | number; serviceRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; taxCode?: { _info?: {}; id?: null | number; name?: string }; timeRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number }; wonRevenue?: { _info?: {}; cost?: null | number; id?: null | number; margin?: null | number; percentage?: null | number; revenue?: null | number } }>

putSalesOpportunitiesByParentIdForecastById

putSalesOpportunitiesByParentIdForecastById(id: number, parentId: number, forecast: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }): Promise<{ _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }>

- Defined in src/Manage/SalesAPI.ts:664
Parameters
- id: number
- parentId: number
- forecast: { _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }
  - Optional _info?: {}
    - [key: string]: string
  - Optional billCycle?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional serializedFlag?: null | boolean
  - Optional cost?: null | number
    
    Format: double
  - Optional cycleBasis?: string
  - Optional cycles?: number
    
    Format: int32
  - Optional forecastDescription?: string
    description
    Max length: 50;
  - forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"
  - Optional id?: number
    
    Format: int32
  - Optional includeFlag?: boolean
  - Optional linkFlag?: boolean
  - Optional margin?: number
    
    Format: double
  - Optional opportunity?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional percentage?: number
    
    Format: int32
  - Optional productClass?: string
  - Optional productDescription?: string
  - Optional quantity?: number
    
    Format: double
  - Optional quoteWerksDocName?: string
    description
    Max length: 255;
  - Optional quoteWerksDocNo?: string
    description
    Max length: 20;
  - Optional quoteWerksQuantity?: number
    
    Format: int32
  - Optional recurringCost?: null | number
    
    Format: double
  - Optional recurringDateEnd?: string
    
    Format: date-time
  - Optional recurringDateStart?: string
    
    Format: date-time
  - Optional recurringFlag?: boolean
  - Optional recurringRevenue?: number
    
    Format: double
  - Optional revenue?: number
    
    Format: double
  - Optional sequenceNumber?: number
    
    Format: double
  - Optional status?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional subNumber?: number
    
    Format: int32
  - Optional taxableFlag?: boolean
Returns Promise<{ _info?: {}; billCycle?: { _info?: {}; id?: null | number; name?: string }; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; cost?: null | number; cycleBasis?: string; cycles?: number; forecastDescription?: string; forecastType: null | "Agreement" | "Service" | "Other1" | "Other2" | "Product"; id?: number; includeFlag?: boolean; linkFlag?: boolean; margin?: number; opportunity?: { _info?: {}; id?: null | number; name?: string }; percentage?: number; productClass?: string; productDescription?: string; quantity?: number; quoteWerksDocName?: string; quoteWerksDocNo?: string; quoteWerksQuantity?: number; recurringCost?: null | number; recurringDateEnd?: string; recurringDateStart?: string; recurringFlag?: boolean; recurringRevenue?: number; revenue?: number; sequenceNumber?: number; status?: { _info?: {}; id?: null | number; name?: string }; subNumber?: number; taxableFlag?: boolean }>

putSalesOpportunitiesByParentIdNotesById

putSalesOpportunitiesByParentIdNotesById(id: number, parentId: number, note: { _info?: {}; enteredBy?: string; flagged?: null | boolean; id?: number; mobileGuid?: null | string; opportunityId?: null | number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; enteredBy?: string; flagged?: null | boolean; id?: number; mobileGuid?: null | string; opportunityId?: null | number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:753
Parameters
- id: number
- parentId: number
- note: { _info?: {}; enteredBy?: string; flagged?: null | boolean; id?: number; mobileGuid?: null | string; opportunityId?: null | number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional enteredBy?: string
  - Optional flagged?: null | boolean
  - Optional id?: number
    
    Format: int32
  - Optional mobileGuid?: null | string
    
    Format: uuid
  - Optional opportunityId?: null | number
    
    Format: int32
  - text: string
  - Optional type?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
Returns Promise<{ _info?: {}; enteredBy?: string; flagged?: null | boolean; id?: number; mobileGuid?: null | string; opportunityId?: null | number; text: string; type?: { _info?: {}; id?: null | number; name?: string } }>

putSalesOpportunitiesByParentIdTeamById

putSalesOpportunitiesByParentIdTeamById(id: number, parentId: number, team: { _info?: {}; commissionPercent?: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; opportunityId?: null | number; referralFlag?: null | boolean; responsibleFlag?: null | boolean; salesTeam?: { _info?: {}; id?: null | number; identifier?: string }; type: null | "Team" | "Individual" }): Promise<{ _info?: {}; commissionPercent?: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; opportunityId?: null | number; referralFlag?: null | boolean; responsibleFlag?: null | boolean; salesTeam?: { _info?: {}; id?: null | number; identifier?: string }; type: null | "Team" | "Individual" }>

- Defined in src/Manage/SalesAPI.ts:829
Parameters
- id: number
- parentId: number
- team: { _info?: {}; commissionPercent?: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; opportunityId?: null | number; referralFlag?: null | boolean; responsibleFlag?: null | boolean; salesTeam?: { _info?: {}; id?: null | number; identifier?: string }; type: null | "Team" | "Individual" }
  - Optional _info?: {}
    - [key: string]: string
  - Optional commissionPercent?: null | number
    
    Format: int32
  - 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 opportunityId?: null | number
    
    Format: int32
  - Optional referralFlag?: null | boolean
  - Optional responsibleFlag?: null | boolean
  - Optional salesTeam?: { _info?: {}; id?: null | number; identifier?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
  - type: null | "Team" | "Individual"
Returns Promise<{ _info?: {}; commissionPercent?: null | number; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; opportunityId?: null | number; referralFlag?: null | boolean; responsibleFlag?: null | boolean; salesTeam?: { _info?: {}; id?: null | number; identifier?: string }; type: null | "Team" | "Individual" }>

putSalesOpportunitiesRatingsById

putSalesOpportunitiesRatingsById(id: number, opportunityRating: { _info?: {}; id?: number; name: string; sortOrder?: null | number }): Promise<{ _info?: {}; id?: number; name: string; sortOrder?: null | number }>

- Defined in src/Manage/SalesAPI.ts:910
Parameters
- id: number
- opportunityRating: { _info?: {}; id?: number; name: string; sortOrder?: null | number }
  - Optional _info?: {}
    - [key: string]: string
  - Optional id?: number
    
    Format: int32
  - name: string
    description
    Max length: 50;
  - Optional sortOrder?: null | number
    
    Format: int32
Returns Promise<{ _info?: {}; id?: number; name: string; sortOrder?: null | number }>

putSalesOpportunitiesStatusesById

putSalesOpportunitiesStatusesById(id: number, status: { _info?: {}; closedFlag?: null | boolean; dateEntered?: string; defaultFlag?: null | boolean; enteredBy?: string; id?: number; inactiveFlag?: null | boolean; lostFlag?: null | boolean; name: string; wonFlag?: null | boolean }): Promise<{ _info?: {}; closedFlag?: null | boolean; dateEntered?: string; defaultFlag?: null | boolean; enteredBy?: string; id?: number; inactiveFlag?: null | boolean; lostFlag?: null | boolean; name: string; wonFlag?: null | boolean }>

- Defined in src/Manage/SalesAPI.ts:1003
Parameters
- id: number
- status: { _info?: {}; closedFlag?: null | boolean; dateEntered?: string; defaultFlag?: null | boolean; enteredBy?: string; id?: number; inactiveFlag?: null | boolean; lostFlag?: null | boolean; name: string; wonFlag?: null | boolean }
  - Optional _info?: {}
    - [key: string]: string
  - Optional closedFlag?: null | boolean
  - Optional dateEntered?: string
    
    Format: date-time
  - Optional defaultFlag?: null | boolean
  - Optional enteredBy?: string
  - Optional id?: number
    
    Format: int32
  - Optional inactiveFlag?: null | boolean
  - Optional lostFlag?: null | boolean
  - name: string
    description
    Max length: 30;
  - Optional wonFlag?: null | boolean
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; dateEntered?: string; defaultFlag?: null | boolean; enteredBy?: string; id?: number; inactiveFlag?: null | boolean; lostFlag?: null | boolean; name: string; wonFlag?: null | boolean }>

putSalesOpportunitiesTypesById

putSalesOpportunitiesTypesById(id: number, opportunityType: { _info?: {}; description: string; id?: number; inactiveFlag?: null | boolean }): Promise<{ _info?: {}; description: string; id?: number; inactiveFlag?: null | boolean }>

- Defined in src/Manage/SalesAPI.ts:1118
Parameters
- id: number
- opportunityType: { _info?: {}; description: string; id?: number; inactiveFlag?: null | boolean }
  - Optional _info?: {}
    - [key: string]: string
  - description: string
    description
    Max length: 50;
  - Optional id?: number
    
    Format: int32
  - Optional inactiveFlag?: null | boolean
Returns Promise<{ _info?: {}; description: string; id?: number; inactiveFlag?: null | boolean }>

putSalesOrdersById

putSalesOrdersById(id: number, order: { _info?: {}; billClosedFlag?: null | boolean; billShippedFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; configIds?: number[]; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; documentIds?: number[]; dueDate?: string; email?: string; id?: number; invoiceIds?: number[]; location?: { _info?: {}; id?: null | number; name?: string }; notes?: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; orderDate?: string; phone?: string; phoneExt?: string; poNumber?: string; productIds?: number[]; restrictDownpaymentFlag?: null | boolean; salesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; subTotal?: number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxTotal?: null | number; topCommentFlag?: null | boolean; total?: null | number }): Promise<{ _info?: {}; billClosedFlag?: null | boolean; billShippedFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; configIds?: number[]; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; documentIds?: number[]; dueDate?: string; email?: string; id?: number; invoiceIds?: number[]; location?: { _info?: {}; id?: null | number; name?: string }; notes?: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; orderDate?: string; phone?: string; phoneExt?: string; poNumber?: string; productIds?: number[]; restrictDownpaymentFlag?: null | boolean; salesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; subTotal?: number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxTotal?: null | number; topCommentFlag?: null | boolean; total?: null | number }>

- Defined in src/Manage/SalesAPI.ts:1230
Parameters
- id: number
- order: { _info?: {}; billClosedFlag?: null | boolean; billShippedFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; configIds?: number[]; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; documentIds?: number[]; dueDate?: string; email?: string; id?: number; invoiceIds?: number[]; location?: { _info?: {}; id?: null | number; name?: string }; notes?: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; orderDate?: string; phone?: string; phoneExt?: string; poNumber?: string; productIds?: number[]; restrictDownpaymentFlag?: null | boolean; salesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; subTotal?: number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxTotal?: null | number; topCommentFlag?: null | boolean; total?: null | number }
  - Optional _info?: {}
    - [key: string]: string
  - Optional billClosedFlag?: null | boolean
  - Optional billShippedFlag?: null | boolean
  - Optional billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - Optional billToContact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional billToSite?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional billingTerms?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional bottomCommentFlag?: null | boolean
  - Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - Optional companyLocation?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional configIds?: number[]
  - Optional contact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional currencyCode?: string
    - Optional currencyIdentifier?: string
    - Optional decimalSeparator?: string
    - Optional displayIdFlag?: boolean
    - Optional displaySymbolFlag?: boolean
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
    - Optional negativeParenthesesFlag?: boolean
    - Optional numberOfDecimals?: number
      
      Format: int32
    - Optional rightAlign?: boolean
    - Optional symbol?: string
    - Optional thousandsSeparator?: string
  - Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
  - Optional 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 description?: string
  - Optional documentIds?: number[]
  - Optional dueDate?: string
    
    Format: date-time
  - Optional email?: string
  - Optional id?: number
    
    Format: int32
  - Optional invoiceIds?: number[]
  - Optional location?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional notes?: string
  - Optional opportunity?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional orderDate?: string
    
    Format: date-time
  - Optional phone?: string
  - Optional phoneExt?: string
  - Optional poNumber?: string
    description
    Max length: 50;
  - Optional productIds?: number[]
  - Optional restrictDownpaymentFlag?: null | boolean
  - Optional salesRep?: { _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 shipToCompany?: { _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 shipToContact?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional shipToSite?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional site?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional status?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional subTotal?: number
    
    Format: double
  - Optional taxCode?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional taxTotal?: null | number
    
    Format: double
  - Optional topCommentFlag?: null | boolean
  - Optional total?: null | number
    
    Format: double
Returns Promise<{ _info?: {}; billClosedFlag?: null | boolean; billShippedFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; configIds?: number[]; contact?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; description?: string; documentIds?: number[]; dueDate?: string; email?: string; id?: number; invoiceIds?: number[]; location?: { _info?: {}; id?: null | number; name?: string }; notes?: string; opportunity?: { _info?: {}; id?: null | number; name?: string }; orderDate?: string; phone?: string; phoneExt?: string; poNumber?: string; productIds?: number[]; restrictDownpaymentFlag?: null | boolean; salesRep?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; subTotal?: number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxTotal?: null | number; topCommentFlag?: null | boolean; total?: null | number }>

putSalesOrdersStatusesById

putSalesOrdersStatusesById(id: number, status: { _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; name: string; sortOrder?: null | number }): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; name: string; sortOrder?: null | number }>

- Defined in src/Manage/SalesAPI.ts:1292
Parameters
- id: number
- status: { _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; name: string; sortOrder?: null | number }
  - Optional _info?: {}
    - [key: string]: string
  - Optional closedFlag?: null | boolean
  - Optional defaultFlag?: null | boolean
  - Optional emailTemplate?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional id?: number
    
    Format: int32
  - Optional inactiveFlag?: null | boolean
  - name: string
    description
    Max length: 50;
  - Optional sortOrder?: null | number
    
    Format: int32
Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number; inactiveFlag?: null | boolean; name: string; sortOrder?: null | number }>

putSalesOrdersStatusesByParentIdEmailtemplatesById

putSalesOrdersStatusesByParentIdEmailtemplatesById(id: number, parentId: number, orderStatusEmailTemplate: { _info?: {}; body: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; lastName?: string; status?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }): Promise<{ _info?: {}; body: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; lastName?: string; status?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }>

- Defined in src/Manage/SalesAPI.ts:1388
Parameters
- id: number
- parentId: number
- orderStatusEmailTemplate: { _info?: {}; body: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; lastName?: string; status?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }
  - Optional _info?: {}
    - [key: string]: string
  - body: string
  - Optional copySenderFlag?: null | boolean
  - Optional emailAddress?: string
    description
    Max length: 100;
  - Optional firstName?: string
    description
    Max length: 100;
  - Optional id?: number
    
    Format: int32
  - Optional lastName?: string
    description
    Max length: 100;
  - Optional status?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - subject: string
    description
    Max length: 200;
  - Optional useSenderFlag?: null | boolean
Returns Promise<{ _info?: {}; body: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; lastName?: string; status?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }>

putSalesOrdersStatusesByParentIdNotificationsById

putSalesOrdersStatusesByParentIdNotificationsById(id: number, parentId: number, orderStatusNotification: { _info?: {}; email?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; workflowStep?: null | number }): Promise<{ _info?: {}; email?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; workflowStep?: null | number }>

- Defined in src/Manage/SalesAPI.ts:1467
Parameters
- id: number
- parentId: number
- orderStatusNotification: { _info?: {}; email?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; workflowStep?: null | number }
  - Optional _info?: {}
    - [key: string]: string
  - Optional email?: string
    description
    Order Status Notification sendEmail must be entered if the notify type is "Email Address" Max length: 50;
  - Optional id?: number
    
    Format: int32
  - Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - Optional notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
  - Optional status?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional workflowStep?: null | number
    
    Format: int32
Returns Promise<{ _info?: {}; email?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; notifyWho?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; status?: { _info?: {}; id?: null | number; name?: string }; workflowStep?: null | number }>

putSalesProbabilitiesById

putSalesProbabilitiesById(id: number, probability: { _info?: {}; id?: number; probability: number }): Promise<{ _info?: {}; id?: number; probability: number }>

- Defined in src/Manage/SalesAPI.ts:1557
Parameters
- id: number
- probability: { _info?: {}; id?: number; probability: number }
  - Optional _info?: {}
    - [key: string]: string
  - Optional id?: number
    
    Format: int32
  - probability: number
    
    Format: int32
Returns Promise<{ _info?: {}; id?: number; probability: number }>

putSalesQuotasById

putSalesQuotasById(id: number, salesQuota: { _info?: {}; aprilMargin?: null | number; aprilRevenue?: null | number; augustMargin?: null | number; augustRevenue?: null | number; category?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; decemberMargin?: null | number; decemberRevenue?: null | number; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; februaryMargin?: null | number; februaryRevenue?: null | number; forecastYear?: null | number; id?: number; januaryMargin?: null | number; januaryRevenue?: null | number; julyMargin?: null | number; julyRevenue?: null | number; juneMargin?: null | number; juneRevenue?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; marchMargin?: null | number; marchRevenue?: null | number; mayMargin?: null | number; mayRevenue?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; novemberMargin?: null | number; novemberRevenue?: null | number; octoberMargin?: null | number; octoberRevenue?: null | number; septemberMargin?: null | number; septemberRevenue?: null | number; subCategory?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; aprilMargin?: null | number; aprilRevenue?: null | number; augustMargin?: null | number; augustRevenue?: null | number; category?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; decemberMargin?: null | number; decemberRevenue?: null | number; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; februaryMargin?: null | number; februaryRevenue?: null | number; forecastYear?: null | number; id?: number; januaryMargin?: null | number; januaryRevenue?: null | number; julyMargin?: null | number; julyRevenue?: null | number; juneMargin?: null | number; juneRevenue?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; marchMargin?: null | number; marchRevenue?: null | number; mayMargin?: null | number; mayRevenue?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; novemberMargin?: null | number; novemberRevenue?: null | number; octoberMargin?: null | number; octoberRevenue?: null | number; septemberMargin?: null | number; septemberRevenue?: null | number; subCategory?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:1642
Parameters
- id: number
- salesQuota: { _info?: {}; aprilMargin?: null | number; aprilRevenue?: null | number; augustMargin?: null | number; augustRevenue?: null | number; category?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; decemberMargin?: null | number; decemberRevenue?: null | number; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; februaryMargin?: null | number; februaryRevenue?: null | number; forecastYear?: null | number; id?: number; januaryMargin?: null | number; januaryRevenue?: null | number; julyMargin?: null | number; julyRevenue?: null | number; juneMargin?: null | number; juneRevenue?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; marchMargin?: null | number; marchRevenue?: null | number; mayMargin?: null | number; mayRevenue?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; novemberMargin?: null | number; novemberRevenue?: null | number; octoberMargin?: null | number; octoberRevenue?: null | number; septemberMargin?: null | number; septemberRevenue?: null | number; subCategory?: { _info?: {}; id?: null | number; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional aprilMargin?: null | number
    
    Format: double
  - Optional aprilRevenue?: null | number
    
    Format: double
  - Optional augustMargin?: null | number
    
    Format: double
  - Optional augustRevenue?: null | number
    
    Format: double
  - Optional category?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional currencyCode?: string
    - Optional currencyIdentifier?: string
    - Optional decimalSeparator?: string
    - Optional displayIdFlag?: boolean
    - Optional displaySymbolFlag?: boolean
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
    - Optional negativeParenthesesFlag?: boolean
    - Optional numberOfDecimals?: number
      
      Format: int32
    - Optional rightAlign?: boolean
    - Optional symbol?: string
    - Optional thousandsSeparator?: string
  - Optional decemberMargin?: null | number
    
    Format: double
  - Optional decemberRevenue?: null | number
    
    Format: double
  - 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 februaryMargin?: null | number
    
    Format: double
  - Optional februaryRevenue?: null | number
    
    Format: double
  - Optional forecastYear?: null | number
    
    Format: int32
  - Optional id?: number
    
    Format: int32
  - Optional januaryMargin?: null | number
    
    Format: double
  - Optional januaryRevenue?: null | number
    
    Format: double
  - Optional julyMargin?: null | number
    
    Format: double
  - Optional julyRevenue?: null | number
    
    Format: double
  - Optional juneMargin?: null | number
    
    Format: double
  - Optional juneRevenue?: null | number
    
    Format: double
  - Optional location?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional marchMargin?: null | number
    
    Format: double
  - Optional marchRevenue?: null | number
    
    Format: double
  - Optional mayMargin?: null | number
    
    Format: double
  - Optional mayRevenue?: null | number
    
    Format: double
  - 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 novemberMargin?: null | number
    
    Format: double
  - Optional novemberRevenue?: null | number
    
    Format: double
  - Optional octoberMargin?: null | number
    
    Format: double
  - Optional octoberRevenue?: null | number
    
    Format: double
  - Optional septemberMargin?: null | number
    
    Format: double
  - Optional septemberRevenue?: null | number
    
    Format: double
  - Optional subCategory?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
Returns Promise<{ _info?: {}; aprilMargin?: null | number; aprilRevenue?: null | number; augustMargin?: null | number; augustRevenue?: null | number; category?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; decemberMargin?: null | number; decemberRevenue?: null | number; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; februaryMargin?: null | number; februaryRevenue?: null | number; forecastYear?: null | number; id?: number; januaryMargin?: null | number; januaryRevenue?: null | number; julyMargin?: null | number; julyRevenue?: null | number; juneMargin?: null | number; juneRevenue?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; marchMargin?: null | number; marchRevenue?: null | number; mayMargin?: null | number; mayRevenue?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; novemberMargin?: null | number; novemberRevenue?: null | number; octoberMargin?: null | number; octoberRevenue?: null | number; septemberMargin?: null | number; septemberRevenue?: null | number; subCategory?: { _info?: {}; id?: null | number; name?: string } }>

putSalesRolesById

putSalesRolesById(id: number, role: { _info?: {}; id?: number; name: string }): Promise<{ _info?: {}; id?: number; name: string }>

- Defined in src/Manage/SalesAPI.ts:1697
Parameters
- id: number
- role: { _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 }>

putSalesSalesTeamsById

putSalesSalesTeamsById(id: number, salesTeam: { _info?: {}; id?: number; inactiveFlag?: null | boolean; salesTeamDescription: string; salesTeamIdentifier: string; salesTeamLocation?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; salesTeamDescription: string; salesTeamIdentifier: string; salesTeamLocation?: { _info?: {}; id?: null | number; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:1752
Parameters
- id: number
- salesTeam: { _info?: {}; id?: number; inactiveFlag?: null | boolean; salesTeamDescription: string; salesTeamIdentifier: string; salesTeamLocation?: { _info?: {}; id?: null | number; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional id?: number
    
    Format: int32
  - Optional inactiveFlag?: null | boolean
  - salesTeamDescription: string
    description
    Max length: 50;
  - salesTeamIdentifier: string
    description
    Max length: 20;
  - Optional salesTeamLocation?: { _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; inactiveFlag?: null | boolean; salesTeamDescription: string; salesTeamIdentifier: string; salesTeamLocation?: { _info?: {}; id?: null | number; name?: string } }>

putSalesSalesTeamsByParentIdMembersById

putSalesSalesTeamsByParentIdMembersById(id: number, parentId: number, salesTeamMember: { _info?: {}; allowAccessFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }): Promise<{ _info?: {}; allowAccessFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

- Defined in src/Manage/SalesAPI.ts:1812
Parameters
- id: number
- parentId: number
- salesTeamMember: { _info?: {}; allowAccessFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }
  - Optional _info?: {}
    - [key: string]: string
  - Optional allowAccessFlag?: 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 id?: number
    
    Format: int32
  - Optional location?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional identifier?: string
    - Optional name?: string
Returns Promise<{ _info?: {}; allowAccessFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }>

putSalesStagesById

putSalesStagesById(id: number, stage: { _info?: {}; color?: string; id?: number; name: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }): Promise<{ _info?: {}; color?: string; id?: number; name: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }>

- Defined in src/Manage/SalesAPI.ts:1902
Parameters
- id: number
- stage: { _info?: {}; color?: string; id?: number; name: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }
  - Optional _info?: {}
    - [key: string]: string
  - Optional color?: string
    description
    Max length: 25;
  - Optional id?: number
    
    Format: int32
  - name: string
    description
    Max length: 50;
  - Optional probability?: { _info?: {}; id?: null | number; name?: string }
    - Optional _info?: {}
      - [key: string]: string
    - Optional id?: null | number
      
      Format: int32
    - Optional name?: string
  - Optional sequenceNumber?: null | number
    
    Format: int32
Returns Promise<{ _info?: {}; color?: string; id?: number; name: string; probability?: { _info?: {}; id?: null | number; name?: string }; sequenceNumber?: null | number }>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

props: CWMOptions

Returns SalesAPI

Properties

config

paginate

Type declaration

Parameters

apiMethod: Function

paginateArgs: PaginationOptions

Rest ...methodArgs: Record<string, unknown>[]

Returns Promise<unknown[]>

request

Type declaration

Parameters

args: RequestOptions

Returns Promise<any>

Methods

deleteSalesActivitiesById

Parameters

id: number

Returns Promise<undefined>

deleteSalesActivitiesStatusesById

Parameters

id: number

Returns Promise<undefined>

deleteSalesActivitiesTypesById

Parameters

id: number

Returns Promise<undefined>

deleteSalesCommissionsById

Parameters

id: number

Returns Promise<undefined>

deleteSalesOpportunitiesById

Parameters

id: number

Returns Promise<undefined>

deleteSalesOpportunitiesByParentIdContactsById

Parameters

id: number

parentId: number

Returns Promise<undefined>

deleteSalesOpportunitiesByParentIdForecast

Parameters

parentId: number

Returns Promise<undefined>

deleteSalesOpportunitiesByParentIdForecastById

Parameters

id: number

parentId: number

Returns Promise<undefined>

deleteSalesOpportunitiesByParentIdNotesById

Parameters

id: number

parentId: number

Returns Promise<undefined>

deleteSalesOpportunitiesByParentIdTeamById

Parameters

id: number

parentId: number

Returns Promise<undefined>

deleteSalesOpportunitiesRatingsById

Parameters

id: number

Returns Promise<undefined>

deleteSalesOpportunitiesStatusesById

Parameters

id: number

Returns Promise<undefined>

deleteSalesOpportunitiesTypesById

Parameters

id: number