Class OrdersApi

Hierarchy

OrdersApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OrdersApi(basePath?: string): OrdersApi

- Defined in api/api.ts:64046
Parameters
- Optional basePath: string
Returns OrdersApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

salesOrdersCountGet

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

- Defined in api/api.ts:64060
Get Sales Orders Count

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

salesOrdersGet

salesOrdersGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Order>>

- Defined in api/api.ts:64105
Get Sales Orders

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<Order>>

salesOrdersIdDelete

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

- Defined in api/api.ts:64161
Delete Sales Order By Id

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

salesOrdersIdGet

salesOrdersIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Order>

- Defined in api/api.ts:64198
Get Sales Order By Id

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

salesOrdersIdPatch

salesOrdersIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Order>

- Defined in api/api.ts:64236
Update Sales Order

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

salesOrdersIdPut

salesOrdersIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Order>

- Defined in api/api.ts:64281
Replace Sales Order

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

salesOrdersPost

salesOrdersPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Order>>

- Defined in api/api.ts:64325
Create Sales Order

Parameters
- params: object
  - order: Order
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Array<Order>>

Generated using TypeDoc