Class InvoicePaymentsApi

Hierarchy

InvoicePaymentsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new InvoicePaymentsApi(basePath?: string): InvoicePaymentsApi

- Defined in api/api.ts:50316
Parameters
- Optional basePath: string
Returns InvoicePaymentsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

financeInvoicesIdPaymentsGet

financeInvoicesIdPaymentsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Payment>>

- Defined in api/api.ts:50335
Get Payments

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

financeInvoicesIdPaymentsPaymentIdDelete

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

- Defined in api/api.ts:50397
Delete Payment By Id

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

financeInvoicesIdPaymentsPaymentIdGet

financeInvoicesIdPaymentsPaymentIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Payment>

- Defined in api/api.ts:50440
Get Payment By Id

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

financeInvoicesIdPaymentsPaymentIdPatch

financeInvoicesIdPaymentsPaymentIdPatch(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Payment>

- Defined in api/api.ts:50484
Update Payment

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

financeInvoicesIdPaymentsPaymentIdPut

financeInvoicesIdPaymentsPaymentIdPut(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Payment>

- Defined in api/api.ts:50535
Replace Payment

Parameters
- params: object
  - id: number
  - payment: Payment
  - paymentId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Payment>

financeInvoicesIdPaymentsPost

financeInvoicesIdPaymentsPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Payment>

- Defined in api/api.ts:50585
Create Payment

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

Generated using TypeDoc