Class BillingCyclesApi

Hierarchy

BillingCyclesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BillingCyclesApi(basePath?: string): BillingCyclesApi

- Defined in api/api.ts:19788
Parameters
- Optional basePath: string
Returns BillingCyclesApi

Properties

Protected basePath

basePath: string = "https://api-na.myconnectwise.net/v4_6_release/apis/3.0"

defaultHeaders

defaultHeaders: any

Methods

financeBillingCyclesCountGet

financeBillingCyclesCountGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Count>

- Defined in api/api.ts:19801
Get Billing Cycles Count

Parameters
- params: object
  - Optional conditions?: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Count>

financeBillingCyclesGet

financeBillingCyclesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<BillingCycle>>

- Defined in api/api.ts:19842
Get Billing Cycles

Parameters
- params: object
  - Optional childconditions?: string
  - Optional conditions?: string
  - Optional customfieldconditions?: string
  - Optional orderBy?: string
  - Optional page?: number
  - Optional pageSize?: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<BillingCycle>>

financeBillingCyclesIdDelete

financeBillingCyclesIdDelete(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:19898
Delete Billing Cycle By Id

Parameters
- params: object
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

financeBillingCyclesIdGet

financeBillingCyclesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BillingCycle>

- Defined in api/api.ts:19935
Get Billing Cycle By Id

Parameters
- params: object
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<BillingCycle>

financeBillingCyclesIdPatch

financeBillingCyclesIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BillingCycle>

- Defined in api/api.ts:19973
Update Billing Terms

Parameters
- params: object
  - id: number
  - operations: Array<PatchOperation>
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<BillingCycle>

financeBillingCyclesIdPut

financeBillingCyclesIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BillingCycle>

- Defined in api/api.ts:20018
Replace Billing Cycle

Parameters
- params: object
  - billingCycle: BillingCycle
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<BillingCycle>

financeBillingCyclesPost

financeBillingCyclesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BillingCycle>

- Defined in api/api.ts:20062
Create Billing Cycle

Parameters
- params: object
  - billingCycle: BillingCycle
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<BillingCycle>

Generated using TypeDoc