GetAllSalaryComponents

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

searchText

string

optional

Header Params

pageNo

number <double>

optional

pageSize

number <double>

optional

sortBy

string

optional

Default:

groupName

sortOrder

number <double>

optional

Default:

1

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.upbooks.io/api/v1/salary-component?searchText' \
--header 'pageNo;' \
--header 'pageSize;' \
--header 'sortBy;' \
--header 'sortOrder;' \
--header 'ORGANIZATION-ID: 00000'

Responses

🟢200Ok

application/json

Body

data

array [array]

required

object (SalaryComponentDocumentJSON)

optional

totalCount

number <double>

optional

filteredCount

number <double>

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
            }
        ]
    ],
    "totalCount": 0,
    "filteredCount": 0,
    "message": "string"
}

🟢200Success