curl --request POST \
  --url https://api.panoflow.io/v1/payroll/people/{person_id}/deductions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deduction_type_id": "ded_01J53TW8JZ38AYTNJKGGSFKYS7",
  "amount": {
    "amount": 2500000,
    "currency": "NGN"
  },
  "loan_total": {
    "amount": 30000000,
    "currency": "NGN"
  }
}
'

{
  "id": "<string>",
  "object": "person_deduction",
  "created_at": "2026-10-27T08:41:00Z",
  "person_id": "<string>",
  "deduction_type": {
    "id": "<string>",
    "name": "<string>",
    "kind": "tax_table"
  },
  "status": "active",
  "updated_at": "2026-10-27T08:41:00Z",
  "amount": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "loan": {
    "total": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "repaid": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "remaining": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "months_left": 123
  }
}

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

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

People

Add a deduction to a person

Only for deduction types with applies_to: selected_people that are enabled.

fixed: amount each run until removed.
loan: amount each run until loan_total is repaid; the last run takes only what is left, then it completes on its own.
one_off: amount from the next run only, then it completes.
percentage: no amount; the type’s rate and base are used.

Draft runs are recomputed; an approved run including this person goes back to draft. 422 net_pay_negative if it would take their net pay below zero.

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

POST

payroll

people

{person_id}

deductions

curl --request POST \
  --url https://api.panoflow.io/v1/payroll/people/{person_id}/deductions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deduction_type_id": "ded_01J53TW8JZ38AYTNJKGGSFKYS7",
  "amount": {
    "amount": 2500000,
    "currency": "NGN"
  },
  "loan_total": {
    "amount": 30000000,
    "currency": "NGN"
  }
}
'

{
  "id": "<string>",
  "object": "person_deduction",
  "created_at": "2026-10-27T08:41:00Z",
  "person_id": "<string>",
  "deduction_type": {
    "id": "<string>",
    "name": "<string>",
    "kind": "tax_table"
  },
  "status": "active",
  "updated_at": "2026-10-27T08:41:00Z",
  "amount": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "loan": {
    "total": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "repaid": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "remaining": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "months_left": 123
  }
}

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

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

Path Parameters

person_id

string

required

Payroll person id (ppl_…).

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

Body

application/json

deduction_type_id

string

required

ded_… with applies_to: selected_people.

amount

object

Per run. Required for fixed, loan and one_off; omitted for percentage.

Show child attributes

loan_total

object

Required for loan; at least amount.

Show child attributes

Response

The person deduction.

A deduction added to one person (pdd_…).

string

required

pdd_…

object

string

required

Always person_deduction.

Allowed value: "person_deduction"

created_at

string<date-time>

required

RFC 3339, UTC.

Example:

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

person_id

string

required

ppl_…

deduction_type

object

required

The type.

Show child attributes

status

enum<string>

required

completed when a loan is repaid or a one-off has been taken; removed by you or on offboarding.

Available options:

active,

completed,

removed

updated_at

string<date-time>

RFC 3339, UTC.

Example:

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

amount

object

Per run, for fixed, loan and one-off.

Show child attributes

loan

object

For loans.

Show child attributes

Accounts & transactions

Payments

Collections

Payroll

Approvals

Webhooks & events

OAuth

Add a deduction to a person

Authorizations

Headers

Path Parameters

Body

Response