GET
/
v1
/
pay
/
cycles
/
{id}
/
deductions
Show pay cycle summary
curl --request GET \
  --url https://api.onsi.com/v1/pay/cycles/{id}/deductions \
  --header 'x-api-key: <api-key>'
{
  "deductions": [
    {
      "memberId": "mem_<id>",
      "total": {
        "currency": "GBP",
        "amount": 1000
      }
    }
  ],
  "total": 1,
  "skip": 0,
  "take": 50
}

This endpoint returns a list of all members who have withdrawn during this pay cycle. Members who have not withdrawn will not be included in the response.

For each member we provide a total of the deductions made during this pay cycle.

For example:

  • Bob makes 2 £100 withdrawals during the pay cycle.
  • Jane made no withdrawals during the pay cycle.
{
  "deductions": [
    {
      "memberId": "mem_bob",
      "total": {
        "amount": 20000,
        "currency": "GBP"
      }
    }
  ]
}
// members with no withdrawals will not be included in the response

We have written a guide for end of cycle processing for your pay cycle, which will walk through the recommended sequencing of calls to this endpoint.

Ensure that you have checked the pay cycle is Closed before processing any payroll deductions using this endpoint - Otherwise withdrawals may still be made.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

The unique identifier for a PayCycle, prefixed with pc_

Example:

"pc_<id>"

Query Parameters

​
skip
number
default:0
required
​
take
number
default:50
required

Response

200 - application/json

200

The response is of type object.