Taxes
A tax entity allows you to maintain details of a tax.(Not supported for US Version)
End Points
Create a tax
Retrieve list of taxes
Update details of a tax
Retrieve details of a tax
Delete a tax
Retrieve details of a tax group
Attribute
tax_id
long
Unique ID for tax generated by the server. This is used as an identifier.
tax_name
string
Name of the tax.
tax_percentage
double
Tax percentage.
tax_type
string
Type of tax. Possible values are
tax
or compound_tax
or tax_group
. is_value_added
boolean
🇨🇦
Canada
only
Whether it is a value added tax. It can either be
true
or false
. tax_authority_id
long
🇨🇦
Canada
only
Unique Id of the Tax Agency.
tax_authority_name
string
🇨🇦
Canada
only
Name of the Tax Agency.
Create a tax
Create a tax.
Arguments
tax_name
string
(Required)
Name of the tax.
tax_percentage
double
(Required)
Tax percentage.
tax_type
string
Type of tax. Possible values are
tax
or compound_tax
or tax_group
. is_value_added
boolean
🇨🇦
Canada
only
Whether it is a value added tax. It can either be
true
or false
. tax_authority_name
string
(Required)
🇨🇦
Canada
only
Name of the Tax Agency.
Retrieve list of taxes
Details of all existing taxes.
Update details of a tax
Update the details of an existing tax.
Arguments
tax_name
string
Name of the tax.
tax_percentage
double
Tax percentage.
tax_type
string
Type of tax. Possible values are
tax
or compound_tax
or tax_group
. is_value_added
boolean
🇨🇦
Canada
only
Whether it is a value added tax. It can either be
true
or false
.Retrieve details of a tax
Details of an existing tax.
Delete a tax
Delete an existing tax.
Retrieve details of a tax group
Details of an existing tax group.