UpdateSalaryComponent

PUT

https://api.upbooks.io/api/v1/salary-component/{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

groupName

string

required

salaryCalculationMode

enum<string>

optional

Allowed values:

month-dayswork-days

sandwichLeaves

boolean

optional

components

array [object {10}]

required

custom

boolean | null

optional

formula

string | null

optional

value

object | null

optional

isActive

boolean

required

isIncludedInCTC

boolean

required

isAttendanceBased

boolean

required

isTaxable

boolean

required

type

enum<string>

required

Allowed values:

EARNINGSSTATUTORY

code

enum<string>

required

Allowed values:

BASICALLOWANCEPFPTEPFESIEESI

name

string

required

Example

{
    "groupName": "string",
    "salaryCalculationMode": "month-days",
    "sandwichLeaves": true,
    "components": [
        {
            "custom": true,
            "formula": "string",
            "value": {
                "amount": 0,
                "currency": {
                    "name": "string",
                    "symbol": "string"
                }
            },
            "isActive": true,
            "isIncludedInCTC": true,
            "isAttendanceBased": true,
            "isTaxable": true,
            "type": "EARNINGS",
            "code": "BASIC",
            "name": "string"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.upbooks.io/api/v1/salary-component/' \
--header 'ORGANIZATION-ID: 00000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "groupName": "string",
    "salaryCalculationMode": "month-days",
    "sandwichLeaves": true,
    "components": [
        {
            "custom": true,
            "formula": "string",
            "value": {
                "amount": 0,
                "currency": {
                    "name": "string",
                    "symbol": "string"
                }
            },
            "isActive": true,
            "isIncludedInCTC": true,
            "isAttendanceBased": true,
            "isTaxable": true,
            "type": "EARNINGS",
            "code": "BASIC",
            "name": "string"
        }
    ]
}'

Responses

🟢200Ok

application/json

Body

data

object (SalaryComponentDocumentJSON)

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organization

object (ICommonOrganization)

required

groupName

string

required

components

array[object (ISalaryComponentSettings) {12}]

required

isDeleted

boolean

required

salaryCalculationMode

optional

sandwichLeaves

boolean | null

optional

message

string

optional

Example

{
    "data": {
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "__v": 0,
        "_id": "string",
        "organization": {
            "id": "string",
            "organizationId": "string",
            "name": "string",
            "state": "string"
        },
        "groupName": "string",
        "components": [
            {
                "name": "string",
                "code": "BASIC",
                "type": "EARNINGS",
                "isTaxable": true,
                "isAttendanceBased": true,
                "isIncludedInCTC": true,
                "isActive": true,
                "_id": "string",
                "value": {
                    "amount": 0,
                    "currency": {
                        "name": "string",
                        "symbol": "string"
                    }
                },
                "formula": "string",
                "custom": true,
                "salaryComponentId": "string"
            }
        ],
        "isDeleted": true,
        "salaryCalculationMode": "month-days",
        "sandwichLeaves": true
    },
    "message": "string"
}

🟢200Success

Modified at 2024-04-15 09:48:02

GetSalaryComponent

DeleteSalaryComponent