Skip to main content

Class: TaxService

Defined in: service/TaxService.ts:115

Backwards-compatible class form. New code should call taxService(client).

Constructors

Constructor

new TaxService(client): TaxService

Defined in: service/TaxService.ts:117

Parameters

client

GraphQLClient

Returns

TaxService

Methods

createTax()

createTax(input): Promise<Tax>

Defined in: service/TaxService.ts:132

Creates a new tax

Parameters

input

TaxCreateInput

Tax creation input

Returns

Promise<Tax>


createZoneTaxCode()

createZoneTaxCode(input): Promise<ZoneTaxCode>

Defined in: service/TaxService.ts:152

Creates a new zone tax code

Parameters

input

ZoneTaxCodeCreateInput

Zone tax code creation input

Returns

Promise<ZoneTaxCode>


createZoneTaxCodes()

createZoneTaxCodes(input): Promise<ZoneTaxCode[]>

Defined in: service/TaxService.ts:157

Creates multiple zone tax codes

Parameters

input

ZoneTaxCodeCreateInput[]

Array of zone tax code creation inputs

Returns

Promise<ZoneTaxCode[]>


getTax()

getTax(id): Promise<Tax>

Defined in: service/TaxService.ts:122

Retrieves a specific tax

Parameters

id

string

Tax ID (UUID string)

Returns

Promise<Tax>


getTaxes()

getTaxes(input?): Promise<TaxesResponse>

Defined in: service/TaxService.ts:127

Retrieves taxes with search criteria

Parameters

input?

TaxSearchInput

Search input parameters

Returns

Promise<TaxesResponse>


getZoneTaxCode()

getZoneTaxCode(id): Promise<ZoneTaxCode>

Defined in: service/TaxService.ts:142

Retrieves a specific zone tax code

Parameters

id

number

Zone tax code ID

Returns

Promise<ZoneTaxCode>


getZoneTaxCodes()

getZoneTaxCodes(input?): Promise<ZoneTaxCodeResponse>

Defined in: service/TaxService.ts:147

Retrieves zone tax codes with search criteria

Parameters

input?

ZoneTaxCodeSearchInput

Search input parameters

Returns

Promise<ZoneTaxCodeResponse>


updateTax()

updateTax(variables): Promise<Tax>

Defined in: service/TaxService.ts:137

Updates an existing tax

Parameters

variables

TaxUpdateVariables

Tax update input

Returns

Promise<Tax>


updateZoneTaxCode()

updateZoneTaxCode(variables): Promise<ZoneTaxCode>

Defined in: service/TaxService.ts:162

Updates an existing zone tax code

Parameters

variables

ZoneTaxCodeUpdateVariables

Zone tax code update input

Returns

Promise<ZoneTaxCode>