Turn a deduction type on or off, or edit it

curl --request PATCH \
  --url https://api.panoflow.io/v1/payroll/deduction-types/{deduction_type_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": false
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({enabled: false})
};

fetch('https://api.panoflow.io/v1/payroll/deduction-types/{deduction_type_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.panoflow.io/v1/payroll/deduction-types/{deduction_type_id}"

payload = { "enabled": False }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "object": "deduction_type",
  "created_at": "2026-10-27T08:41:00Z",
  "updated_at": "2026-10-27T08:41:00Z",
  "name": "<string>",
  "kind": "tax_table",
  "how": "<string>",
  "applies_to": "everyone",
  "enabled": true,
  "custom": true,
  "people_count": 123,
  "short_name": "<string>",
  "rate_bps": 5000,
  "base": "basic",
  "remits_to": "<string>"
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

Deduction types

Turn a deduction type on or off, or edit it

enabled: false stops it being taken from the next run (for everyone it applies to); person deductions keep their settings and resume when turned back on. name and remits_to can change on any type; rate_bps and base only on custom percentage types. Draft runs are recomputed; approved runs go back to draft.

Changing rate_bps or base on a built-in or non-percentage type is 409 invalid_state.

Error codes: invalid_api_key, parameter_invalid, parameter_missing, resource_not_found, scope_missing, csrf_token_invalid, invalid_state, rate_limited.

PATCH

payroll

deduction-types

{deduction_type_id}

Turn a deduction type on or off, or edit it

curl --request PATCH \
  --url https://api.panoflow.io/v1/payroll/deduction-types/{deduction_type_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": false
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({enabled: false})
};

fetch('https://api.panoflow.io/v1/payroll/deduction-types/{deduction_type_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.panoflow.io/v1/payroll/deduction-types/{deduction_type_id}"

payload = { "enabled": False }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "object": "deduction_type",
  "created_at": "2026-10-27T08:41:00Z",
  "updated_at": "2026-10-27T08:41:00Z",
  "name": "<string>",
  "kind": "tax_table",
  "how": "<string>",
  "applies_to": "everyone",
  "enabled": true,
  "custom": true,
  "people_count": 123,
  "short_name": "<string>",
  "rate_bps": 5000,
  "base": "basic",
  "remits_to": "<string>"
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

X-Request-Id

string

Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always our own req_… id. We log your value with the request as client_request_id, so support can find a request by either id. A longer value is refused with 400 parameter_invalid.

Maximum string length: 128

Path Parameters

deduction_type_id

string

required

Deduction type id (ded_…).

Pattern: ^ded_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json

enabled

boolean

On or off.

name

string

Shown on payslips.

Required string length: 1 - 60

remits_to

string | null

Where the money goes; null for "stays in the business".

Maximum string length: 120

rate_bps

integer

Custom percentage types only.

Required range: 0 <= x <= 10000

base

enum<string>

Custom percentage types only.

Available options:

basic,

basic_housing_transport,

gross

Response

The updated type.

A deduction set up once for the business (ded_…).

string

required

ded_…

object

string

required

Always deduction_type.

Allowed value: "deduction_type"

created_at

string<date-time>

required

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

updated_at

string<date-time>

required

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

name

string

required

Shown on payslips.

kind

enum<string>

required

How a deduction is worked out. tax_table = PAYE from yearly pay and reliefs (built-in only); percentage = rate × base; fixed = same amount each run; loan = same amount each run until a total is repaid; one_off = taken from the next run only (built-in "Salary advance").

Available options:

tax_table,

percentage,

fixed,

loan,

one_off

how

string

required

Human description of how it is worked out.

applies_to

enum<string>

required

Company-wide or added per person.

Available options:

everyone,

selected_people

enabled

boolean

required

Taken from runs when true.

custom

boolean

required

False for built-in types.

people_count

integer

required

People it currently applies to.

short_name

string

Short tag for tables.

rate_bps

integer

For percentage.

Required range: 0 <= x <= 10000

base

enum<string>

For percentage.

Available options:

basic,

basic_housing_transport,

gross

remits_to

string

Where the money goes. Absent when it stays in the business.

Accounts & transactions

Payments

Collections

Payroll

Approvals

Webhooks & events

OAuth

Turn a deduction type on or off, or edit it

Authorizations

Headers

Path Parameters

Body

Response