https://api.paydoss.com/docs/assets/js/24e439be.84566e42.js

1"use strict";(self.webpackChunkapi_docs_template=self.webpackChunkapi_docs_template||[]).push([[3913],{13001:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>f,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>n,toc:()=>g});const n=JSON.parse('{"id":"show-the-annual-leave-entitlement-of-a-single-employee","title":"Show the annual leave entitlement of a single employee","description":"Returns the entitlement rows of one employee together with the leave records that consumed them.","source":"@site/docs/show-the-annual-leave-entitlement-of-a-single-employee.api.mdx","sourceDirName":".","slug":"/show-the-annual-leave-entitlement-of-a-single-employee","permalink":"/docs/show-the-annual-leave-entitlement-of-a-single-employee","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"show-the-annual-leave-entitlement-of-a-single-employee","title":"Show the annual leave entitlement of a single employee","description":"Returns the entitlement rows of one employee together with the leave records that consumed them.","sidebar_label":"Show the annual leave entitlement of a single employee","hide_title":true,"hide_table_of_contents":true,"api":"eJzNWOtu2zYUfhWCf9piiiM7dtrqX4a2W4dhKHrBfhSBQYvHFhuK1Mgjp5qhZ9lb7AWGvddwKF9kW74k6IYBAYJE5/LxXD4engVHMfM8+cx/BjEHfhtxCT51qk

1BlDU/4e8DSGc8wAwYGFWrIwSBz9t4zO2XWAIO80LYCYGhngBk4dq8wCyqarDIHqXWSjAhkqTW+zEHS97zHI14IJ3JAcIRjwY3IgSdcSR5xRRAKgRnfxfV65fPtKx5xB7+VyoHkCboSIu7TDHLBkwXHqgjWDMIMHI84fBV5oYEnL0ej67qO1g4rEG7l8rcSXLXn843SCG4/DMJIVnoxA88mFRNp6kqh2dLeBtpUaH8mtkE8GLWxWaOrcenFRMNxiE26GMnv4wzhFw6Yscjga0GwAniPSmuWUaoEmwgtTApnQZ9Yq0GYNnRKQF3fkrYvrPHgSX4Qx/RrG+yNMRSopkbaaCWgUJpHPLUGwSCpiqLQKhWkevnFk/6ihadwtgCHqvHmUWDpWzg9OmVmbZjcl2kK3vM64lJgh5FVVY+VPKOQoo28scfl+4Or4SjiptQ6JLQJWcvAtNR63GT+2Al+splhryzQEUQI5TiE8iTg/nX8ssP/vXV3yszGoXCPGrjq0PYoHJK6FAhjOx03x8mX6Tt8jLjfi697g3jQ5x1m0aLQY6G1TQWCHEtRtRNrynyy0zov1lrohPFTcO4cvf5arfRnyW8UHORCmebsp7Se1xFvGvkM4SFVRdOnp6WvSHjTRG1h4ZwgrlAIud+v9JP1EtNZT5fFIB4Ml3X0yCL6FmW8ZSOE43j9LVmouf8OFXao6jPreNhlBYw8w8ZVvxePyMao0waVQvUQM8+7zCg/XhbVcSYPpN/IL6+e08Qf8f1W3bmhxP2K6yUjETa1LswKOxfn4Q6Pu3ii1evKHPD9itylwjkFktk5ODZ1NmeFg7mypWcFOGWlZ8qgZZgpT/fmMSj9Hc+2xIe5XjlpXAqmBU0YDY5jjuOW4wNBJmfVRXCViyJid1CBpAHF29KlsOfETr5Aim0ndG0PhhehHJN+vea77hNuJ559x7pSciyt/Y60bnHxtr8NFnbBupLALtgOMx/xPuxw/hBej0N4tiJZN1Q/gw7wNymqObCnxpoLB9PSSJDPlqNxkFnNzBvMJ0j8TM6k2eO6xea7sDYtGHoyxPEeHDAJskwRZKjbDarD18B51+jwAQw7GPTiF4EdWRwn4efxVDsYrY0NrpLRy05jHTntTPOeUB3xYdzfD/AnI0rMrFO/g/x351twzjoaDXPwVITHpbdwUQxJe5xa+UC9ZnJvQzsZpav9KK0fd/RQmdrSSKZMc0eUmNHtEYiGpTYvhKn+T4Hch957SDxX6r9YfEPKj4gpNRSkpVNYhff0BIQDd1NixpPPt/QyywEzK3nCZ4Dh/U2f+OW8f9nMTheBSy7aw+TlQsmak2U3Xz3US6d5wjPEwieXl6JQvUJU0nrfSwND7FDLu7eMNAjACt8HSkuTiTbK9TnJ9p6h74MkQ3sHhikNrAK8UxqMVC6HHvsRhAT3RLAnN8vSDLWQsKXiImjWT9jff8CdVkYCm/31p5HglM5BK6kcbSUaQG+sywXSY+vXj3z5AA7zT/gaMqDMtHnwNaMmf9cEgd28e7uHvfWNSZuWFFtyRjFtJPq9uNenrBfWYy5C9S6XAB8ye980waF3s50ywbwyM71ZyuxiWGx65b9Y7iwzifAVLwstlKGzhcpZLAvvM5/Ty+9g6fGIJ0rSZiqzHkl+sZgID5+crmv6d7MJoYqUKsypm4XFwZM/apXTeZY7qDbLo7nQJYlw2t2cj+abbm2OoNxeI23A3tIfTjUX34Pi+PT9ckf0jG1v5DpRrCaZQNlr9yt0SvL6to54Fho4AGk+3KQpFNhS2aP4LVb74TW1qtimkmXDrvo6WO+Es1g0Eh8DS9RrdIE1CGBd/wOHgFSx","sidebar_class_name":"get api-method","info_path":"paydoss-api","custom_edit_url":null},"sidebar":"docs-1.0.1","previous":{"title":"List leaves by date range","permalink":"/docs/list-leaves-by-date-range"},"next":{"title":"Reports","permalink":"/docs/reports"}}');var l=a(74848),r=a(28453),i=a(57742),p=a.n(i),s=a(78178),o=a.n(s),m=a(19624),d=a.n(m),y=a(96226),h=a.n(y),c=(a(77675),a(19365),a(51107));const u={id:"show-the-annual-leave-entitlement-of-a-single-employee",title:"Show the annual leave entitlement of a single employee",description:"Returns the entitlement rows of one employee together with the leave records that consumed them.",sidebar_label:"Show the annual leave entitlement of a single employee",hide_title:!0,hide_table_of_contents:!0,api:"eJzNWOtu2zYUfhWCf9piiiM7dtrqX4a2W4dhKHrBfhSBQYvHFhuK1Mgjp5qhZ9lb7AWGvddwKF9kW74k6IYBAYJE5/LxXD4engVHMfM8+cx/BjEHfhtxCT51qk

1BlDU/4e8DSGc8wAwYGFWrIwSBz9t4zO2XWAIO80LYCYGhngBk4dq8wCyqarDIHqXWSjAhkqTW+zEHS97zHI14IJ3JAcIRjwY3IgSdcSR5xRRAKgRnfxfV65fPtKx5xB7+VyoHkCboSIu7TDHLBkwXHqgjWDMIMHI84fBV5oYEnL0ej67qO1g4rEG7l8rcSXLXn843SCG4/DMJIVnoxA88mFRNp6kqh2dLeBtpUaH8mtkE8GLWxWaOrcenFRMNxiE26GMnv4wzhFw6Yscjga0GwAniPSmuWUaoEmwgtTApnQZ9Yq0GYNnRKQF3fkrYvrPHgSX4Qx/RrG+yNMRSopkbaaCWgUJpHPLUGwSCpiqLQKhWkevnFk/6ihadwtgCHqvHmUWDpWzg9OmVmbZjcl2kK3vM64lJgh5FVVY+VPKOQoo28scfl+4Or4SjiptQ6JLQJWcvAtNR63GT+2Al+splhryzQEUQI5TiE8iTg/nX8ssP/vXV3yszGoXCPGrjq0PYoHJK6FAhjOx03x8mX6Tt8jLjfi697g3jQ5x1m0aLQY6G1TQWCHEtRtRNrynyy0zov1lrohPFTcO4cvf5arfRnyW8UHORCmebsp7Se1xFvGvkM4SFVRdOnp6WvSHjTRG1h4ZwgrlAIud+v9JP1EtNZT5fFIB4Ml3X0yCL6FmW8ZSOE43j9LVmouf8OFXao6jPreNhlBYw8w8ZVvxePyMao0waVQvUQM8+7zCg/XhbVcSYPpN/IL6+e08Qf8f1W3bmhxP2K6yUjETa1LswKOxfn4Q6Pu3ii1evKHPD9itylwjkFktk5ODZ1NmeFg7mypWcFOGWlZ8qgZZgpT/fmMSj9Hc+2xIe5XjlpXAqmBU0YDY5jjuOW4wNBJmfVRXCViyJid1CBpAHF29KlsOfETr5Aim0ndG0PhhehHJN+vea77hNuJ559x7pSciyt/Y60bnHxtr8NFnbBupLALtgOMx/xPuxw/hBej0N4tiJZN1Q/gw7wNymqObCnxpoLB9PSSJDPlqNxkFnNzBvMJ0j8TM6k2eO6xea7sDYtGHoyxPEeHDAJskwRZKjbDarD18B51+jwAQw7GPTiF4EdWRwn4efxVDsYrY0NrpLRy05jHTntTPOeUB3xYdzfD/AnI0rMrFO/g/x351twzjoaDXPwVITHpbdwUQxJe5xa+UC9ZnJvQzsZpav9KK0fd/RQmdrSSKZMc0eUmNHtEYiGpTYvhKn+T4Hch957SDxX6r9YfEPKj4gpNRSkpVNYhff0BIQDd1NixpPPt/QyywEzK3nCZ4Dh/U2f+OW8f9nMTheBSy7aw+TlQsmak2U3Xz3US6d5wjPEwieXl6JQvUJU0nrfSwND7FDLu7eMNAjACt8HSkuTiTbK9TnJ9p6h74MkQ3sHhikNrAK8UxqMVC6HHvsRhAT3RLAnN8vSDLWQsKXiImjWT9jff8CdVkYCm/31p5HglM5BK6kcbSUaQG+sywXSY+vXj3z5AA7zT/gaMqDMtHnwNaMmf9cEgd28e7uHvfWNSZuWFFtyRjFtJPq9uNenrBfWYy5C9S6XAB8ye980waF3s50ywbwyM71ZyuxiWGx65b9Y7iwzifAVLwstlKGzhcpZLAvvM5/Ty+9g6fGIJ0rSZiqzHkl+sZgID5+crmv6d7MJoYqUKsypm4XFwZM/apXTeZY7qDbLo7nQJYlw2t2cj+abbm2OoNxeI23A3tIfTjUX34Pi+PT9ckf0jG1v5DpRrCaZQNlr9yt0SvL6to54Fho4AGk+3KQpFNhS2aP4LVb74TW1qtimkmXDrvo6WO+Es1g0Eh8DS9RrdIE1CGBd/wOHgFSx",sidebar_class_name:"get api-method",info_path:"paydoss-api",custom_edit_url:null},x=void 0,f={},g=[];function w(e){const t={p:"p",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(c.default,{as:"h1",className:"openapi__heading",children:"Show the annual leave entitlement of a single employee"}),"\n",(0,l.jsx)(p(),{method:"get",path:"/v1/annual-leave-entitlements/{id}",context:"endpoint"}),"\n",(0,l.jsx)(t.p,{children:"Returns the entitlement rows of one employee together with the leave records that consumed them."}),"\n",(0,l.jsx)(c.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,l.jsx)(o(),{parameters:[{name:"id",in:"path",description:"Employee ID",required:!0,schema:{type:"integer",example:9556}},{name:"year",in:"query",description:"Filter entitlement rows and usages by accrual year",required:!1,schema:{type:"integer",example:2025}},{name:"only_usable",in:"query",description:"Return only entitlement rows that are not expired and still have a balance",required:!1,schema:{type:"boolean",example:!0}}]}),"\n",(0,l.jsx)(d(),{title:"Body",body:void 0}),"\n",(0,l.jsx)(h(),{id:void 0,label:void 0,responses:{200:{description:"Annual leave entitlement detail",content:{"application/json":{schema:{properties:{status:{type:"string",example:"success"},data:{properties:{employee_id:{type:"integer",example:9556},employee_no:{type:"integer",example:12345,nullable:!0},employee_full_name:{type:"string",example:"John Doe"},annual_leave_id:{type:"integer",example:1609,nullable:!0},working_year:{type:"integer",example:3,nullable:!0},starting_date_of_employment:{type:"string",example:"01.06.2021",nullable:!0},total_allocated_days:{type:"number",example:28},total_transferred_days:{type:"number",example:1},total_used_days:{type:"number",example:11},total_remaining_days:{type:"number",example:17},usable_days:{type:"number",example:14},expired_days:{type:"number",example:3},entitlements:{type:"array",items:{properties:{id:{type:"integer",example:101},year:{type:"integer",example:2024},work_year:{type:"integer",example:3,nullable:!0},annual_leave_id:{type:"integer",example:1609,nullable:!0},annual_leave_title:{type:"string",example:"Annual Leave",nullable:!0},start_date:{type:"string",example:"01.06.2024",nullable:!0},end_date:{type:"string",example:"31.05.2025",nullable:!0},expiry_date:{type:"string",example:"31.05.2027",nullable:!0},is_expired:{type:"boolean",example:!1},is_usable:{type:"boolean",example:!0},allocated_days:{description:"Raw entitled days for the accrual year",type:"number",example:20,nullable:!0},transferred_in_days:{description:"Days carried over from previous periods into this row",type:"number",example:1},transferred_out_days:{description:"Days carried over from this row into a later period",type:"number",example:0},transfers:{description:"Raw carry-over map, keyed by source period",type:"object",example:{"2024-2025":1}},total_days:{description:"allocated_days + transferred_in_days",type:"number",example:21,nullable:!0},used_days:{description:"total_days - transferred_out_days - remaining_days",type:"number",example:4,nullable:!0},remaining_days:{type:"number",example:10}},type:"object"}},usages:{description:"Active (non-refunded) consumption records",type:"array",items:{properties:{leave_id:{type:"integer",example:123456},year:{description:"Accrual year the days were deducted from",type:"integer",example:2024},used_days:{type:"number",example:4},start_date:{type:"string",example:"22.08.2025 00:00:00",nullable:!0},end_date:{type:"string",example:"25.08.2025 23:59:00",nullable:!0}},type:"object"}}},type:"object"}},type:"object"}}}},401:{description:"Unauthorized",content:{"application/json":{schema:{properties:{status:{type:"string",example:"error"},message:{type:"string",example:"Unauthorized"},error_code:{type:"string",example:"Unauthorized"},details:{type:"object"}},type:"object"}}}}

1,403:{description:"Employee not found in the authenticated company",content:{"application/json":{schema:{properties:{status:{type:"string",example:"error"},message:{type:"string",example:"Employee not found."},error_code:{type:"string",example:"EmployeeNotFound"},details:{type:"object"}},type:"object"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(w,{...e})}):w(e)}}}]);