Tax

Tax represents the sales tax objects set up in your business profile and is widely used when recording transactions.

Type

General entity

Fields

Field name

Type

Writable

Required

Description

code

string

(see below)

The tax code for internal use.

name

string

(see below)

The tax name for display.

description

string

(see below)

The description of the tax.

recoverable

boolean

(see below)

The flag to indicate if this tax is a recoverable tax. Non-recoverable taxes cannot be filed for input tax refund.

compound

boolean

(see below)

The flag to indicate if this tax is a compound tax.

withholding

boolean

(see below)

The flag to indicate if this tax can be withheld upon payments.

latest_rate

number

(see below)

The latest or current tax rate.

Since creating and updating taxes are not supported by the API, all fields in the tax entity are NOT writable.

Sample

{
"date_created": 1527493328732,
"date_updated": null,
"company_id": "a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1",
"code": "VAT-0",
"name": "Value added tax (0%)",
"description": null,
"recoverable": true,
"compound": false,
"withholding": false,
"latest_rate": 0.00000,
"_id": "61c59f84-4405-48a3-abc4-f0693bb33dd7",
"_links": {
"self": {
"href": "https://api.pymlo.com/v1/businesses/a8ddc6fd-9f34-43c9-a3e2-ecac869cc5f1/setting/taxes/61c59f84-4405-48a3-abc4-f0693bb33dd7"
}
}
}