POST api/PayrollPeriodManagement/closepayperiod

No documentation available.

Request Information

Parameters

Name	Description	Additional information
objDat	No documentation available.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "CurrentPayPeriodDetail": {
    "Id": 1,
    "PayrollSetupId": 2,
    "PayMonth": "2025-01-11T12:42:19.0436883+03:00",
    "PayMonthFormat": "sample string 3",
    "PayPeriodName": "sample string 4",
    "PayMonthStartDate": "2025-01-11T12:42:19.0436883+03:00",
    "PayMonthEndDate": "2025-01-11T12:42:19.0436883+03:00",
    "PayPeriodFormat": "sample string 5",
    "PayMonthTotalDays": 6,
    "PayrollPeriodManagementStatus": 7,
    "PayrollPeriodManagementStatusName": "sample string 8",
    "CapturePeriodStartDate": "2025-01-11T12:42:19.0436883+03:00",
    "CapturePeriodEndDate": "2025-01-11T12:42:19.0436883+03:00",
    "CapturePeriodFormat": "sample string 9",
    "CapturePeriodTotalDays": 1,
    "TimeCardCutOffDate": "2025-01-11T12:42:19.0436883+03:00",
    "TimeCardCutOffDateFormat": "sample string 10",
    "CreatedDate": "2025-01-11T12:42:19.0436883+03:00",
    "CreatedBy": 1,
    "ClosedDate": "2025-01-11T12:42:19.0436883+03:00",
    "ClosedBy": 1,
    "ReOpenedDate": "2025-01-11T12:42:19.0436883+03:00",
    "ReOpenedBy": 1,
    "ApprovedDate": "2025-01-11T12:42:19.0436883+03:00",
    "ApprovedBy": 1,
    "OpenedDate": "2025-01-11T12:42:19.0436883+03:00",
    "OpenedBy": 1,
    "ExpectedNextPayMonth": "2025-01-11T12:42:19.0436883+03:00",
    "ExpectedNextPayMonthFormat": "sample string 11",
    "ExpectedNextPayMonthStartDate": "2025-01-11T12:42:19.0436883+03:00",
    "IsAdjusendMonth": true
  },
  "NextPayPeriodDetail": {
    "Id": 1,
    "PayrollSetupId": 2,
    "PayMonth": "2025-01-11T12:42:19.0436883+03:00",
    "PayMonthFormat": "sample string 3",
    "PayPeriodName": "sample string 4",
    "PayMonthStartDate": "2025-01-11T12:42:19.0436883+03:00",
    "PayMonthEndDate": "2025-01-11T12:42:19.0436883+03:00",
    "PayPeriodFormat": "sample string 5",
    "PayMonthTotalDays": 6,
    "PayrollPeriodManagementStatus": 7,
    "PayrollPeriodManagementStatusName": "sample string 8",
    "CapturePeriodStartDate": "2025-01-11T12:42:19.0436883+03:00",
    "CapturePeriodEndDate": "2025-01-11T12:42:19.0436883+03:00",
    "CapturePeriodFormat": "sample string 9",
    "CapturePeriodTotalDays": 1,
    "TimeCardCutOffDate": "2025-01-11T12:42:19.0436883+03:00",
    "TimeCardCutOffDateFormat": "sample string 10",
    "CreatedDate": "2025-01-11T12:42:19.0436883+03:00",
    "CreatedBy": 1,
    "ClosedDate": "2025-01-11T12:42:19.0436883+03:00",
    "ClosedBy": 1,
    "ReOpenedDate": "2025-01-11T12:42:19.0436883+03:00",
    "ReOpenedBy": 1,
    "ApprovedDate": "2025-01-11T12:42:19.0436883+03:00",
    "ApprovedBy": 1,
    "OpenedDate": "2025-01-11T12:42:19.0436883+03:00",
    "OpenedBy": 1,
    "ExpectedNextPayMonth": "2025-01-11T12:42:19.0436883+03:00",
    "ExpectedNextPayMonthFormat": "sample string 11",
    "ExpectedNextPayMonthStartDate": "2025-01-11T12:42:19.0436883+03:00",
    "IsAdjusendMonth": true
  },
  "CheckList": {
    "IsMiscellaneousInputAvailable": true,
    "CanDeleteMiscellaneousWhenReOpen": true,
    "IsEOYBonusAvailable": true,
    "CanDeleteEOYBonusWhenReOpen": true,
    "IsAnnualSalaryReviewAvailable": true,
    "CanDeleteSalaryReviewWhenReOpen": true,
    "CanDeleteMonthlyPayrollInputWhenReOpen": true
  }
}

application/xml, text/xml

Sample:

<PayrollPeriodManagementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ComsipApi.Models.Payroll">
  <CheckList>
    <CanDeleteEOYBonusWhenReOpen>true</CanDeleteEOYBonusWhenReOpen>
    <CanDeleteMiscellaneousWhenReOpen>true</CanDeleteMiscellaneousWhenReOpen>
    <CanDeleteMonthlyPayrollInputWhenReOpen>true</CanDeleteMonthlyPayrollInputWhenReOpen>
    <CanDeleteSalaryReviewWhenReOpen>true</CanDeleteSalaryReviewWhenReOpen>
    <IsAnnualSalaryReviewAvailable>true</IsAnnualSalaryReviewAvailable>
    <IsEOYBonusAvailable>true</IsEOYBonusAvailable>
    <IsMiscellaneousInputAvailable>true</IsMiscellaneousInputAvailable>
  </CheckList>
  <CurrentPayPeriodDetail>
    <ApprovedBy>1</ApprovedBy>
    <ApprovedDate>2025-01-11T12:42:19.0436883+03:00</ApprovedDate>
    <CapturePeriodEndDate>2025-01-11T12:42:19.0436883+03:00</CapturePeriodEndDate>
    <CapturePeriodFormat>sample string 9</CapturePeriodFormat>
    <CapturePeriodStartDate>2025-01-11T12:42:19.0436883+03:00</CapturePeriodStartDate>
    <CapturePeriodTotalDays>1</CapturePeriodTotalDays>
    <ClosedBy>1</ClosedBy>
    <ClosedDate>2025-01-11T12:42:19.0436883+03:00</ClosedDate>
    <CreatedBy>1</CreatedBy>
    <CreatedDate>2025-01-11T12:42:19.0436883+03:00</CreatedDate>
    <ExpectedNextPayMonth>2025-01-11T12:42:19.0436883+03:00</ExpectedNextPayMonth>
    <ExpectedNextPayMonthFormat>sample string 11</ExpectedNextPayMonthFormat>
    <ExpectedNextPayMonthStartDate>2025-01-11T12:42:19.0436883+03:00</ExpectedNextPayMonthStartDate>
    <Id>1</Id>
    <IsAdjusendMonth>true</IsAdjusendMonth>
    <OpenedBy>1</OpenedBy>
    <OpenedDate>2025-01-11T12:42:19.0436883+03:00</OpenedDate>
    <PayMonth>2025-01-11T12:42:19.0436883+03:00</PayMonth>
    <PayMonthEndDate>2025-01-11T12:42:19.0436883+03:00</PayMonthEndDate>
    <PayMonthFormat>sample string 3</PayMonthFormat>
    <PayMonthStartDate>2025-01-11T12:42:19.0436883+03:00</PayMonthStartDate>
    <PayMonthTotalDays>6</PayMonthTotalDays>
    <PayPeriodFormat>sample string 5</PayPeriodFormat>
    <PayPeriodName>sample string 4</PayPeriodName>
    <PayrollPeriodManagementStatus>7</PayrollPeriodManagementStatus>
    <PayrollPeriodManagementStatusName>sample string 8</PayrollPeriodManagementStatusName>
    <PayrollSetupId>2</PayrollSetupId>
    <ReOpenedBy>1</ReOpenedBy>
    <ReOpenedDate>2025-01-11T12:42:19.0436883+03:00</ReOpenedDate>
    <TimeCardCutOffDate>2025-01-11T12:42:19.0436883+03:00</TimeCardCutOffDate>
    <TimeCardCutOffDateFormat>sample string 10</TimeCardCutOffDateFormat>
  </CurrentPayPeriodDetail>
  <NextPayPeriodDetail>
    <ApprovedBy>1</ApprovedBy>
    <ApprovedDate>2025-01-11T12:42:19.0436883+03:00</ApprovedDate>
    <CapturePeriodEndDate>2025-01-11T12:42:19.0436883+03:00</CapturePeriodEndDate>
    <CapturePeriodFormat>sample string 9</CapturePeriodFormat>
    <CapturePeriodStartDate>2025-01-11T12:42:19.0436883+03:00</CapturePeriodStartDate>
    <CapturePeriodTotalDays>1</CapturePeriodTotalDays>
    <ClosedBy>1</ClosedBy>
    <ClosedDate>2025-01-11T12:42:19.0436883+03:00</ClosedDate>
    <CreatedBy>1</CreatedBy>
    <CreatedDate>2025-01-11T12:42:19.0436883+03:00</CreatedDate>
    <ExpectedNextPayMonth>2025-01-11T12:42:19.0436883+03:00</ExpectedNextPayMonth>
    <ExpectedNextPayMonthFormat>sample string 11</ExpectedNextPayMonthFormat>
    <ExpectedNextPayMonthStartDate>2025-01-11T12:42:19.0436883+03:00</ExpectedNextPayMonthStartDate>
    <Id>1</Id>
    <IsAdjusendMonth>true</IsAdjusendMonth>
    <OpenedBy>1</OpenedBy>
    <OpenedDate>2025-01-11T12:42:19.0436883+03:00</OpenedDate>
    <PayMonth>2025-01-11T12:42:19.0436883+03:00</PayMonth>
    <PayMonthEndDate>2025-01-11T12:42:19.0436883+03:00</PayMonthEndDate>
    <PayMonthFormat>sample string 3</PayMonthFormat>
    <PayMonthStartDate>2025-01-11T12:42:19.0436883+03:00</PayMonthStartDate>
    <PayMonthTotalDays>6</PayMonthTotalDays>
    <PayPeriodFormat>sample string 5</PayPeriodFormat>
    <PayPeriodName>sample string 4</PayPeriodName>
    <PayrollPeriodManagementStatus>7</PayrollPeriodManagementStatus>
    <PayrollPeriodManagementStatusName>sample string 8</PayrollPeriodManagementStatusName>
    <PayrollSetupId>2</PayrollSetupId>
    <ReOpenedBy>1</ReOpenedBy>
    <ReOpenedDate>2025-01-11T12:42:19.0436883+03:00</ReOpenedDate>
    <TimeCardCutOffDate>2025-01-11T12:42:19.0436883+03:00</TimeCardCutOffDate>
    <TimeCardCutOffDateFormat>sample string 10</TimeCardCutOffDateFormat>
  </NextPayPeriodDetail>
</PayrollPeriodManagementRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PayrollPeriodManagementRequest'.