---
agentTools:
  projectIndex: https://tyms.readme.io/llms.txt
---

# Get Taxes

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Tyms (Sandbox)",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://staging-api.tyms.io/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "secret-key",
        "in": "header",
        "x-default": "sk_2938310299229"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/taxes": {
      "get": {
        "summary": "Get Taxes",
        "description": "",
        "operationId": "taxes",
        "parameters": [
          {
            "name": "secret-key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"success\",\n    \"message\": \"Taxes retrieved successfully\",\n    \"data\": {\n        \"current_page\": 1,\n        \"data\": [\n            {\n                \"uuid\": \"9a67d69695dd454a851398c588466a0d\",\n                \"name\": \"UK Vat\",\n                \"percentage\": 0.1,\n                \"currency\": \"GBP\",\n                \"is_deduction\": false\n            },\n            {\n                \"uuid\": \"dfc4c529912a4a8f9c59f9a78a316ee4\",\n                \"name\": \"Withholding Tax NG\",\n                \"percentage\": 0.1,\n                \"currency\": \"NGN\",\n                \"is_deduction\": true\n            },\n            {\n                \"uuid\": \"401fe3a775ed4302abaf4dc7e830e04c\",\n                \"name\": \"VAT NG\",\n                \"percentage\": 0.075,\n                \"currency\": \"NGN\",\n                \"is_deduction\": false\n            }\n        ],\n        \"first_page_url\": \"http://127.0.0.1:8000/api/v1/taxes?page=1\",\n        \"from\": 1,\n        \"last_page\": 1,\n        \"last_page_url\": \"http://127.0.0.1:8000/api/v1/taxes?page=1\",\n        \"links\": [\n            {\n                \"url\": null,\n                \"label\": \"« Previous\",\n                \"active\": false\n            },\n            {\n                \"url\": \"http://127.0.0.1:8000/api/v1/taxes?page=1\",\n                \"label\": \"1\",\n                \"active\": true\n            },\n            {\n                \"url\": null,\n                \"label\": \"Next »\",\n                \"active\": false\n            }\n        ],\n        \"next_page_url\": null,\n        \"path\": \"http://127.0.0.1:8000/api/v1/taxes\",\n        \"per_page\": 20,\n        \"prev_page_url\": null,\n        \"to\": 3,\n        \"total\": 3\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "success"
                    },
                    "message": {
                      "type": "string",
                      "example": "Taxes retrieved successfully"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "current_page": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "data": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "uuid": {
                                "type": "string",
                                "example": "9a67d69695dd454a851398c588466a0d"
                              },
                              "name": {
                                "type": "string",
                                "example": "UK Vat"
                              },
                              "percentage": {
                                "type": "number",
                                "example": 0.1,
                                "default": 0
                              },
                              "currency": {
                                "type": "string",
                                "example": "GBP"
                              },
                              "is_deduction": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              }
                            }
                          }
                        },
                        "first_page_url": {
                          "type": "string",
                          "example": "http://127.0.0.1:8000/api/v1/taxes?page=1"
                        },
                        "from": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "last_page": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "last_page_url": {
                          "type": "string",
                          "example": "http://127.0.0.1:8000/api/v1/taxes?page=1"
                        },
                        "links": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "url": {},
                              "label": {
                                "type": "string",
                                "example": "« Previous"
                              },
                              "active": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              }
                            }
                          }
                        },
                        "next_page_url": {},
                        "path": {
                          "type": "string",
                          "example": "http://127.0.0.1:8000/api/v1/taxes"
                        },
                        "per_page": {
                          "type": "integer",
                          "example": 20,
                          "default": 0
                        },
                        "prev_page_url": {},
                        "to": {
                          "type": "integer",
                          "example": 3,
                          "default": 0
                        },
                        "total": {
                          "type": "integer",
                          "example": 3,
                          "default": 0
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "66af161f6f18be002a6dc48f:64eef86fc4708a0041f66d0d"
}
```