API reference | Tax types

Method	Path	Summary
GET	…/tax-types	List tax types in the workspace
POST	…/tax-types	Create a tax type
PATCH	…/tax-types/{taxTypeId}	Update a tax type
DELETE	…/tax-types/{taxTypeId}	Delete a tax type

Paths start with /workspaces/{workspaceId}. GET endpoints need tax-types:read, the others tax-types:write.

The TaxType object

firestoreIdstringrequired

ID of the tax type.

workspaceIdstringrequired

ID of the workspace.

namestringrequired

descriptionstring

ratenumberrequired

externalIdstringrequired

codestring

Show all 10 fields

ledgerAccountstring

milliRoundingFactornumber

creationobjectrequired

When and by whom the resource was created.

Show 2 child fields

creationDateTimestringdate-timerequired

Date and time when the resource was created.

createdBystring

ID of the user who created the resource, when recorded.

The TaxType object

{
  "firestoreId": "Tt9mC5rL2wQz7nVb4kHp",
  "workspaceId": "Wk7fQ2xR9bLm4tZp8sNv",
  "name": "string",
  "description": "string",
  "rate": 0,
  "externalId": "string",
  "code": "string",
  "ledgerAccount": "string",
  "milliRoundingFactor": 0,
  "creation": {
    "creationDateTime": "2026-03-02T09:15:00.000Z",
    "createdBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
  }
}

GET/workspaces/{workspaceId}/tax-types

List tax types in the workspace

Scopetax-types:read

Path parameters

workspaceIdstringrequired

ID of the workspace.

Query parameters

limitinteger

Maximum number of items to return, from 1 to 100. A missing, invalid or non-positive value falls back to 20, and a larger value to 100.

Default20

startAfterstring

Cursor of the page to return: the nextCursor of the previous page.

fieldsstring

Comma-separated property paths to include in the response, or in each item of a list. Use dots for nested paths.

idsstring[]

Comma-separated IDs of the items to return, up to 30. When set, limit, startAfter and the filters are ignored.

Returns

200

List of items

dataTaxType[]required

Items of the page, in list order.

limitintegerrequired

Page size of the request, or the number of requested ids.

nextCursorstring

Cursor of the next page, to pass as startAfter. Absent when the page holds fewer items than limit; a full last page still has one, and the page it points to is empty.

curl 'https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/tax-types' \
  -H "Authorization: Bearer $SWAY_API_KEY"

const response = await fetch('https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/tax-types', {
  headers: {
    Authorization: `Bearer ${process.env.SWAY_API_KEY}`,
  },
});
console.log(await response.json());

import os

import requests

response = requests.get(
    "https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/tax-types",
    headers={"Authorization": f"Bearer {os.environ['SWAY_API_KEY']}"},
)
print(response.json())

{
  "data": [
    {
      "firestoreId": "Tt9mC5rL2wQz7nVb4kHp",
      "workspaceId": "Wk7fQ2xR9bLm4tZp8sNv",
      "name": "string",
      "description": "string",
      "rate": 0,
      "externalId": "string",
      "code": "string",
      "ledgerAccount": "string",
      "milliRoundingFactor": 0,
      "creation": {
        "creationDateTime": "2026-03-02T09:15:00.000Z",
        "createdBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
      }
    }
  ],
  "limit": 0,
  "nextCursor": "string"
}

{
  "error": {
    "code": "invalid-argument",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or expired credentials"
  }
}

{
  "error": {
    "code": "permission-denied",
    "message": "Missing required scope: invoices:read"
  }
}

{
  "error": {
    "code": "not-found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

POST/workspaces/{workspaceId}/tax-types

Create a tax type

Scopetax-types:write

Path parameters

workspaceIdstringrequired

ID of the workspace.

Query parameters

fieldsstring

Comma-separated property paths to include in the response, or in each item of a list. Use dots for nested paths.

Request body

namestringrequired

descriptionstring

ratenumberrequired

externalIdstringrequired

codestring

ledgerAccountstring

milliRoundingFactornumber

Returns

200

Successful response

dataTaxTyperequired

curl -X POST 'https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/tax-types' \
  -H "Authorization: Bearer $SWAY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": "string",
  "rate": 0,
  "externalId": "string",
  "code": "string",
  "ledgerAccount": "string",
  "milliRoundingFactor": 0
}'

const response = await fetch('https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/tax-types', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SWAY_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "string",
    "description": "string",
    "rate": 0,
    "externalId": "string",
    "code": "string",
    "ledgerAccount": "string",
    "milliRoundingFactor": 0
  }),
});
console.log(await response.json());

