Offboard a person

curl --request POST \
  --url https://api.panoflow.io/v1/payroll/people/{person_id}/offboard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "end_date": "2026-11-30",
  "reason": "Resigned"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({end_date: '2026-11-30', reason: 'Resigned'})
};

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

import requests

url = "https://api.panoflow.io/v1/payroll/people/{person_id}/offboard"

payload = {
    "end_date": "2026-11-30",
    "reason": "Resigned"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "<string>",
  "object": "payroll_person",
  "created_at": "2026-10-27T08:41:00Z",
  "updated_at": "2026-10-27T08:41:00Z",
  "name": "<string>",
  "status": "active",
  "start_date": "2026-11-07",
  "bank_account": {
    "bank_code": "058",
    "bank_name": "<string>",
    "account_number_last4": "<string>",
    "account_name": "<string>",
    "verified_at": "2026-10-27T08:41:00Z"
  },
  "pay_items": [
    {
      "type": "basic",
      "name": "<string>",
      "amount": {
        "amount": 45000000,
        "currency": "NGN"
      }
    }
  ],
  "pay": {
    "gross": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "deductions": [
      {
        "deduction_type_id": "<string>",
        "name": "<string>",
        "applies_to_everyone": true,
        "amount": {
          "amount": 45000000,
          "currency": "NGN"
        },
        "person_deduction_id": "<string>",
        "short_name": "<string>",
        "how": "<string>",
        "loan_remaining_after": {
          "amount": 45000000,
          "currency": "NGN"
        }
      }
    ],
    "deduction_total": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "net": {
      "amount": 45000000,
      "currency": "NGN"
    }
  },
  "email": "jsmith@example.com",
  "role": "<string>",
  "team": "<string>",
  "end_date": "2026-11-07",
  "offboarded_at": "2026-10-27T08:41:00Z",
  "metadata": {}
}

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

Offboard a person

Takes the person off payroll from end_date: they are not included in runs whose pay date is after it. Their payslips and history stay; people are never deleted. Active person deductions (e.g. a loan balance) are ended with status removed; any balance left is shown in the response for you to settle outside payroll. Draft runs are recomputed; a pending_approval or scheduled run that included them goes back to draft (changed_after_approval). 409 invalid_state while a run that includes them is processing.

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

POST

payroll

people

{person_id}

offboard

Offboard a person

curl --request POST \
  --url https://api.panoflow.io/v1/payroll/people/{person_id}/offboard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "end_date": "2026-11-30",
  "reason": "Resigned"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({end_date: '2026-11-30', reason: 'Resigned'})
};

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

import requests

url = "https://api.panoflow.io/v1/payroll/people/{person_id}/offboard"

payload = {
    "end_date": "2026-11-30",
    "reason": "Resigned"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "<string>",
  "object": "payroll_person",
  "created_at": "2026-10-27T08:41:00Z",
  "updated_at": "2026-10-27T08:41:00Z",
  "name": "<string>",
  "status": "active",
  "start_date": "2026-11-07",
  "bank_account": {
    "bank_code": "058",
    "bank_name": "<string>",
    "account_number_last4": "<string>",
    "account_name": "<string>",
    "verified_at": "2026-10-27T08:41:00Z"
  },
  "pay_items": [
    {
      "type": "basic",
      "name": "<string>",
      "amount": {
        "amount": 45000000,
        "currency": "NGN"
      }
    }
  ],
  "pay": {
    "gross": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "deductions": [
      {
        "deduction_type_id": "<string>",
        "name": "<string>",
        "applies_to_everyone": true,
        "amount": {
          "amount": 45000000,
          "currency": "NGN"
        },
        "person_deduction_id": "<string>",
        "short_name": "<string>",
        "how": "<string>",
        "loan_remaining_after": {
          "amount": 45000000,
          "currency": "NGN"
        }
      }
    ],
    "deduction_total": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "net": {
      "amount": 45000000,
      "currency": "NGN"
    }
  },
  "email": "jsmith@example.com",
  "role": "<string>",
  "team": "<string>",
  "end_date": "2026-11-07",
  "offboarded_at": "2026-10-27T08:41:00Z",
  "metadata": {}
}

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

end_date

string<date>

required

Last day of employment.

Example:

"2026-11-07"

reason

string

Internal note. Kept in the audit log.

Maximum string length: 500

Response

The person, with status offboarded (or still current until end_date passes, with end_date set).

A person on payroll (ppl_…).

string

required

ppl_…

object

string

required

Always payroll_person.

Allowed value: "payroll_person"

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

Full name.

status

enum<string>

required

active is paid; on_leave is on paid leave and still paid ("On leave, paid"); starting has a start date after today ("Starts 1 Nov"); offboarded is past their end date and never paid again.

Available options:

active,

on_leave,

starting,

offboarded

start_date

string<date>

required

Calendar date, interpreted in Africa/Lagos.

Example:

"2026-11-07"

bank_account

object

required

The person's bank account. Only the last four digits are returned.

Show child attributes

pay_items

object[]

required

Monthly earnings.

Show child attributes

pay

object

required

What the next run would pay, with current deductions (before any one-off bonus).

Show child attributes

string<email>

Where payslips are sent.

Maximum string length: 254

role

string

Job title.

team

string

Team.

end_date

string<date>

Calendar date, interpreted in Africa/Lagos.

Example:

"2026-11-07"

offboarded_at

string<date-time>

RFC 3339, UTC.

Example:

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

metadata

object

Up to 20 string keys (≤ 40 chars) with string values (≤ 500 chars). Returned on the resource and its events.

Show child attributes

Accounts & transactions

Payments

Collections

Payroll

Approvals

Webhooks & events

OAuth

Offboard a person

Authorizations

Headers

Path Parameters

Body

Response