Creates the payslip configuration for the specified business ID.
ShowLineNotes field must be enabled in order to enable the ShowLocationInLineNotes field.
An example of what you would populate the EmailBodyMessage field with would be:
Hi {{FirstName}},
{{BusinessName}} has just processed your pay and a new pay slip is available.
Regards {{BusinessName}}
POST https://apisg.yourpayroll.io/api/v2/business/{businessId}/payslip
Parameter name | Value | Description | Additional |
---|---|---|---|
businessId | string | Required |
The request body takes a complete SgEditBusinessPaySlipApiModel resource, containing the following writable properties:
{
"alphabetisePayCategories": "boolean",
"emailBodyMessage": "string",
"emailFrom": "string",
"employeesMustLoginToDownloadPayslips": "boolean",
"id": "int32",
"nricNumberSettings": "string",
"showBasePayRate": "boolean",
"showClassification": "boolean",
"showEmployeeAddress": "boolean",
"showEmployeeExternalId": "boolean",
"showEmployeeId": "boolean",
"showEmployeeStartEndDates": "boolean",
"showLeaveAccruals": "boolean",
"showLineNotes": "boolean",
"showLocationInLineNotes": "boolean",
"showRateForAnnualEarnings": "boolean",
"showUnitsWorked": "boolean",
"showYtdTotals": "boolean"
}
Name | Type | Description |
---|---|---|
alphabetisePayCategories | boolean | Boolean |
emailBodyMessage | string | String |
emailFrom | string | String |
employeesMustLoginToDownloadPayslips | boolean | Boolean |
id | int32 | Int32 |
nricNumberSettings | string |
NricPayslipSettings
Possible values are:
|
showBasePayRate | boolean | Boolean |
showClassification | boolean | Boolean |
showEmployeeAddress | boolean | Boolean |
showEmployeeExternalId | boolean | Boolean |
showEmployeeId | boolean | Boolean |
showEmployeeStartEndDates | boolean |
Nullable |
showLeaveAccruals | boolean | Boolean |
showLineNotes | boolean | Boolean |
showLocationInLineNotes | boolean | Boolean |
showRateForAnnualEarnings | boolean | Boolean |
showUnitsWorked | boolean |
Nullable |
showYtdTotals | boolean |
Nullable |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
Powered by DapperDox