Payroll summary

POST

https://api.salaryboxapp.com/v2/customer/v1/payroll/summary

POST

/v2/customer/v1/payroll/summary

$ curl -X POST https://api.salaryboxapp.com/v2/customer/v1/payroll/summary \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "month_from_date": "2023-01-15"
> }'

200Example

1 {
2   "message": "Data retrieved successfully",
3   "status": true,
4   "data": {
5     "ctc_not_defined_employee_count": 0,
6     "cards": [
7       {
8         "items": [
9           {
10             "action": "open_run_payroll",
11             "amount": {
12               "label": "₹ 148,007.55"
13             },
14             "count": {
15               "label": "3 Staff"
16             },
17             "data": {
18               "ctc_status": {
19                 "selected_value": "added"
20               },
21               "show_inactive": {
22                 "selected_value": true
23               }
24             },
25             "title": {
26               "infotip": "Staff with salary details added for month",
27               "label": "Total Payroll"
28             }
29           },
30           {
31             "action": "open_run_payroll",
32             "amount": {
33               "label": "₹ 0.00"
34             },
35             "count": {
36               "label": "0 Staff"
37             },
38             "data": {
39               "salary_paid": {
40                 "selected_value": [
41                   "partially_paid",
42                   "paid_in_full"
43                 ]
44               },
45               "show_inactive": {
46                 "selected_value": true
47               }
48             },
49             "title": {
50               "infotip": "Fully or partially paid staff",
51               "label": "Paid"
52             }
53           },
54           {
55             "action": "open_run_payroll",
56             "amount": {
57               "label": "₹ 301,585.52"
58             },
59             "count": {
60               "label": "1 Staff"
61             },
62             "data": {
63               "remaining_balance": {
64                 "selected_amount": 1,
65                 "selected_value": "remaining_balance_greater_than"
66               },
67               "show_inactive": {
68                 "selected_value": true
69               }
70             },
71             "title": {
72               "infotip": "Staff with pending salary dues",
73               "label": "Pending"
74             }
75           }
76         ],
77         "title": null
78       },
79       {
80         "items": [
81           {
82             "amount": {
83               "label": "₹ 0.00"
84             },
85             "count": {
86               "label": "0 Staff"
87             },
88             "title": {
89               "label": "Work Basis Payment"
90             }
91           },
92           {
93             "amount": {
94               "label": "₹ 0.00"
95             },
96             "count": {
97               "label": "0 Staff"
98             },
99             "title": {
100               "label": "Incentives"
101             }
102           },
103           {
104             "amount": {
105               "label": "₹ 0.00"
106             },
107             "count": {
108               "label": "0 Staff"
109             },
110             "title": {
111               "label": "Reimbursement"
112             }
113           },
114           {
115             "amount": {
116               "label": "₹ 0.00"
117             },
118             "count": {
119               "label": "0 Staff"
120             },
121             "title": {
122               "label": "Bonus"
123             }
124           },
125           {
126             "amount": {
127               "label": "₹ 0.00"
128             },
129             "count": {
130               "label": "0 Staff"
131             },
132             "title": {
133               "label": "Overtime Pay"
134             }
135           },
136           {
137             "amount": {
138               "label": "₹ 0.00"
139             },
140             "count": {
141               "label": "0 Staff"
142             },
143             "title": {
144               "label": "Other Earnings"
145             }
146           }
147         ],
148         "title": "Earning Details"
149       },
150       {
151         "items": [
152           {
153             "amount": {
154               "label": "₹ 3,750.00"
155             },
156             "count": {
157               "label": "1 Staff"
158             },
159             "sub_items": [
160               {
161                 "amount": {
162                   "label": "₹ 1,800.00"
163                 },
164                 "title": {
165                   "label": "Employer Contribution"
166                 }
167               },
168               {
169                 "amount": {
170                   "label": "₹ 1,800.00"
171                 },
172                 "title": {
173                   "label": "Employee Contribution"
174                 }
175               },
176               {
177                 "amount": {
178                   "label": "₹ 150.00"
179                 },
180                 "title": {
181                   "label": "EDLI & Admin Charges"
182                 }
183               }
184             ],
185             "title": {
186               "label": "Total Provident Fund"
187             }
188           },
189           {
190             "amount": {
191               "label": "₹ 2,800.00"
192             },
193             "count": {
194               "label": "1 Staff"
195             },
196             "sub_items": [
197               {
198                 "amount": {
199                   "label": "₹ 2,275.00"
200                 },
201                 "title": {
202                   "label": "Employer Contribution"
203                 }
204               },
205               {
206                 "amount": {
207                   "label": "₹ 525.00"
208                 },
209                 "title": {
210                   "label": "Employee Contribution"
211                 }
212               }
213             ],
214             "title": {
215               "label": "Total Employees' State Insurance"
216             }
217           },
218           {
219             "amount": {
220               "label": "₹ 5.00"
221             },
222             "count": {
223               "label": "1 Staff"
224             },
225             "sub_items": [
226               {
227                 "amount": {
228                   "label": "₹ 3.33"
229                 },
230                 "title": {
231                   "label": "Employer Contribution"
232                 }
233               },
234               {
235                 "amount": {
236                   "label": "₹ 1.67"
237                 },
238                 "title": {
239                   "label": "Employee Contribution"
240                 }
241               }
242             ],
243             "title": {
244               "label": "Total Labour Welfare Fund Tax"
245             }
246           },
247           {
248             "amount": {
249               "label": "₹ 200.00"
250             },
251             "count": {
252               "label": "1 Staff"
253             },
254             "title": {
255               "label": "Total Professional Tax"
256             }
257           },
258           {
259             "amount": {
260               "label": "₹ 408,026.09"
261             },
262             "count": {
263               "label": "2 Staff"
264             },
265             "title": {
266               "infotip": "This feature is available only with SB Payroll Pro Module",
267               "label": "Total Tax Deducted at Source"
268             }
269           }
270         ],
271         "title": "Statutory Compliance Details"
272       }
273     ],
274     "loan_details": {
275       "loan_given": {
276         "count": "1 Staff",
277         "formatted_amount": "₹ 2,000,000.0",
278         "title": "Given"
279       },
280       "loan_received": {
281         "count": "0 Staff",
282         "formatted_amount": "₹ 0.00",
283         "title": "Received"
284       },
285       "pending": {
286         "count": "1 Staff",
287         "formatted_amount": "₹ 2,000,000.0",
288         "title": "Pending Loan Amount"
289       },
290       "title": "Total Loan Amount"
291     }
292   }
293 }

Computes and returns the payroll summary for the given month.

Authentication

Authorizationstring

Format: “Api-Key {api-key}”

Request

This endpoint expects an object.

month_from_datedateRequired

Response

messagestring

statusboolean

dataobject