POST api/PayrollSetup/SavePayrollData

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
components	Collection of PayrollComponentRow	None.
profiles	Collection of SalaryProfileRow	None.
setup	PayrollSetupRow	None.
runs	Collection of PayrollRunRow	None.
payslips	Collection of PayslipRow	None.
settlements	Collection of SettlementRow	None.
documents	Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "components": [
    {
      "key": "sample string 1",
      "code": "sample string 2",
      "name": "sample string 3",
      "type": "sample string 4",
      "calc": "sample string 5",
      "source": "sample string 6",
      "recurring": true,
      "from": "sample string 8",
      "to": "sample string 9",
      "status": "sample string 10",
      "configJson": "sample string 11"
    },
    {
      "key": "sample string 1",
      "code": "sample string 2",
      "name": "sample string 3",
      "type": "sample string 4",
      "calc": "sample string 5",
      "source": "sample string 6",
      "recurring": true,
      "from": "sample string 8",
      "to": "sample string 9",
      "status": "sample string 10",
      "configJson": "sample string 11"
    }
  ],
  "profiles": [
    {
      "key": "sample string 1",
      "employeeId": "sample string 2",
      "from": "sample string 3",
      "to": "sample string 4",
      "basic": 5.0,
      "active": true,
      "statusReason": "sample string 7",
      "fixedComponents": [
        {
          "code": "sample string 1",
          "amount": 2.0
        },
        {
          "code": "sample string 1",
          "amount": 2.0
        }
      ]
    },
    {
      "key": "sample string 1",
      "employeeId": "sample string 2",
      "from": "sample string 3",
      "to": "sample string 4",
      "basic": 5.0,
      "active": true,
      "statusReason": "sample string 7",
      "fixedComponents": [
        {
          "code": "sample string 1",
          "amount": 2.0
        },
        {
          "code": "sample string 1",
          "amount": 2.0
        }
      ]
    }
  ],
  "setup": {
    "currency": "sample string 1",
    "prorationBasis": "sample string 2",
    "roundingDecimals": 3
  },
  "runs": [
    {
      "key": "sample string 1",
      "code": "sample string 2",
      "version": 3,
      "period": "sample string 4",
      "from": "sample string 5",
      "to": "sample string 6",
      "cutoff": "sample string 7",
      "paymentDate": "sample string 8",
      "status": "sample string 9",
      "lines": [
        {
          "employeeId": "sample string 1",
          "basic": 2.0,
          "fixedAdditions": 3.0,
          "variableAdditions": 4.0,
          "gross": 5.0,
          "attendanceDeductions": 6.0,
          "advanceRecovery": 7.0,
          "loanRecovery": 8.0,
          "otherDeductions": 9.0,
          "totalDeductions": 10.0,
          "netSalary": 11.0,
          "reimbursements": 12.0,
          "netPayable": 13.0
        },
        {
          "employeeId": "sample string 1",
          "basic": 2.0,
          "fixedAdditions": 3.0,
          "variableAdditions": 4.0,
          "gross": 5.0,
          "attendanceDeductions": 6.0,
          "advanceRecovery": 7.0,
          "loanRecovery": 8.0,
          "otherDeductions": 9.0,
          "totalDeductions": 10.0,
          "netSalary": 11.0,
          "reimbursements": 12.0,
          "netPayable": 13.0
        }
      ]
    },
    {
      "key": "sample string 1",
      "code": "sample string 2",
      "version": 3,
      "period": "sample string 4",
      "from": "sample string 5",
      "to": "sample string 6",
      "cutoff": "sample string 7",
      "paymentDate": "sample string 8",
      "status": "sample string 9",
      "lines": [
        {
          "employeeId": "sample string 1",
          "basic": 2.0,
          "fixedAdditions": 3.0,
          "variableAdditions": 4.0,
          "gross": 5.0,
          "attendanceDeductions": 6.0,
          "advanceRecovery": 7.0,
          "loanRecovery": 8.0,
          "otherDeductions": 9.0,
          "totalDeductions": 10.0,
          "netSalary": 11.0,
          "reimbursements": 12.0,
          "netPayable": 13.0
        },
        {
          "employeeId": "sample string 1",
          "basic": 2.0,
          "fixedAdditions": 3.0,
          "variableAdditions": 4.0,
          "gross": 5.0,
          "attendanceDeductions": 6.0,
          "advanceRecovery": 7.0,
          "loanRecovery": 8.0,
          "otherDeductions": 9.0,
          "totalDeductions": 10.0,
          "netSalary": 11.0,
          "reimbursements": 12.0,
          "netPayable": 13.0
        }
      ]
    }
  ],
  "payslips": [
    {
      "key": "sample string 1",
      "runKey": "sample string 2",
      "employeeId": "sample string 3",
      "version": 4,
      "status": "sample string 5",
      "generatedAt": "sample string 6",
      "publishedAt": "sample string 7"
    },
    {
      "key": "sample string 1",
      "runKey": "sample string 2",
      "employeeId": "sample string 3",
      "version": 4,
      "status": "sample string 5",
      "generatedAt": "sample string 6",
      "publishedAt": "sample string 7"
    }
  ],
  "settlements": [
    {
      "key": "sample string 1",
      "kind": "sample string 2",
      "employeeId": "sample string 3",
      "title": "sample string 4",
      "approved": 5.0,
      "disbursed": 6.0,
      "installments": 7,
      "installment": 8.0,
      "recovered": 9.0,
      "state": "sample string 10",
      "startPeriod": "sample string 11",
      "payPeriod": "sample string 12",
      "paid": true
    },
    {
      "key": "sample string 1",
      "kind": "sample string 2",
      "employeeId": "sample string 3",
      "title": "sample string 4",
      "approved": 5.0,
      "disbursed": 6.0,
      "installments": 7,
      "installment": 8.0,
      "recovered": 9.0,
      "state": "sample string 10",
      "startPeriod": "sample string 11",
      "payPeriod": "sample string 12",
      "paid": true
    }
  ],
  "documents": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<RequestSavePayrollData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RRCDR_Attendance_API.Helpers.Custom">
  <components>
    <PayrollComponentRow>
      <calc>sample string 5</calc>
      <code>sample string 2</code>
      <configJson>sample string 11</configJson>
      <from>sample string 8</from>
      <key>sample string 1</key>
      <name>sample string 3</name>
      <recurring>true</recurring>
      <source>sample string 6</source>
      <status>sample string 10</status>
      <to>sample string 9</to>
      <type>sample string 4</type>
    </PayrollComponentRow>
    <PayrollComponentRow>
      <calc>sample string 5</calc>
      <code>sample string 2</code>
      <configJson>sample string 11</configJson>
      <from>sample string 8</from>
      <key>sample string 1</key>
      <name>sample string 3</name>
      <recurring>true</recurring>
      <source>sample string 6</source>
      <status>sample string 10</status>
      <to>sample string 9</to>
      <type>sample string 4</type>
    </PayrollComponentRow>
  </components>
  <documents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </documents>
  <payslips>
    <PayslipRow>
      <employeeId>sample string 3</employeeId>
      <generatedAt>sample string 6</generatedAt>
      <key>sample string 1</key>
      <publishedAt>sample string 7</publishedAt>
      <runKey>sample string 2</runKey>
      <status>sample string 5</status>
      <version>4</version>
    </PayslipRow>
    <PayslipRow>
      <employeeId>sample string 3</employeeId>
      <generatedAt>sample string 6</generatedAt>
      <key>sample string 1</key>
      <publishedAt>sample string 7</publishedAt>
      <runKey>sample string 2</runKey>
      <status>sample string 5</status>
      <version>4</version>
    </PayslipRow>
  </payslips>
  <profiles>
    <SalaryProfileRow>
      <active>true</active>
      <basic>5</basic>
      <employeeId>sample string 2</employeeId>
      <fixedComponents>
        <FixedComponentRow>
          <amount>2</amount>
          <code>sample string 1</code>
        </FixedComponentRow>
        <FixedComponentRow>
          <amount>2</amount>
          <code>sample string 1</code>
        </FixedComponentRow>
      </fixedComponents>
      <from>sample string 3</from>
      <key>sample string 1</key>
      <statusReason>sample string 7</statusReason>
      <to>sample string 4</to>
    </SalaryProfileRow>
    <SalaryProfileRow>
      <active>true</active>
      <basic>5</basic>
      <employeeId>sample string 2</employeeId>
      <fixedComponents>
        <FixedComponentRow>
          <amount>2</amount>
          <code>sample string 1</code>
        </FixedComponentRow>
        <FixedComponentRow>
          <amount>2</amount>
          <code>sample string 1</code>
        </FixedComponentRow>
      </fixedComponents>
      <from>sample string 3</from>
      <key>sample string 1</key>
      <statusReason>sample string 7</statusReason>
      <to>sample string 4</to>
    </SalaryProfileRow>
  </profiles>
  <runs>
    <PayrollRunRow>
      <code>sample string 2</code>
      <cutoff>sample string 7</cutoff>
      <from>sample string 5</from>
      <key>sample string 1</key>
      <lines>
        <PayrollRunLineRow>
          <advanceRecovery>7</advanceRecovery>
          <attendanceDeductions>6</attendanceDeductions>
          <basic>2</basic>
          <employeeId>sample string 1</employeeId>
          <fixedAdditions>3</fixedAdditions>
          <gross>5</gross>
          <loanRecovery>8</loanRecovery>
          <netPayable>13</netPayable>
          <netSalary>11</netSalary>
          <otherDeductions>9</otherDeductions>
          <reimbursements>12</reimbursements>
          <totalDeductions>10</totalDeductions>
          <variableAdditions>4</variableAdditions>
        </PayrollRunLineRow>
        <PayrollRunLineRow>
          <advanceRecovery>7</advanceRecovery>
          <attendanceDeductions>6</attendanceDeductions>
          <basic>2</basic>
          <employeeId>sample string 1</employeeId>
          <fixedAdditions>3</fixedAdditions>
          <gross>5</gross>
          <loanRecovery>8</loanRecovery>
          <netPayable>13</netPayable>
          <netSalary>11</netSalary>
          <otherDeductions>9</otherDeductions>
          <reimbursements>12</reimbursements>
          <totalDeductions>10</totalDeductions>
          <variableAdditions>4</variableAdditions>
        </PayrollRunLineRow>
      </lines>
      <paymentDate>sample string 8</paymentDate>
      <period>sample string 4</period>
      <status>sample string 9</status>
      <to>sample string 6</to>
      <version>3</version>
    </PayrollRunRow>
    <PayrollRunRow>
      <code>sample string 2</code>
      <cutoff>sample string 7</cutoff>
      <from>sample string 5</from>
      <key>sample string 1</key>
      <lines>
        <PayrollRunLineRow>
          <advanceRecovery>7</advanceRecovery>
          <attendanceDeductions>6</attendanceDeductions>
          <basic>2</basic>
          <employeeId>sample string 1</employeeId>
          <fixedAdditions>3</fixedAdditions>
          <gross>5</gross>
          <loanRecovery>8</loanRecovery>
          <netPayable>13</netPayable>
          <netSalary>11</netSalary>
          <otherDeductions>9</otherDeductions>
          <reimbursements>12</reimbursements>
          <totalDeductions>10</totalDeductions>
          <variableAdditions>4</variableAdditions>
        </PayrollRunLineRow>
        <PayrollRunLineRow>
          <advanceRecovery>7</advanceRecovery>
          <attendanceDeductions>6</attendanceDeductions>
          <basic>2</basic>
          <employeeId>sample string 1</employeeId>
          <fixedAdditions>3</fixedAdditions>
          <gross>5</gross>
          <loanRecovery>8</loanRecovery>
          <netPayable>13</netPayable>
          <netSalary>11</netSalary>
          <otherDeductions>9</otherDeductions>
          <reimbursements>12</reimbursements>
          <totalDeductions>10</totalDeductions>
          <variableAdditions>4</variableAdditions>
        </PayrollRunLineRow>
      </lines>
      <paymentDate>sample string 8</paymentDate>
      <period>sample string 4</period>
      <status>sample string 9</status>
      <to>sample string 6</to>
      <version>3</version>
    </PayrollRunRow>
  </runs>
  <settlements>
    <SettlementRow>
      <approved>5</approved>
      <disbursed>6</disbursed>
      <employeeId>sample string 3</employeeId>
      <installment>8</installment>
      <installments>7</installments>
      <key>sample string 1</key>
      <kind>sample string 2</kind>
      <paid>true</paid>
      <payPeriod>sample string 12</payPeriod>
      <recovered>9</recovered>
      <startPeriod>sample string 11</startPeriod>
      <state>sample string 10</state>
      <title>sample string 4</title>
    </SettlementRow>
    <SettlementRow>
      <approved>5</approved>
      <disbursed>6</disbursed>
      <employeeId>sample string 3</employeeId>
      <installment>8</installment>
      <installments>7</installments>
      <key>sample string 1</key>
      <kind>sample string 2</kind>
      <paid>true</paid>
      <payPeriod>sample string 12</payPeriod>
      <recovered>9</recovered>
      <startPeriod>sample string 11</startPeriod>
      <state>sample string 10</state>
      <title>sample string 4</title>
    </SettlementRow>
  </settlements>
  <setup>
    <currency>sample string 1</currency>
    <prorationBasis>sample string 2</prorationBasis>
    <roundingDecimals>3</roundingDecimals>
  </setup>
</RequestSavePayrollData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json

Sample:

{}

application/xml, text/xml

Sample:

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />