Pricing_api.TaxRateApi.md

saasus-sdk / Pricing/api / TaxRateApi

Class: TaxRateApi

Pricing/api.TaxRateApi

TaxRateApi - object-oriented interface

Export

TaxRateApi

Hierarchy

• BaseAPI

  ↳ TaxRateApi

Table of contents

Constructors

• constructor

Properties

• axios
• basePath
• configuration

Methods

• createTaxRate
• getTaxRates
• updateTaxRate

Constructors

constructor

• new TaxRateApi(configuration?, basePath?, axios?): TaxRateApi

Parameters

Name	Type	Default value
configuration?	Configuration	undefined
basePath	string	BASE_PATH
axios	AxiosInstance	globalAxios

Returns

TaxRateApi

Inherited from

BaseAPI.constructor

Defined in

src/generated/Pricing/base.ts:52

Properties

axios

• Protected axios: AxiosInstance = globalAxios

Inherited from

BaseAPI.axios

Defined in

src/generated/Pricing/base.ts:52

---

basePath

• Protected basePath: string = BASE_PATH

Inherited from

BaseAPI.basePath

Defined in

src/generated/Pricing/base.ts:52

---

configuration

• Protected configuration: undefined | Configuration

Inherited from

BaseAPI.configuration

Defined in

src/generated/Pricing/base.ts:50

Methods

createTaxRate

▸ createTaxRate(body?, options?): Promise<AxiosResponse<TaxRate, any>>

Creates a tax rate.

Parameters

Name	Type	Description
body?	TaxRateProps
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<TaxRate, any>>

Summary

Create Tax Rate

Throws

Memberof

TaxRateApi

Defined in

src/generated/Pricing/api.ts:4595

---

getTaxRates

▸ getTaxRates(options?): Promise<AxiosResponse<TaxRates, any>>

Get all Tax Rates

Parameters

Name	Type	Description
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<TaxRates, any>>

Summary

Get Tax Rates

Throws

Memberof

TaxRateApi

Defined in

src/generated/Pricing/api.ts:4606

---

updateTaxRate

▸ updateTaxRate(taxRateId, updateTaxRateParam?, options?): Promise<AxiosResponse<void, any>>

Update tax rate.

Parameters

Name	Type	Description
taxRateId	string	Tax Rate ID
updateTaxRateParam?	UpdateTaxRateParam
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Summary

Update Tax Rate

Throws

Memberof

TaxRateApi

Defined in

src/generated/Pricing/api.ts:4619