API Taxes

Core principles

This object represents a tax applicable to your transactions. Use it to define and manage taxes to apply to products or services in your system.

Scopes

taxes.read taxes.write

Create a tax

Allows you to create a tax in your system. Requires scope taxes.write.

Request

Request Body

You must provide a request body of type TaxCreateRequest.

Response

Response Body

SBTax

HTTP Status Codes

Code example

import { SBClient, SBTax, TaxCreateRequest } from "@smartbills/sdk"
 
const client = new SBClient();
const request = {
  "name": "VAT",
  "rate": 15.0,
  "description": "Value Added Tax"
};
 
const tax = await client.taxes.create(request);

Retrieve a tax

Retrieve information about a tax in the system. Requires scope taxes.read.

Path Parameter

Response

SBTax

Code example

import { SBClient, SBTax } from "@smartbills/sdk"
 
const client = new SBClient();
const tax = await client.taxes.getByIdAsync(1);

Retrieve a list of taxes

Retrieve a list of taxes registered in the system. Requires scope taxes.read.

Query Parameters

SBListRequest

Response

SBTax

Code example

import { SBClient, SBTax, SBList, SBListRequest } from "@smartbills/sdk"
 
const client = new SBClient();
const request = {
  "page": 1,
  "pageSize": 100
};
 
const taxes = await client.taxes.list(request);

Update a tax

Allows you to update information about a tax in the system. Requires scope taxes.write.

Path Parameter

Request Body

You must provide a request body of type TaxUpdateRequest.

Response

HTTP Status Codes

SBTax

Code example

import { SBClient, SBTax, TaxUpdateRequest } from "@smartbills/sdk"
 
const client = new SBClient();
const request = {
  "name": "VAT Updated",
  "rate": 20.0,
  "description": "Updated Value Added Tax"
};
 
const tax = await client.taxes.updateAsync(1, request);

Delete a tax

Allows you to delete a tax in the system. Requires scope taxes.write.

DELETE https://api.smartbills.io/v1/taxes/:id

Path Parameter

Response

HTTP Status Codes

Code example

import { SBClient, SBTax } from "@smartbills/sdk"
 
const client = new SBClient();
const tax = await client.taxes.deleteAsync(1);