Class FinancesInvoicesApiClient

FinancesInvoicesApi - object-oriented interface

Hierarchy (View Summary)

FinancesInvoicesApi
- FinancesInvoicesApiClient

Index

Constructors

Properties

axios basePath configuration

Methods

getInvoice getInvoiceHeaders

Constructors

constructor

new FinancesInvoicesApiClient(
configuration: ClientConfiguration,
): FinancesInvoicesApiClient
Parameters
- configuration: ClientConfiguration
Returns FinancesInvoicesApiClient
Overrides FinancesInvoicesApi.constructor
- Defined in client.ts:8

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

getInvoice

getInvoice(
requestParameters: FinancesInvoicesApiGetInvoiceRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetInvoiceResponse, any, {}, any>>
Returns invoice details, including header and line items, for the specified invoice.
Parameters
- requestParameters: FinancesInvoicesApiGetInvoiceRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetInvoiceResponse, any, {}, any>>

Throws
Inherited from FinancesInvoicesApi.getInvoice
- Defined in api-model/api/finances-invoices-api.ts:271

getInvoiceHeaders

getInvoiceHeaders(
requestParameters: FinancesInvoicesApiGetInvoiceHeadersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetInvoicesResponse, any, {}, any>>
Returns invoice headers for all invoices matching filters that you specify.
Parameters
- requestParameters: FinancesInvoicesApiGetInvoiceHeadersRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetInvoicesResponse, any, {}, any>>

Throws
Inherited from FinancesInvoicesApi.getInvoiceHeaders
- Defined in api-model/api/finances-invoices-api.ts:281