Function: taxService()
taxService(
client):object
Defined in: service/TaxService.ts:26
Service for managing tax and zone tax code operations
Parameters
client
Returns
createTax()
createTax(
input):Promise<Tax>
Creates a new tax *
Parameters
input
Tax creation input *
Returns
Promise<Tax>
Promise<Tax> The created tax
createZoneTaxCode()
createZoneTaxCode(
input):Promise<ZoneTaxCode>
Creates a new zone tax code *
Parameters
input
Zone tax code creation input *
Returns
Promise<ZoneTaxCode>
Promise<ZoneTaxCode> The created zone tax code
createZoneTaxCodes()
createZoneTaxCodes(
input):Promise<ZoneTaxCode[]>
Creates multiple zone tax codes *
Parameters
input
Array of zone tax code creation inputs *
Returns
Promise<ZoneTaxCode[]>
Promise<ZoneTaxCode[]> Array of created zone tax codes
getTax()
getTax(
id):Promise<Tax>
Retrieves a specific tax *
Parameters
id
string
Tax ID (UUID string) *
Returns
Promise<Tax>
Promise<Tax> Tax data
getTaxes()
getTaxes(
input?):Promise<TaxesResponse>
Retrieves taxes with search criteria *
Parameters
input?
Search input parameters *
Returns
Promise<TaxesResponse>
Promise<TaxesResponse> Taxes response
getZoneTaxCode()
getZoneTaxCode(
id):Promise<ZoneTaxCode>
Retrieves a specific zone tax code *
Parameters
id
number
Zone tax code ID *
Returns
Promise<ZoneTaxCode>
Promise<ZoneTaxCode> Zone tax code data
getZoneTaxCodes()
getZoneTaxCodes(
input?):Promise<ZoneTaxCodeResponse>
Retrieves zone tax codes with search criteria *
Parameters
input?
Search input parameters *
Returns
Promise<ZoneTaxCodeResponse>
Promise<ZoneTaxCodeResponse> Zone tax codes response
updateTax()
updateTax(
variables):Promise<Tax>
Updates an existing tax *
Parameters
variables
Tax update input *
Returns
Promise<Tax>
Promise<Tax> The updated tax
updateZoneTaxCode()
updateZoneTaxCode(
variables):Promise<ZoneTaxCode>
Updates an existing zone tax code *
Parameters
variables
Zone tax code update input *
Returns
Promise<ZoneTaxCode>
Promise<ZoneTaxCode> The updated zone tax code