POST v1/imports/deductions?action={action}&allowSameFile={allowSameFile}

Import Division Deductions

Request Information

URI Parameters

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

Body Parameters

The items to import.

Collection of DivisionDeductionImportDTO

Name	Type	Additional information
DeductionTypeCode	string	None.
TriggerOtherDeductionCode	string	None.
PrintOnRegister	boolean	None.
PrintOnStub	boolean	None.
PayeeCode	string	None.
IsHealthcareReporting	boolean	None.
DeductionCalcRule	DeductionCalcRule	None.
BasedOn	DeductionBasedOn	None.
LienTypeCode	string	None.
DependenceType	DeductionDependenceType	None.
DependOnOtherDeductionCode	string	None.
IsProrated	boolean	None.
IsOncePerPayrollOnly	boolean	None.
IsRegularCheckOnly	boolean	None.
IsAccumulateArrears	boolean	None.
IsCalcOnAdjustments	boolean	None.
IsAllowPartial	boolean	None.
IsRestricted	boolean	None.
GoalAmount	decimal number	None.
PayCodeRules	Collection of DivisionDeductionRuleSubImportDTO	None.
TriggerMakeup	boolean	None.
TriggerMakeupEmployeeOption	TriggerMakeupEmployeeOption	None.
MaxArrearsBasedOn	MaxArrearsBasedOn	None.
MaxArrearsPercent	decimal number	None.
Code	string	Required
IsActive	boolean	None.
IsInternal	boolean	None.
ShortDescription	string	None.
Description	string	None.
FrequencyCode	string	None.
MemoOnly	boolean	None.
DisplaySequence	integer	None.
W2Label	string	None.
EffectiveDateOption	EffectiveDateOption	None.
CodeAccumulatorCode	string	None.
IsAllEmployees	boolean	None.
ForceCalculate	boolean	None.
AfterCalcCustomDLLMethodCode	string	None.
SBCustomCalcExpressionCode	string	None.
BracketAccumulatorCode	string	None.
Rate	decimal number	None.
RateCode	string	None.
EmployeeCriteriaName	string	None.
IsTableDriven	boolean	None.
Sequence	integer	None.
Amount	decimal number	None.
MinimumAmount	decimal number	None.
MaximumAmount	decimal number	None.
OtherMaximumType	OtherMaximumType	None.
OtherMaximumAmount	decimal number	None.
DivisionCode	string	None.
CompanyCode	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "deductionTypeCode": "sample string 1",
    "triggerOtherDeductionCode": "sample string 2",
    "printOnRegister": true,
    "printOnStub": true,
    "payeeCode": "sample string 5",
    "isHealthcareReporting": true,
    "deductionCalcRule": "Flat",
    "basedOn": "None",
    "lienTypeCode": "sample string 7",
    "dependenceType": "None",
    "dependOnOtherDeductionCode": "sample string 8",
    "isProrated": true,
    "isOncePerPayrollOnly": true,
    "isRegularCheckOnly": true,
    "isAccumulateArrears": true,
    "isCalcOnAdjustments": true,
    "isAllowPartial": true,
    "isRestricted": true,
    "goalAmount": 15.0,
    "payCodeRules": [
      {
        "goalAmount": 1.0,
        "startDate": "0001-02-03",
        "employeeCriteriaName": "sample string 2",
        "rateCode": "sample string 3",
        "rate": 4.0,
        "amount": 5.0,
        "minimumAmount": 6.0,
        "maximumAmount": 7.0,
        "otherMaximumAmount": 8.0,
        "otherMaximumType": "None"
      },
      {
        "goalAmount": 1.0,
        "startDate": "0001-02-03",
        "employeeCriteriaName": "sample string 2",
        "rateCode": "sample string 3",
        "rate": 4.0,
        "amount": 5.0,
        "minimumAmount": 6.0,
        "maximumAmount": 7.0,
        "otherMaximumAmount": 8.0,
        "otherMaximumType": "None"
      }
    ],
    "triggerMakeup": true,
    "triggerMakeupEmployeeOption": "Default",
    "maxArrearsBasedOn": "None",
    "maxArrearsPercent": 17.0,
    "code": "sample string 18",
    "isActive": true,
    "isInternal": true,
    "shortDescription": "sample string 21",
    "description": "sample string 22",
    "frequencyCode": "sample string 23",
    "memoOnly": true,
    "displaySequence": 25,
    "w2Label": "sample string 26",
    "effectiveDateOption": "CheckDate",
    "codeAccumulatorCode": "sample string 27",
    "isAllEmployees": true,
    "forceCalculate": true,
    "afterCalcCustomDLLMethodCode": "sample string 30",
    "sbCustomCalcExpressionCode": "sample string 31",
    "bracketAccumulatorCode": "sample string 32",
    "rate": 33.0,
    "rateCode": "sample string 34",
    "employeeCriteriaName": "sample string 35",
    "isTableDriven": true,
    "sequence": 37,
    "amount": 38.0,
    "minimumAmount": 39.0,
    "maximumAmount": 40.0,
    "otherMaximumType": "None",
    "otherMaximumAmount": 41.0,
    "divisionCode": "sample string 42",
    "companyCode": "sample string 43"
  },
  {
    "deductionTypeCode": "sample string 1",
    "triggerOtherDeductionCode": "sample string 2",
    "printOnRegister": true,
    "printOnStub": true,
    "payeeCode": "sample string 5",
    "isHealthcareReporting": true,
    "deductionCalcRule": "Flat",
    "basedOn": "None",
    "lienTypeCode": "sample string 7",
    "dependenceType": "None",
    "dependOnOtherDeductionCode": "sample string 8",
    "isProrated": true,
    "isOncePerPayrollOnly": true,
    "isRegularCheckOnly": true,
    "isAccumulateArrears": true,
    "isCalcOnAdjustments": true,
    "isAllowPartial": true,
    "isRestricted": true,
    "goalAmount": 15.0,
    "payCodeRules": [
      {
        "goalAmount": 1.0,
        "startDate": "0001-02-03",
        "employeeCriteriaName": "sample string 2",
        "rateCode": "sample string 3",
        "rate": 4.0,
        "amount": 5.0,
        "minimumAmount": 6.0,
        "maximumAmount": 7.0,
        "otherMaximumAmount": 8.0,
        "otherMaximumType": "None"
      },
      {
        "goalAmount": 1.0,
        "startDate": "0001-02-03",
        "employeeCriteriaName": "sample string 2",
        "rateCode": "sample string 3",
        "rate": 4.0,
        "amount": 5.0,
        "minimumAmount": 6.0,
        "maximumAmount": 7.0,
        "otherMaximumAmount": 8.0,
        "otherMaximumType": "None"
      }
    ],
    "triggerMakeup": true,
    "triggerMakeupEmployeeOption": "Default",
    "maxArrearsBasedOn": "None",
    "maxArrearsPercent": 17.0,
    "code": "sample string 18",
    "isActive": true,
    "isInternal": true,
    "shortDescription": "sample string 21",
    "description": "sample string 22",
    "frequencyCode": "sample string 23",
    "memoOnly": true,
    "displaySequence": 25,
    "w2Label": "sample string 26",
    "effectiveDateOption": "CheckDate",
    "codeAccumulatorCode": "sample string 27",
    "isAllEmployees": true,
    "forceCalculate": true,
    "afterCalcCustomDLLMethodCode": "sample string 30",
    "sbCustomCalcExpressionCode": "sample string 31",
    "bracketAccumulatorCode": "sample string 32",
    "rate": 33.0,
    "rateCode": "sample string 34",
    "employeeCriteriaName": "sample string 35",
    "isTableDriven": true,
    "sequence": 37,
    "amount": 38.0,
    "minimumAmount": 39.0,
    "maximumAmount": 40.0,
    "otherMaximumType": "None",
    "otherMaximumAmount": 41.0,
    "divisionCode": "sample string 42",
    "companyCode": "sample string 43"
  }
]

