- Auth
- Account Ledger
- Activity Log
- Announcement
- Asset
- Sales
- GetTotalRevenue
- GetTotalReceivables
- GetTotalInwardPayment
- GetTotalOverDuePayment
- SalesRatio
- GetGrowthByMonth
- GetGrowthByQuarter
- GetGrowthByYear
- GetSnapshotReceivables
- GetSalesByInvoiceTypes
- GetIncomeByInvoiceTypes
- GetGstInvoices
- GetRecurringInvoices
- GetClientsAcquired
- GetSalesByMonthGraph
- GetSalesByYearGraph
- GetSalesByProductGraph
- GetSalesByServiceGraph
- GetSalesByClientGraph
- GetSalesByCountryGraph
- GetSalesByUserGraph
- GetRevenueBySource
- GetSalesByRegionGraph
- Client
- Client Ledger
- CreditNote
- Cron-jobs
- Currency Conversion
- Document
- Discount
- Employee
- GetEmployeesByMonth
- GetEmployees
- AddEmployee
- GetEmployeeDetail
- UpdateEmployee
- DeleteEmployee
- FileImport
- UpdateSalaryComponent
- UpdateFileUrl
- UpdateInvoiceNumber
- PrepareSalaryComponents
- UpdateEmployeeName
- UpdateEmployeeEmail
- UpdateEmployeePhone
- UpdateEmployeeDob
- UpdateEmployeeLocation
- UpdateEmployeePanNumber
- UpdateEmployeeAdharNumber
- UpdateEmployeeEsiNumber
- UpdateEmployeeEpsNumber
- UpdateEmployeeUanNumber
- UpdateEmployeePfNumber
- UpdateEmployeeCountry
- UpdateEmployeeBankAccountDetails
- UpdateEmployeeCurrentAddress
- UpdateEmployeePermanentAddress
- LinkUser
- UpdateEmployeeDocumentInfo
- UpdateEmployeeProfilePicture
- Email
- Expense
- File
- Hr
- Inventory Ledger
- Invoice
- Item
- Organization
- GetOrganizations
- AddOrganization
- UpdateOrganization
- GetOrganizationDetail
- DeleteOrganization
- UpdateOrganizationBusinessProfile
- ExtendSubscription
- UpdateGSTDetails
- UpdateVATDetails
- UpdateInvoiceOnOrderSetting
- UpdateReminderSetting
- UpdateInvoiceSettings
- UpdatePurchaseOrderSettings
- UpdateProposalSettings
- UpdatePreferences
- GetOrganizationPreferences
- UpdatePaymentSettings
- UpdateDefaultPaymentSettings
- UpdateLogo
- UpdateFromEmail
- OrganizationDeactive
- GetOrganizationSubscriptions
- GetOrganizationDashboardView
- GetOrganizationDashboardSnapshot
- GetSnapshotReceivables
- DeleteSelectiveData
- DeletePermanent
- GetClientCountries
- GetVendorCountries
- GetLeadCountries
- InviteUsers
- AcceptInvitation
- UpdatePlatformCredits
- UpdateCreditNoteSettings
- UpdateDebitNoteSettings
- Order
- Outward Payment
- Operations
- Payment
- Product
- Proposal
- Platform Plan
- Platform Subscription
- Platform Payment
- ProductCategory
- Purchase Order
- Purchase
- Recurring Expense
- Recurring Invoice
- Report
- GetSalesByClient
- GetSalesByProduct
- GetSalesByProductCategory
- GetSalesByService
- GetSalesByMonth
- GetSalesByYear
- GetSalesByQuarter
- GetSalesByCountry
- GetTaxSummary
- GetInvoiceDetailReport
- GetExpensesByMonth
- GetProfitAndLossReportV2
- GetBalanceSheetReport
- GetTrialBalanceReport
- GetGeneralLedger
- GetSalesByHsn
- GetTaxesByMonth
- GetOtherSales
- Routes
- Settlement
- Services
- Tax
- Trip
- User
- User Invites
- Vendor
- Vendor Ledger
- Projects
- Pre Sales
- Task
- Payroll
- Account
- Enquiry
- Account Transfer
- File Import
- File Import Error
- Brand
- Salary Component
- Leaves Configuration
- Tax Calendar
- Contract
- GST-Reports
- Organization Backup
- Bank Account
- Leave Policy
- Leave Application
- Backup Restore
- Finance
- Email-Rule
- Widget
- User Dashboard
- ExpenseCategory
- Lead
- LeadActivity
- Deal
- DebitNote
- SpendCategory
- SpendPolicy
- Employee Spend
- Warehouse
- Branch
AddPayroll
POST
https://api.upbooks.io/api/v1/payroll
Payroll
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
Example:
00000
Body Params application/json
employeeId
stringÂ
required
employmentId
stringÂ
required
totalPayAmount
number <double>
required
currency
optional
Any of
name
stringÂ
required
symbol
stringÂ
required
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
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
employersContribution
array[object (ICommonKeyValuePair) {2}]  | nullÂ
optional
key
string  | nullÂ
required
value
number <double> | nullÂ
required
paidVia
string  | nullÂ
optional
paymentMode
optional
Any of
Allowed values:
cashchequeneftimpswire transferonlinecredit carddebit cardwalletotherpaypalrazorpaywise
notes
string  | nullÂ
optional
referenceNumber
string  | nullÂ
optional
paymentAmount
number <double> | nullÂ
optional
calculationDifference
number <double> | nullÂ
optional
fileImportData
optional
Any of
fileImportId
stringÂ
required
rowId
stringÂ
required
Example
{
"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"
}
}Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.upbooks.io/api/v1/payroll' \
--header 'ORGANIZATION-ID: 00000' \
--header 'Content-Type: application/json' \
--data-raw '{
"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"
}
}'Responses
🟢200Ok
application/json
Body
data
object (PayrollDocumentJSON)Â
required
createdAt
string <date-time>
required
updatedAt
string <date-time>
required
__v
number <double>
optional
_id
stringÂ
required
organizationId
stringÂ
required
employee
object (ICommonEmployee)Â
required
employment
optional
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
paidVia
string  | nullÂ
optional
processedBy
object (ICommonUser)Â
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
isDeleted
booleanÂ
required
expense
array[object (ICommonExpense) {4}]  | nullÂ
optional
salarySlip
string  | nullÂ
optional
calculationDifference
number <double> | nullÂ
optional
message
stringÂ
optional
Example
{
"data": {
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"__v": 0,
"_id": "string",
"organizationId": "string",
"employee": {
"id": "string",
"name": "string",
"employeeNumber": "string",
"email": "string",
"phone": "string",
"type": "full-time",
"employment": [
{
"id": "string",
"isCurrent": true,
"dateOfJoining": "2019-08-24T14:15:22Z",
"dateOfLeaving": "2019-08-24T14:15:22Z",
"specialSchemes": [
{
"enabled": true,
"name": "ESI"
}
],
"salary": {
"componentGroup": {
"id": "string",
"groupName": "string",
"salaryCalculationMode": "month-days",
"sandwichLeaves": true
},
"type": "hourly",
"ctc": 0,
"gross": 0,
"net": 0,
"currency": {
"name": "string",
"symbol": "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",
"amount": 0
}
]
},
"designation": "string",
"role": "string",
"supervisor": {},
"leavePolicies": [
{
"id": "string",
"name": "string",
"leaves": [
{
"type": "string",
"probationPeriod": 0,
"noOfLeaves": 0,
"monthlyLimit": 0
}
]
}
],
"spendPolicies": [
{
"id": "string",
"title": "string"
}
]
}
]
},
"employment": {
"id": "string",
"isCurrent": true,
"dateOfJoining": "2019-08-24T14:15:22Z",
"dateOfLeaving": "2019-08-24T14:15:22Z",
"specialSchemes": [
{
"enabled": true,
"name": "ESI"
}
],
"salary": {
"componentGroup": {
"id": "string",
"groupName": "string",
"salaryCalculationMode": "month-days",
"sandwichLeaves": true
},
"type": "hourly",
"ctc": 0,
"gross": 0,
"net": 0,
"currency": {
"name": "string",
"symbol": "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",
"amount": 0
}
]
},
"designation": "string",
"role": "string",
"supervisor": {
"id": "string",
"name": "string",
"employeeNumber": "string",
"email": "string",
"phone": "string",
"type": "full-time",
"employment": [
{}
]
},
"leavePolicies": [
{
"id": "string",
"name": "string",
"leaves": [
{
"type": "string",
"probationPeriod": 0,
"noOfLeaves": 0,
"monthlyLimit": 0
}
]
}
],
"spendPolicies": [
{
"id": "string",
"title": "string"
}
]
},
"totalPayAmount": 0,
"currency": {
"name": "string",
"symbol": "string"
},
"month": 0,
"totalMonthDays": 0,
"year": 0,
"processingDate": "2019-08-24T14:15:22Z",
"paidVia": "string",
"processedBy": {
"id": "string",
"name": "string",
"email": "string",
"organizations": [
{
"organizationHashId": "string",
"organizationId": "string",
"role": "organization-admin",
"teams": [
"admin"
],
"organizationName": "string",
"organizationLogo": "string",
"isActive": true
}
]
},
"noOfLeaves": 0,
"noOfUnpaidLeaves": 0,
"totalWorkingDays": 0,
"deductions": [
{
"key": "string",
"value": 0
}
],
"allowances": [
{
"key": "string",
"value": 0
}
],
"employersContribution": [
{
"key": "string",
"value": 0
}
],
"isDeleted": true,
"expense": [
{
"id": "string",
"expenseNumber": "string",
"amount": 0,
"currency": {
"name": "string",
"symbol": "string"
}
}
],
"salarySlip": "string",
"calculationDifference": 0
},
"message": "string"
}🟢200Success
Modified at 2024-04-15 09:39:43