General - Payout savings

API Url

Used for doing a payout of overtime savings.

PUT
http://localhost:16010/ProMarkREST/rest/General/employees/{emp_id}/payout

Permissions: user

Request headers

FieldTypeDescription
Accept-LanguageoptionalString

=en-GB Language use for localization.

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

    payoutObject[]

Payout data.

      accountIdString

Saving account id

      hoursNumber

Hours expressed in seconds.

      targetAccountIdString

Target account id

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  errorCodeNumber

Error Code (0=No Problem)

  errorMessageString

Message description of the error.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  errorCodeNumber

Error code.

  errorMessageString

Error description.

Error example:

HTTP/1.1 422 Unprocessable Entity
{
"response": {
"errorCode": 1000,
"errorMessage": "There is not enough saved hours to be able to do a payout"
}
}