API docs by Redocly

Repzo API - Tax (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Tax endpoints.

Find taxes

query Parameters
object

Query parameters for filtering taxes

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a tax

Request Body schema: application/json
name
required
string

Name of the tax

rate
required
number

Tax rate

type
required
string
Enum: "inclusive" "additive" "N/A"

Type of tax

disabled
boolean

Whether the tax is disabled

object

Integration metadata

company_namespace
Array of strings

Company namespaces

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "rate": 0,
  • "type": "inclusive",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "rate": 0,
  • "type": "inclusive",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a tax by ID

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "rate": 0,
  • "type": "inclusive",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a tax

path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the tax

rate
number

Tax rate

type
string
Enum: "inclusive" "additive" "N/A"

Type of tax

disabled
boolean

Whether the tax is disabled

object

Integration metadata

company_namespace
Array of strings

Company namespaces

_id
string

Unique identifier for the tax

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "rate": 0,
  • "type": "inclusive",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "rate": 0,
  • "type": "inclusive",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a tax

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "rate": 0,
  • "type": "inclusive",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}