Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OrdersApi

Hierarchy

  • OrdersApi

Index

Constructors

constructor

  • new OrdersApi(basePath?: string): 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>
  • 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>>
  • 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>
  • 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>
  • 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>
  • Update Sales Order

    Parameters

    • params: object
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Order>

salesOrdersIdPut

  • salesOrdersIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Order>
  • 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>>
  • Create Sales Order

    Parameters

    • params: object
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Array<Order>>

Generated using TypeDoc