UpdateLeave

PUT

https://api.upbooks.io/api/v1/leaves-configuration/{id}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Body Params application/json

title

string

required

isDefault

boolean

required

type

enum<string>

required

Allowed values:

one-timemonthlyquartelybi-annuallyannually

noOfLeaves

number <double>

required

isCarryForward

boolean

required

cutoffDate

number <double>

required

sandwhichPolicy

object (ICommonEnabledLimit)

required

enabled

boolean

required

limit

number <double> | null

optional

limitType

optional

limitFrequency

optional

addOn

object | null

optional

encashment

object (ICommonEnabledLimit)

required

Example

{
    "title": "string",
    "isDefault": true,
    "type": "one-time",
    "noOfLeaves": 0,
    "isCarryForward": true,
    "cutoffDate": 0,
    "sandwhichPolicy": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
            "per": "count",
            "price": 0,
            "allowed": true
        }
    },
    "encashment": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
            "per": "count",
            "price": 0,
            "allowed": true
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.upbooks.io/api/v1/leaves-configuration/' \
--header 'ORGANIZATION-ID: 00000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "string",
    "isDefault": true,
    "type": "one-time",
    "noOfLeaves": 0,
    "isCarryForward": true,
    "cutoffDate": 0,
    "sandwhichPolicy": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
            "per": "count",
            "price": 0,
            "allowed": true
        }
    },
    "encashment": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
            "per": "count",
            "price": 0,
            "allowed": true
        }
    }
}'

Responses

🟢200Ok

application/json

Body

message

string

required

data

required

Any of

array

totalCount

number <double>

optional

filteredCount

number <double>

optional

Example

{
    "message": "string",
    "data": null,
    "totalCount": 0,
    "filteredCount": 0
}

🟢200Success

Modified at 2024-04-15 09:49:43

DeleteLeave

GetLeave