API docs
Resources
Project settlements
Settlement of a single project: total hours and amounts, commission and issued invoice details.
GET/settlements/{id}
read:payroll
Project settlement with commission and the linked invoice.
Request · cURL
curl -H "Authorization: Bearer onb_..." \
"https://www.onboardly.work/api/v1/settlements/{id}"Response 200 · JSON
{
"data": {
"id": "uuid", "yearMonth": "2026-06", "status": "approved",
"project": { "id": "uuid", "name": "Paradise Wrocław" },
"client": { "id": "uuid", "name": "PARADISE WROCŁAW", "nip": "7011162299" },
"totalHours": 480.0, "totalAmount": 22280.30,
"prowizjaPct": 19.0, "prowizjaKwota": 4233.26, "totalWithProwizja": 26513.56,
"invoiceNumber": "FV/2026/06/12",
"invoiceIssuedAt": "2026-07-01T09:00:00.000Z",
"approvedAt": "2026-06-30T18:00:00.000Z"
}
}| HTTP | code | Znaczenie |
|---|---|---|
404 | not_found | no settlement in this tenant. |