Payroll summary | SalaryBox

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

{
  "message": "Data retrieved successfully",
  "status": true,
  "data": {
    "ctc_not_defined_employee_count": 0,
    "cards": [
      {
        "items": [
          {
            "action": "open_run_payroll",
            "amount": {
              "label": "₹ 148,007.55"
            },
            "count": {
              "label": "3 Staff"
            },
            "data": {
              "ctc_status": {
                "selected_value": "added"
              },
              "show_inactive": {
                "selected_value": true
              }
            },
            "title": {
              "infotip": "Staff with salary details added for month",
              "label": "Total Payroll"
            }
          },
          {
            "action": "open_run_payroll",
            "amount": {
              "label": "₹ 0.00"
            },
            "count": {
              "label": "0 Staff"
            },
            "data": {
              "salary_paid": {
                "selected_value": [
                  "partially_paid",
                  "paid_in_full"
                ]
              },
              "show_inactive": {
                "selected_value": true
              }
            },
            "title": {
              "infotip": "Fully or partially paid staff",
              "label": "Paid"
            }
          },
          {
            "action": "open_run_payroll",
            "amount": {
              "label": "₹ 301,585.52"
            },
            "count": {
              "label": "1 Staff"
            },
            "data": {
              "remaining_balance": {
                "selected_amount": 1,
                "selected_value": "remaining_balance_greater_than"
              },
              "show_inactive": {
                "selected_value": true
              }
            },
            "title": {
              "infotip": "Staff with pending salary dues",
              "label": "Pending"
            }
          }
        ],
        "title": null
      },
      {
        "items": [
          {
            "amount": {
              "label": "₹ 0.00"
            },
            "count": {
              "label": "0 Staff"
            },
            "title": {
              "label": "Work Basis Payment"
            }
          },
          {
            "amount": {
              "label": "₹ 0.00"
            },
            "count": {
              "label": "0 Staff"
            },
            "title": {
              "label": "Incentives"
            }
          },
          {
            "amount": {
              "label": "₹ 0.00"
            },
            "count": {
              "label": "0 Staff"
            },
            "title": {
              "label": "Reimbursement"
            }
          },
          {
            "amount": {
              "label": "₹ 0.00"
            },
            "count": {
              "label": "0 Staff"
            },
            "title": {
              "label": "Bonus"
            }
          },
          {
            "amount": {
              "label": "₹ 0.00"
            },
            "count": {
              "label": "0 Staff"
            },
            "title": {
              "label": "Overtime Pay"
            }
          },
          {
            "amount": {
              "label": "₹ 0.00"
            },
            "count": {
              "label": "0 Staff"
            },
            "title": {
              "label": "Other Earnings"
            }
          }
        ],
        "title": "Earning Details"
      },
      {
        "items": [
          {
            "amount": {
              "label": "₹ 3,750.00"
            },
            "count": {
              "label": "1 Staff"
            },
            "sub_items": [
              {
                "amount": {
                  "label": "₹ 1,800.00"
                },
                "title": {
                  "label": "Employer Contribution"
                }
              },
              {
                "amount": {
                  "label": "₹ 1,800.00"
                },
                "title": {
                  "label": "Employee Contribution"
                }
              },
              {
                "amount": {
                  "label": "₹ 150.00"
                },
                "title": {
                  "label": "EDLI & Admin Charges"
                }
              }
            ],
            "title": {
              "label": "Total Provident Fund"
            }
          },
          {
            "amount": {
              "label": "₹ 2,800.00"
            },
            "count": {
              "label": "1 Staff"
            },
            "sub_items": [
              {
                "amount": {
                  "label": "₹ 2,275.00"
                },
                "title": {
                  "label": "Employer Contribution"
                }
              },
              {
                "amount": {
                  "label": "₹ 525.00"
                },
                "title": {
                  "label": "Employee Contribution"
                }
              }
            ],
            "title": {
              "label": "Total Employees' State Insurance"
            }
          },
          {
            "amount": {
              "label": "₹ 5.00"
            },
            "count": {
              "label": "1 Staff"
            },
            "sub_items": [
              {
                "amount": {
                  "label": "₹ 3.33"
                },
                "title": {
                  "label": "Employer Contribution"
                }
              },
              {
                "amount": {
                  "label": "₹ 1.67"
                },
                "title": {
                  "label": "Employee Contribution"
                }
              }
            ],
            "title": {
              "label": "Total Labour Welfare Fund Tax"
            }
          },
          {
            "amount": {
              "label": "₹ 200.00"
            },
            "count": {
              "label": "1 Staff"
            },
            "title": {
              "label": "Total Professional Tax"
            }
          },
          {
            "amount": {
              "label": "₹ 408,026.09"
            },
            "count": {
              "label": "2 Staff"
            },
            "title": {
              "infotip": "This feature is available only with SB Payroll Pro Module",
              "label": "Total Tax Deducted at Source"
            }
          }
        ],
        "title": "Statutory Compliance Details"
      }
    ],
    "loan_details": {
      "loan_given": {
        "count": "1 Staff",
        "formatted_amount": "₹ 2,000,000.0",
        "title": "Given"
      },
      "loan_received": {
        "count": "0 Staff",
        "formatted_amount": "₹ 0.00",
        "title": "Received"
      },
      "pending": {
        "count": "1 Staff",
        "formatted_amount": "₹ 2,000,000.0",
        "title": "Pending Loan Amount"
      },
      "title": "Total Loan Amount"
    }
  },
  "rate_limit": [
    "0/1 requests remaining per 10 seconds",
    "2/3 requests remaining per 5 minutes",
    "9/10 requests remaining per 1 hour"
  ]
}

Computes and returns the payroll summary for the given month.

Rate limited to 1 request per 10 seconds, 3 per 5 minutes, and 10 per hour, on top of the shared 5000/day API key limit — computing this response can be expensive, so budget one call per payroll month.

Authentication

AuthorizationApi-Key

Format: "Api-Key {api-key}"

Request

This endpoint expects an object.

month_from_datedateRequired

Response

This endpoint returns an object.

messagestring

statusboolean

dataobject

rate_limitlist of stringsOptional