MICRO-BASE

tax.update

This method is used to get a list of Taxes.

Version

v2

Arguments

This method has the path /tax/<version>/tax.list and follows the MicroBase API calling conventions.

Argument Required Type Example Description
id yes String List rJGOMDf Tax database identifier.
code no String List default Code to be used as a reference in the Product.
class no String List default Identifier to the implementation code (i.e.: default.js).
title no String VAT 10% Tax description.
description no String Description Tax description.
rate no Number 10 Number to be used in the calculations (i.e.: 10%).
isPercentage no Boolean false Is the tax a percentage or a fixed amount? Defaults to true.
limit no Number 5 Maximum number of documents to return. Defaults to 10
skip no Number 10 Skips over the first specified number of documents. Defaults to 0.

Response

Returns a Tax object:

{
    "ok": true,
    "data": [
        {
            "id": "HJs04P45",
            "code": "default",
            "class": "default",
            "title": "IVA 10%",
            "rate": 10,
            "isPercentage": true
        }
    ]
}

Errors

Expected errors that this method could return. Some errors return additional data.

Error Data Description
validation_error The data causing the error Some validation error

Example

curl --request POST \
  --url http://localhost:3000/services/tax/v1/tax.list \
  --header 'authorization: Bearer xxxxx...' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
      "id": "HJs04P45,GFssj54j" \
      }'

© MicroBase