POST v1/supplemental-benefits/import/employee-scheduled-deductions?importAction={importAction}&allowSameFile={allowSameFile}

Import Scheduled Deductions

Request Information

URI Parameters

Name	Description	Type	Additional information
importAction	The import action.	ImportAction	Default value is Override
allowSameFile	Determines if the import allows the content to be imported multiple times	boolean	Default value is True

Body Parameters

The scheduled deductions to import.

Collection of EmployeeScheduledDeductionImportDTO

Name	Type	Additional information
EmployeeNumber	string	None.
EmployeePersonalId	integer	None.
OtherMaximumType	OtherMaximumType	None.
OtherMaximumAmount	decimal number	None.
Rate	decimal number	None.
Amount	decimal number	None.
Goal	decimal number	None.
ToDate	decimal number	None.
AccumulatedArrears	decimal number	None.
StartDate	date	None.
EndDate	date	None.
UseDivisionDefaults	boolean	None.
MinimumAmount	decimal number	None.
MaximumAmount	decimal number	None.
PayeeReference	string	None.
IsBlocked	boolean	None.
IsActive	boolean	None.
DeductionCode	string	None.
PayeeCode	string	None.
OverrideMaxArrearsPercent	decimal number	None.
DivisionKey	DivisionKeyDTO	None.
CompanyCode	string	None.
DivisionCode	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "employeeNumber": "sample string 1",
    "employeePersonalId": 1,
    "otherMaximumType": "None",
    "otherMaximumAmount": 1.0,
    "rate": 1.0,
    "amount": 1.0,
    "goal": 1.0,
    "toDate": 1.0,
    "accumulatedArrears": 1.0,
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "useDivisionDefaults": true,
    "minimumAmount": 1.0,
    "maximumAmount": 1.0,
    "payeeReference": "sample string 2",
    "isBlocked": true,
    "isActive": true,
    "deductionCode": "sample string 3",
    "payeeCode": "sample string 4",
    "overrideMaxArrearsPercent": 1.0,
    "divisionKey": {
      "companyCode": "sample string 5",
      "divisionCode": "sample string 6"
    },
    "companyCode": "sample string 5",
    "divisionCode": "sample string 6"
  },
  {
    "employeeNumber": "sample string 1",
    "employeePersonalId": 1,
    "otherMaximumType": "None",
    "otherMaximumAmount": 1.0,
    "rate": 1.0,
    "amount": 1.0,
    "goal": 1.0,
    "toDate": 1.0,
    "accumulatedArrears": 1.0,
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "useDivisionDefaults": true,
    "minimumAmount": 1.0,
    "maximumAmount": 1.0,
    "payeeReference": "sample string 2",
    "isBlocked": true,
    "isActive": true,
    "deductionCode": "sample string 3",
    "payeeCode": "sample string 4",
    "overrideMaxArrearsPercent": 1.0,
    "divisionKey": {
      "companyCode": "sample string 5",
      "divisionCode": "sample string 6"
    },
    "companyCode": "sample string 5",
    "divisionCode": "sample string 6"
  }
]

text/xml

Sample:

<ArrayOfEmployeeScheduledDeductionImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <EmployeeScheduledDeductionImportDTO>
    <AccumulatedArrears>1</AccumulatedArrears>
    <Amount>1</Amount>
    <CompanyCode>sample string 5</CompanyCode>
    <DeductionCode>sample string 3</DeductionCode>
    <DivisionCode>sample string 6</DivisionCode>
    <DivisionKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:CompanyCode>sample string 5</d3p1:CompanyCode>
      <d3p1:DivisionCode>sample string 6</d3p1:DivisionCode>
    </DivisionKey>
    <EmployeeNumber>sample string 1</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <EndDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </EndDate>
    <Goal>1</Goal>
    <IsActive>true</IsActive>
    <IsBlocked>true</IsBlocked>
    <MaximumAmount>1</MaximumAmount>
    <MinimumAmount>1</MinimumAmount>
    <OtherMaximumAmount>1</OtherMaximumAmount>
    <OtherMaximumType>None</OtherMaximumType>
    <OverrideMaxArrearsPercent>1</OverrideMaxArrearsPercent>
    <PayeeCode>sample string 4</PayeeCode>
    <PayeeReference>sample string 2</PayeeReference>
    <Rate>1</Rate>
    <StartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </StartDate>
    <ToDate>1</ToDate>
    <UseDivisionDefaults>true</UseDivisionDefaults>
  </EmployeeScheduledDeductionImportDTO>
  <EmployeeScheduledDeductionImportDTO>
    <AccumulatedArrears>1</AccumulatedArrears>
    <Amount>1</Amount>
    <CompanyCode>sample string 5</CompanyCode>
    <DeductionCode>sample string 3</DeductionCode>
    <DivisionCode>sample string 6</DivisionCode>
    <DivisionKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:CompanyCode>sample string 5</d3p1:CompanyCode>
      <d3p1:DivisionCode>sample string 6</d3p1:DivisionCode>
    </DivisionKey>
    <EmployeeNumber>sample string 1</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <EndDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </EndDate>
    <Goal>1</Goal>
    <IsActive>true</IsActive>
    <IsBlocked>true</IsBlocked>
    <MaximumAmount>1</MaximumAmount>
    <MinimumAmount>1</MinimumAmount>
    <OtherMaximumAmount>1</OtherMaximumAmount>
    <OtherMaximumType>None</OtherMaximumType>
    <OverrideMaxArrearsPercent>1</OverrideMaxArrearsPercent>
    <PayeeCode>sample string 4</PayeeCode>
    <PayeeReference>sample string 2</PayeeReference>
    <Rate>1</Rate>
    <StartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </StartDate>
    <ToDate>1</ToDate>
    <UseDivisionDefaults>true</UseDivisionDefaults>
  </EmployeeScheduledDeductionImportDTO>
</ArrayOfEmployeeScheduledDeductionImportDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The import results.

ImportResultDTO

Name	Type	Additional information
NewRecords	integer	None.
UpdatedRecords	integer	None.
Errors	Collection of ImportErrorDTO	None.
NewRecordKeys	Collection of ImportKeyDTO	None.
UpdatedRecordKeys	Collection of ImportKeyDTO	None.
ImportKey	GlobalEntityKeyOfIImportSubmission	None.

Response Formats

application/json, text/json

Sample:

{
  "newRecords": 1,
  "updatedRecords": 2,
  "errors": [
    {
      "index": 1,
      "details": [
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ]
    },
    {
      "index": 1,
      "details": [
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ]
    }
  ],
  "newRecordKeys": [
    {
      "index": 1,
      "key": "sample string 2"
    },
    {
      "index": 1,
      "key": "sample string 2"
    }
  ],
  "updatedRecordKeys": [
    {
      "index": 1,
      "key": "sample string 2"
    },
    {
      "index": 1,
      "key": "sample string 2"
    }
  ],
  "importKey": "<empty>"
}

text/xml

Sample:

<ImportResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
  <Errors>
    <ImportErrorDTO>
      <Details>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
      </Details>
      <Index>1</Index>
    </ImportErrorDTO>
    <ImportErrorDTO>
      <Details>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
      </Details>
      <Index>1</Index>
    </ImportErrorDTO>
  </Errors>
  <ImportKey xmlns:d2p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
    <d2p1:_entityKey>
      <d2p1:_hasValue>false</d2p1:_hasValue>
      <d2p1:_value>00000000-0000-0000-0000-000000000000</d2p1:_value>
    </d2p1:_entityKey>
  </ImportKey>
  <NewRecordKeys>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
  </NewRecordKeys>
  <NewRecords>1</NewRecords>
  <UpdatedRecordKeys>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
  </UpdatedRecordKeys>
  <UpdatedRecords>2</UpdatedRecords>
</ImportResultDTO>