Introduction

Overview How to call Authentication Request Response Pagination Filtering Sorting

API Reference

Tax rules

(ms.tax_rules)

Taxes allows you to set up a number of tax rules that you can charge on your sales.

Fields
EndPoints

Fields

ValueDescription
name   
Type: string
Required
It stores the name of the tax rule.
summary   
Type: string
It stores the summary of the tax rule.
country   
Type: string
Required
It stores the country for which you want to define the tax rule.
inclusive   
Type: string
Enabling the flag makes the taxable amounts are inclusive of taxes. By default, value of the flag's is "1".
1
enable_taxjar   
Type: string
taxjar_settings   
Type: string
Required
api_key
Type: string
Required
testing
Type: string
taxes   
Type: array
Required
It stores the defined taxes of the tax rule.
name
Type: string
Required
It stores the name of the tax.
type
Type: string
value
Type: number
Required
It stores the value of the tax rate.
state_type
Type: string
It stores the type of the states in which the tax is applicable. The tax can be defined either for all states or specific states only or even excluding some specific states.
states
Type: string
Required
It stores the states in which the tax is applicable.
conditions
Type: array
It stores the conditions on which the tax is applicable. The conditions supported are Product prices, HAN or SAC number.
group_tax
Type: string
Enable the flag to group the multiple taxes. By default, value of the flag's is "0".
additional_taxes
Type: array
It stores the additional taxes. Additional charges consists of three fields:  
Name: The name of the additional tax.
Value: Rate of the additional tax.
Apply on: The additional taxes can be applied either to the net amount or tax amount.

Commands (Endpoints)

POST /api/1/entity/ms.tax_rules   
Creates a new tax rule
DEL /api/1/entity/ms.tax_rules/{resource_id}   
Deletes a tax rule
PUT /api/1/entity/ms.tax_rules/{resource_id}   
Updates an existing tax rule
GET /api/1/entity/ms.tax_rules/{resource_id}   
Retrieves a single tax rule
GET /api/1/entity/ms.tax_rules   
Retrieves a list of tax rules