Add a deduction type

curl --request POST \
  --url https://api.panoflow.io/v1/payroll/deduction-types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Union dues",
  "kind": "fixed",
  "applies_to": "selected_people",
  "remits_to": "Transport Workers Union"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Union dues',
    kind: 'fixed',
    applies_to: 'selected_people',
    remits_to: 'Transport Workers Union'
  })
};

fetch('https://api.panoflow.io/v1/payroll/deduction-types', 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"

payload = {
    "name": "Union dues",
    "kind": "fixed",
    "applies_to": "selected_people",
    "remits_to": "Transport Workers Union"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "ded_01J2VYZ04SXWF6E996X5208E2K",
  "object": "deduction_type",
  "created_at": "2026-10-28T12:00:00Z",
  "updated_at": "2026-10-28T12:00:00Z",
  "name": "Union dues",
  "kind": "fixed",
  "how": "Same amount each month",
  "applies_to": "selected_people",
  "remits_to": "Transport Workers Union",
  "enabled": true,
  "custom": true,
  "people_count": 0
}

{
  "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

Add a deduction type

Custom types can be fixed, percentage or loan. The built-in types (PAYE tax table, pension, NHF, staff loan, salary advance, cooperative savings) exist for every business and cannot be created. A type that applies_to: everyone is taken from everyone from the next run (percentage only; a fixed amount or loan for everyone must be added per person).

A fixed amount or loan with applies_to: everyone is 400 parameter_invalid (param: applies_to).

Error codes: invalid_api_key, parameter_invalid, parameter_missing, scope_missing, csrf_token_invalid, idempotency_key_reused, rate_limited.

POST

payroll

deduction-types

Add a deduction type

curl --request POST \
  --url https://api.panoflow.io/v1/payroll/deduction-types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Union dues",
  "kind": "fixed",
  "applies_to": "selected_people",
  "remits_to": "Transport Workers Union"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Union dues',
    kind: 'fixed',
    applies_to: 'selected_people',
    remits_to: 'Transport Workers Union'
  })
};

fetch('https://api.panoflow.io/v1/payroll/deduction-types', 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"

payload = {
    "name": "Union dues",
    "kind": "fixed",
    "applies_to": "selected_people",
    "remits_to": "Transport Workers Union"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "ded_01J2VYZ04SXWF6E996X5208E2K",
  "object": "deduction_type",
  "created_at": "2026-10-28T12:00:00Z",
  "updated_at": "2026-10-28T12:00:00Z",
  "name": "Union dues",
  "kind": "fixed",
  "how": "Same amount each month",
  "applies_to": "selected_people",
  "remits_to": "Transport Workers Union",
  "enabled": true,
  "custom": true,
  "people_count": 0
}

{
  "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

Idempotency-Key

string

Optional on non-money POSTs; honoured when sent.

Required string length: 1 - 255

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

Body

application/json

name

string

required

Shown on payslips.

Required string length: 1 - 60

kind

enum<string>

required

Kinds a custom type can be.

Available options:

fixed,

percentage,

loan

applies_to

enum<string>

required

everyone is only allowed for percentage.

Available options:

everyone,

selected_people

rate_bps

integer

Required for percentage (250 = 2.5%).

Required range: 0 <= x <= 10000

base

enum<string>

Required for percentage.

Available options:

basic,

basic_housing_transport,

gross

remits_to

string

Where the money goes, listed on the run report. Omit if it stays in the business (e.g. a loan repayment).

Maximum string length: 120

Response

The new deduction 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

Add a deduction type

Authorizations

Headers

Body

Response