Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AgreementAdditionsApi

Hierarchy

  • AgreementAdditionsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

financeAgreementsIdAdditionsAdditionIdDelete

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

  • Delete Addition By Id

    Parameters

    • params: object
      • additionId: number
      • id: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

financeAgreementsIdAdditionsAdditionIdGet

  • financeAgreementsIdAdditionsAdditionIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Addition>

  • Get Addition By Id

    Parameters

    • params: object
      • additionId: number
      • id: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Addition>

financeAgreementsIdAdditionsAdditionIdPatch

  • financeAgreementsIdAdditionsAdditionIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Addition>

  • Update Addition

    Parameters

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

    Returns Promise<Addition>

financeAgreementsIdAdditionsAdditionIdPut

  • financeAgreementsIdAdditionsAdditionIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Addition>

  • Replace Addition

    Parameters

    • params: object
      • addition: Addition
      • additionId: number
      • id: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Addition>

financeAgreementsIdAdditionsCountGet

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

  • Get Additions Count

    Parameters

    • params: object
      • Optional conditions?: string
      • Optional customFieldConditions?: string
      • id: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Count>

financeAgreementsIdAdditionsGet

  • financeAgreementsIdAdditionsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Addition>>

  • Get Additions

    Parameters

    • params: object
      • Optional childconditions?: string
      • Optional conditions?: string
      • Optional customfieldconditions?: string
      • id: number
      • Optional orderBy?: string
      • Optional page?: number
      • Optional pageSize?: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Array<Addition>>

financeAgreementsIdAdditionsPost

  • financeAgreementsIdAdditionsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Addition>

  • Create Addition

    Parameters

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

    Returns Promise<Addition>

Generated using TypeDoc