PrepareEmployeePayroll

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

employeeId

string

required

employmentId

string

required

month

number <double>

required

year

number <double>

required

paidLeaves

number <double>

required

unpaidLeaves

number <double>

required

totalMonthDays

number <double>

optional

totalWorkingDays

number <double>

optional

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Body Params application/json

deductions

array[object (ICommonKeyValuePair) {2}] | null

optional

key

string | null

required

value

number <double> | null

required

allowances

array[object (ICommonKeyValuePair) {2}] | null

optional

key

string | null

required

value

number <double> | null

required

Example

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Ok

application/json

Body

data

object (IPreparePayrollResponse)

required

employeeId

string

required

employmentId

string

required

totalPayAmount

number <double>

required

currency

optional

month

number <double> | null

required

totalMonthDays

number <double> | null

required

year

number <double> | null

required

processingDate

string <date-time> | null

required

processedById

string | null

required

noOfLeaves

number <double> | null

required

noOfUnpaidLeaves

number <double> | null

required

totalWorkingDays

number <double> | null

required

deductions

array[object (ICommonKeyValuePair) {2}] | null

optional

allowances

array[object (ICommonKeyValuePair) {2}] | null

optional

employersContribution

array[object (ICommonKeyValuePair) {2}] | null

optional

paidVia

string | null

optional

paymentMode

optional

notes

string | null

optional

referenceNumber

string | null

optional

paymentAmount

number <double> | null

optional

calculationDifference

number <double> | null

optional

fileImportData

optional

totalSalary

number <double>

required

message

string

optional

Example

{
  "data": {
    "employeeId": "string",
    "employmentId": "string",
    "totalPayAmount": 0,
    "currency": {
      "name": "string",
      "symbol": "string"
    },
    "month": 0,
    "totalMonthDays": 0,
    "year": 0,
    "processingDate": "2019-08-24T14:15:22Z",
    "processedById": "string",
    "noOfLeaves": 0,
    "noOfUnpaidLeaves": 0,
    "totalWorkingDays": 0,
    "deductions": [
      {
        "key": "string",
        "value": 0
      }
    ],
    "allowances": [
      {
        "key": "string",
        "value": 0
      }
    ],
    "employersContribution": [
      {
        "key": "string",
        "value": 0
      }
    ],
    "paidVia": "string",
    "paymentMode": "cash",
    "notes": "string",
    "referenceNumber": "string",
    "paymentAmount": 0,
    "calculationDifference": 0,
    "fileImportData": {
      "fileImportId": "string",
      "rowId": "string"
    },
    "totalSalary": 0
  },
  "message": "string"
}

🟢200Success