| Endpoint | Permission | Notes |
|---|
GET /masterdata/getTaxes/{gtimeStamp?} | any role | Returns Tax[] (your defaults plus custom taxes). |
GET /masterdata/getTax/{taxId} | Tax · Read | |
POST /masterdata/upsertTax | Tax · Write | Body: a Tax. taxId, taxName, taxPct are required. Tax names must be unique. Response: { "tax": {...}, "status": "Inserted" | "Updated" | "No changes" }. |
DELETE /masterdata/deleteTax/{taxId} | Tax · Full | A tax already used in transactions cannot be deleted (409). |
Data model
Only the commonly used properties are listed. Unless marked required, every property is optional. Properties that the server sets itself (bizId, createdBy, modifiedBy, app, and creation/modification timestamps) should be left out of requests. The OpenAPI document has the complete definitions.
Tax
| Property | Type | Notes |
|---|
taxId | string | Required. |
taxName | string | Required. Unique within the business. |
taxPct | number | Required. Percentage, for example 18. |
taxType | string | TaxCode or TaxGroup. |
isTaxGroup | boolean | |
subTaxes | object[] | Components of a tax group, each with taxName and taxPct. |
compoundFlg | boolean | Compound tax. |
taxAcct, taxPayableAcct, inputTaxAccount, outputTaxAccount | string | Account IDs. |
intraTax, interTax, taxCredit | boolean | India intra-/inter-state and credit flags. |