text/xml

Sample:

<ArrayOfDivisionDeductionImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <DivisionDeductionImportDTO>
    <CompanyCode>sample string 43</CompanyCode>
    <DivisionCode>sample string 42</DivisionCode>
    <AfterCalcCustomDLLMethodCode>sample string 30</AfterCalcCustomDLLMethodCode>
    <Amount>38</Amount>
    <BracketAccumulatorCode>sample string 32</BracketAccumulatorCode>
    <Code>sample string 18</Code>
    <CodeAccumulatorCode>sample string 27</CodeAccumulatorCode>
    <Description>sample string 22</Description>
    <DisplaySequence>25</DisplaySequence>
    <EffectiveDateOption>CheckDate</EffectiveDateOption>
    <EmployeeCriteriaName>sample string 35</EmployeeCriteriaName>
    <ForceCalculate>true</ForceCalculate>
    <FrequencyCode>sample string 23</FrequencyCode>
    <IsActive>true</IsActive>
    <IsAllEmployees>true</IsAllEmployees>
    <IsInternal>true</IsInternal>
    <IsTableDriven>true</IsTableDriven>
    <MaximumAmount>40</MaximumAmount>
    <MemoOnly>true</MemoOnly>
    <MinimumAmount>39</MinimumAmount>
    <OtherMaximumAmount>41</OtherMaximumAmount>
    <OtherMaximumType>None</OtherMaximumType>
    <Rate>33</Rate>
    <RateCode>sample string 34</RateCode>
    <SBCustomCalcExpressionCode>sample string 31</SBCustomCalcExpressionCode>
    <Sequence>37</Sequence>
    <ShortDescription>sample string 21</ShortDescription>
    <W2Label>sample string 26</W2Label>
    <BasedOn>None</BasedOn>
    <DeductionCalcRule>Flat</DeductionCalcRule>
    <DeductionTypeCode>sample string 1</DeductionTypeCode>
    <DependOnOtherDeductionCode>sample string 8</DependOnOtherDeductionCode>
    <DependenceType>None</DependenceType>
    <GoalAmount>15</GoalAmount>
    <IsAccumulateArrears>true</IsAccumulateArrears>
    <IsAllowPartial>true</IsAllowPartial>
    <IsCalcOnAdjustments>true</IsCalcOnAdjustments>
    <IsHealthcareReporting>true</IsHealthcareReporting>
    <IsOncePerPayrollOnly>true</IsOncePerPayrollOnly>
    <IsProrated>true</IsProrated>
    <IsRegularCheckOnly>true</IsRegularCheckOnly>
    <IsRestricted>true</IsRestricted>
    <LienTypeCode>sample string 7</LienTypeCode>
    <MaxArrearsBasedOn>None</MaxArrearsBasedOn>
    <MaxArrearsPercent>17</MaxArrearsPercent>
    <PayCodeRules>
      <DivisionDeductionRuleSubImportDTO>
        <Amount>5</Amount>
        <MaximumAmount>7</MaximumAmount>
        <MinimumAmount>6</MinimumAmount>
        <OtherMaximumAmount>8</OtherMaximumAmount>
        <OtherMaximumType>None</OtherMaximumType>
        <Rate>4</Rate>
        <RateCode>sample string 3</RateCode>
        <EmployeeCriteriaName>sample string 2</EmployeeCriteriaName>
        <StartDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
          <d5p1:Year>1</d5p1:Year>
          <d5p1:Month>2</d5p1:Month>
          <d5p1:Day>3</d5p1:Day>
        </StartDate>
        <GoalAmount>1</GoalAmount>
      </DivisionDeductionRuleSubImportDTO>
      <DivisionDeductionRuleSubImportDTO>
        <Amount>5</Amount>
        <MaximumAmount>7</MaximumAmount>
        <MinimumAmount>6</MinimumAmount>
        <OtherMaximumAmount>8</OtherMaximumAmount>
        <OtherMaximumType>None</OtherMaximumType>
        <Rate>4</Rate>
        <RateCode>sample string 3</RateCode>
        <EmployeeCriteriaName>sample string 2</EmployeeCriteriaName>
        <StartDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
          <d5p1:Year>1</d5p1:Year>
          <d5p1:Month>2</d5p1:Month>
          <d5p1:Day>3</d5p1:Day>
        </StartDate>
        <GoalAmount>1</GoalAmount>
      </DivisionDeductionRuleSubImportDTO>
    </PayCodeRules>
    <PayeeCode>sample string 5</PayeeCode>
    <PrintOnRegister>true</PrintOnRegister>
    <PrintOnStub>true</PrintOnStub>
    <TriggerMakeup>true</TriggerMakeup>
    <TriggerMakeupEmployeeOption>Default</TriggerMakeupEmployeeOption>
    <TriggerOtherDeductionCode>sample string 2</TriggerOtherDeductionCode>
  </DivisionDeductionImportDTO>
  <DivisionDeductionImportDTO>
    <CompanyCode>sample string 43</CompanyCode>
    <DivisionCode>sample string 42</DivisionCode>
    <AfterCalcCustomDLLMethodCode>sample string 30</AfterCalcCustomDLLMethodCode>
    <Amount>38</Amount>
    <BracketAccumulatorCode>sample string 32</BracketAccumulatorCode>
    <Code>sample string 18</Code>
    <CodeAccumulatorCode>sample string 27</CodeAccumulatorCode>
    <Description>sample string 22</Description>
    <DisplaySequence>25</DisplaySequence>
    <EffectiveDateOption>CheckDate</EffectiveDateOption>
    <EmployeeCriteriaName>sample string 35</EmployeeCriteriaName>
    <ForceCalculate>true</ForceCalculate>
    <FrequencyCode>sample string 23</FrequencyCode>
    <IsActive>true</IsActive>
    <IsAllEmployees>true</IsAllEmployees>
    <IsInternal>true</IsInternal>
    <IsTableDriven>true</IsTableDriven>
    <MaximumAmount>40</MaximumAmount>
    <MemoOnly>true</MemoOnly>
    <MinimumAmount>39</MinimumAmount>
    <OtherMaximumAmount>41</OtherMaximumAmount>
    <OtherMaximumType>None</OtherMaximumType>
    <Rate>33</Rate>
    <RateCode>sample string 34</RateCode>
    <SBCustomCalcExpressionCode>sample string 31</SBCustomCalcExpressionCode>
    <Sequence>37</Sequence>
    <ShortDescription>sample string 21</ShortDescription>
    <W2Label>sample string 26</W2Label>
    <BasedOn>None</BasedOn>
    <DeductionCalcRule>Flat</DeductionCalcRule>
    <DeductionTypeCode>sample string 1</DeductionTypeCode>
    <DependOnOtherDeductionCode>sample string 8</DependOnOtherDeductionCode>
    <DependenceType>None</DependenceType>
    <GoalAmount>15</GoalAmount>
    <IsAccumulateArrears>true</IsAccumulateArrears>
    <IsAllowPartial>true</IsAllowPartial>
    <IsCalcOnAdjustments>true</IsCalcOnAdjustments>
    <IsHealthcareReporting>true</IsHealthcareReporting>
    <IsOncePerPayrollOnly>true</IsOncePerPayrollOnly>
    <IsProrated>true</IsProrated>
    <IsRegularCheckOnly>true</IsRegularCheckOnly>
    <IsRestricted>true</IsRestricted>
    <LienTypeCode>sample string 7</LienTypeCode>
    <MaxArrearsBasedOn>None</MaxArrearsBasedOn>
    <MaxArrearsPercent>17</MaxArrearsPercent>
    <PayCodeRules>
      <DivisionDeductionRuleSubImportDTO>
        <Amount>5</Amount>
        <MaximumAmount>7</MaximumAmount>
        <MinimumAmount>6</MinimumAmount>
        <OtherMaximumAmount>8</OtherMaximumAmount>
        <OtherMaximumType>None</OtherMaximumType>
        <Rate>4</Rate>
        <RateCode>sample string 3</RateCode>
        <EmployeeCriteriaName>sample string 2</EmployeeCriteriaName>
        <StartDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
          <d5p1:Year>1</d5p1:Year>
          <d5p1:Month>2</d5p1:Month>
          <d5p1:Day>3</d5p1:Day>
        </StartDate>
        <GoalAmount>1</GoalAmount>
      </DivisionDeductionRuleSubImportDTO>
      <DivisionDeductionRuleSubImportDTO>
        <Amount>5</Amount>
        <MaximumAmount>7</MaximumAmount>
        <MinimumAmount>6</MinimumAmount>
        <OtherMaximumAmount>8</OtherMaximumAmount>
        <OtherMaximumType>None</OtherMaximumType>
        <Rate>4</Rate>
        <RateCode>sample string 3</RateCode>
        <EmployeeCriteriaName>sample string 2</EmployeeCriteriaName>
        <StartDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
          <d5p1:Year>1</d5p1:Year>
          <d5p1:Month>2</d5p1:Month>
          <d5p1:Day>3</d5p1:Day>
        </StartDate>
        <GoalAmount>1</GoalAmount>
      </DivisionDeductionRuleSubImportDTO>
    </PayCodeRules>
    <PayeeCode>sample string 5</PayeeCode>
    <PrintOnRegister>true</PrintOnRegister>
    <PrintOnStub>true</PrintOnStub>
    <TriggerMakeup>true</TriggerMakeup>
    <TriggerMakeupEmployeeOption>Default</TriggerMakeupEmployeeOption>
    <TriggerOtherDeductionCode>sample string 2</TriggerOtherDeductionCode>
  </DivisionDeductionImportDTO>
</ArrayOfDivisionDeductionImportDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The result of the import.

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, text/xml

Sample:

Sample not available.