PrepareSalaryComponents

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

000000

Body Params application/json

componentGroupId

string

required

amount

object

required

gross

number <double> | null

optional

ctc

number <double>

required

currency

object (ICommonCurrency)

required

name

string

required

symbol

string

required

customData

array [object {2}] | null

optional

value

number <double>

required

key

string

required

specialSchemes

array [object {2}] | null

optional

enabled

boolean

required

name

enum<string>

required

Allowed values:

ESIPF

Example

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Ok

application/json

Body

data

object (IPrepareSalaryComponentResponse)

required

components

array[object (IEmployeeSalaryComponent) {13}]

required

final

object

required

message

string

optional

Example

{
  "data": {
    "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",
        "amount": 0
      }
    ],
    "final": {
      "net": 0,
      "gross": 0,
      "ctc": 0
    }
  },
  "message": "string"
}

🟢200Success