Class AccountingBatchesApi

Hierarchy

AccountingBatchesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AccountingBatchesApi(basePath?: string): AccountingBatchesApi

- Defined in api/api.ts:10383
Parameters
- Optional basePath: string
Returns AccountingBatchesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

financeAccountingBatchesCountGet

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

- Defined in api/api.ts:10396
Get Batches Count

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

financeAccountingBatchesGet

financeAccountingBatchesGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<AccountingBatch>>

- Defined in api/api.ts:10437
Get Batches

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

financeAccountingBatchesIdDelete

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

- Defined in api/api.ts:10493
Delete Batch By Id

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

financeAccountingBatchesIdExportPost

financeAccountingBatchesIdExportPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GLExport>

- Defined in api/api.ts:10531
Re-export the payload data from an existing batch (RecreateBatch in SOAP)

Parameters
- params: object
  - batchExportParameters: ExportAccountingBatchRequest
  - id: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<GLExport>

financeAccountingBatchesIdGet

financeAccountingBatchesIdGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<AccountingBatch>

- Defined in api/api.ts:10575
Get Batch By Id

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

financeAccountingBatchesPost

financeAccountingBatchesPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GLExport>

- Defined in api/api.ts:10612
Creates the Accounting Batch and updates GL Records (UpdateBatch in SOAP)

Parameters
- params: object
  - accountingBatchParameters: CreateAccountingBatchRequest
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<GLExport>

financeAccountingExportPost

financeAccountingExportPost(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GLExport>

- Defined in api/api.ts:10651
Exports accouting batch payload based on parameters (CreateBatch in SOAP)

Parameters
- params: object
  - batchExportParameters: ExportAccountingBatchRequest
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<GLExport>

Generated using TypeDoc