Tax Type

Supported Formats

json
>>>

GET /api/v2/tax_types.json
Retrieves a list of tax types

Supported Formats

json

Examples

Response Example:

HTTP/1.1 200 OK
{
  "tax_types": [
    {
      "id": 1,
      "name": "Value-added tax",
      "code": "VAT",
      "tax_rate": "10.0",
      "purpose": "purchase",
      "accounting_tax_type": null,
      "created_at": "2022-08-22T19:35:04.000Z",
      "updated_at": "2022-08-23T21:55:46.000Z"
    },
    {
      "id": 2,
      "name": "Goods and services tax",
      "code": "GST",
      "tax_rate": "10.0",
      "purpose": "purchase",
      "accounting_tax_type": null,
      "created_at": "2022-08-22T19:35:04.000Z",
      "updated_at": "2022-08-23T21:55:46.000Z"
    }
  ]
}

Params

Param name Description
limit
optional

The maximum number of records to return.

Default Value: 50

Maximum Value: 250

Validations:

  • Must be a Integer
since_id
optional

Return only tax types with an ID greater than the specified ID.

Validations:

  • Must be a Integer

Returns

Code: 200

Description:

The requested tax type data

Param name Description
id
required

“id”: 808950810

A unique numeric identifier for the tax type.

Validations:

  • Must be a Integer
name
required

“name”: “Value-Added Tax”

The tax type's name.

Validations:

  • Must be a String
code
required

“code”: “VAT”

The tax type's code.

Validations:

  • Must be a String
tax_rate
required

“tax_rate”: “12.0”

The tax type's rate.

Validations:

  • Must be a String
purpose
required

“purpose”: “purchase”

The tax type's purpose.

Validations:

  • Must be a String
accounting_tax_type
required

“accounting_tax_type”: “VAT”

The tax type's accounting tax type.

Validations:

  • Must be a String
created_at
required

“created_at”: “2021-02-05T17:55:46.000Z”

The date and time (ISO 8601 format) when the tax type was created.

Validations:

  • Must be a DateTime
updated_at
required

“updated_at”: “2021-02-09T19:47:30.000Z”

The date and time (ISO 8601 format) when the tax type was last updated.

Validations:

  • Must be a DateTime
>>>

GET /api/v2/tax_types/{tax_type_id}.json
Retrieves a single tax type by ID

Supported Formats

json

Errors

Code Description
404 No tax types found

Examples

Response Example:

HTTP/1.1 200 OK
{
  "id": 1,
  "name": "Value-added tax",
  "code": "VAT",
  "tax_rate": "10.0",
  "purpose": "purchase",
  "accounting_tax_type": null,
  "created_at": "2022-08-22T19:35:04.000Z",
  "updated_at": "2022-08-23T21:55:46.000Z"
}

Params

Param name Description
id
required

The ID of the tax type

Validations:

  • Must be a number.

Returns

Code: 200

Description:

The requested tax type data

Param name Description
id
required

“id”: 808950810

A unique numeric identifier for the tax type.

Validations:

  • Must be a Integer
name
required

“name”: “Value-Added Tax”

The tax type's name.

Validations:

  • Must be a String
code
required

“code”: “VAT”

The tax type's code.

Validations:

  • Must be a String
tax_rate
required

“tax_rate”: “12.0”

The tax type's rate.

Validations:

  • Must be a String
purpose
required

“purpose”: “purchase”

The tax type's purpose.

Validations:

  • Must be a String
accounting_tax_type
required

“accounting_tax_type”: “VAT”

The tax type's accounting tax type.

Validations:

  • Must be a String
created_at
required

“created_at”: “2021-02-05T17:55:46.000Z”

The date and time (ISO 8601 format) when the tax type was created.

Validations:

  • Must be a DateTime
updated_at
required

“updated_at”: “2021-02-09T19:47:30.000Z”

The date and time (ISO 8601 format) when the tax type was last updated.

Validations:

  • Must be a DateTime