import os

import requests

response = requests.post(
    "https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/tax-types",
    headers={"Authorization": f"Bearer {os.environ['SWAY_API_KEY']}"},
    json={
        "name": "string",
        "description": "string",
        "rate": 0,
        "externalId": "string",
        "code": "string",
        "ledgerAccount": "string",
        "milliRoundingFactor": 0,
    },
)
print(response.json())

{
  "data": {
    "firestoreId": "Tt9mC5rL2wQz7nVb4kHp",
    "workspaceId": "Wk7fQ2xR9bLm4tZp8sNv",
    "name": "string",
    "description": "string",
    "rate": 0,
    "externalId": "string",
    "code": "string",
    "ledgerAccount": "string",
    "milliRoundingFactor": 0,
    "creation": {
      "creationDateTime": "2026-03-02T09:15:00.000Z",
      "createdBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
    }
  }
}

{
  "error": {
    "code": "invalid-argument",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or expired credentials"
  }
}

{
  "error": {
    "code": "permission-denied",
    "message": "Missing required scope: invoices:read"
  }
}

{
  "error": {
    "code": "not-found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

PATCH/workspaces/{workspaceId}/tax-types/{taxTypeId}

Update a tax type

Scopetax-types:write

Path parameters

workspaceIdstringrequired

ID of the workspace.

taxTypeIdstringrequired

ID of the tax type.

Request body

namestring

descriptionstring | null

ratenumber

externalIdstring

codestring | null

ledgerAccountstring | null

milliRoundingFactornumber | null

Returns

204

No content

curl -X PATCH 'https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/tax-types/Tt9mC5rL2wQz7nVb4kHp' \
  -H "Authorization: Bearer $SWAY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": "string",
  "rate": 0,
  "externalId": "string",
  "code": "string",
  "ledgerAccount": "string",
  "milliRoundingFactor": 0
}'

const response = await fetch('https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/tax-types/Tt9mC5rL2wQz7nVb4kHp', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.SWAY_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "string",
    "description": "string",
    "rate": 0,
    "externalId": "string",
    "code": "string",
    "ledgerAccount": "string",
    "milliRoundingFactor": 0
  }),
});
console.log(response.status);

import os

import requests

response = requests.patch(
    "https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/tax-types/Tt9mC5rL2wQz7nVb4kHp",
    headers={"Authorization": f"Bearer {os.environ['SWAY_API_KEY']}"},
    json={
        "name": "string",
        "description": "string",
        "rate": 0,
        "externalId": "string",
        "code": "string",
        "ledgerAccount": "string",
        "milliRoundingFactor": 0,
    },
)
print(response.status_code)

{
  "error": {
    "code": "invalid-argument",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or expired credentials"
  }
}

{
  "error": {
    "code": "permission-denied",
    "message": "Missing required scope: invoices:read"
  }
}

{
  "error": {
    "code": "not-found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

DELETE/workspaces/{workspaceId}/tax-types/{taxTypeId}

Delete a tax type

Scopetax-types:write

Path parameters

workspaceIdstringrequired

ID of the workspace.

taxTypeIdstringrequired

ID of the tax type.

Returns

204

No content

curl -X DELETE 'https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/tax-types/Tt9mC5rL2wQz7nVb4kHp' \
  -H "Authorization: Bearer $SWAY_API_KEY"

const response = await fetch('https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/tax-types/Tt9mC5rL2wQz7nVb4kHp', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.SWAY_API_KEY}`,
  },
});
console.log(response.status);

import os

import requests

response = requests.delete(
    "https://api.business.swayapp.io/v1/workspaces/Wk7fQ2xR9bLm4tZp8sNv/tax-types/Tt9mC5rL2wQz7nVb4kHp",
    headers={"Authorization": f"Bearer {os.environ['SWAY_API_KEY']}"},
)
print(response.status_code)

{
  "error": {
    "code": "invalid-argument",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or expired credentials"
  }
}

{
  "error": {
    "code": "permission-denied",
    "message": "Missing required scope: invoices:read"
  }
}

{
  "error": {
    "code": "not-found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

Cookies, with your consent

Tax types

The TaxType object

List tax types in the workspace

Path parameters

Query parameters

Returns

Create a tax type

Path parameters

Query parameters

Request body

Returns

Update a tax type

Path parameters

Request body

Returns

Delete a tax type

Path parameters

Returns

Start building on your own data.