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

Import Division Earnings

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 DivisionEarningImportDTO

Name	Type	Additional information
IsWorked	boolean	None.
EarningTypeCode	string	None.
OffsetDeductionCode	string	None.
TriggerOtherCode	string	None.
TriggerOption	TriggerOption	None.
CombineTriggeredEarnings	boolean	None.
PrintOnRegister	PrintOnRegister	None.
PrintOnStub	PrintOnRegister	None.
EarningCalcRule	EarningCalcRule	None.
RateRule	RateRule	None.
RateFactor	decimal number	None.
RateSourceOrder	DivisionRateSourceOrder	None.
HoursMultiplier	decimal number	None.
BlockWitholding	boolean	None.
GrossUp	boolean	None.
TransferExtraHrsToCode	string	None.
TransferExtraHrsRateInfo	boolean	None.
SplitByTimeInOut	boolean	None.
MinimumRateRule	MinimumRateRule	None.
MinimumRate	decimal number	None.
MaximumRate	decimal number	None.
MaximumHours	decimal number	None.
PayCodeRules	Collection of DivisionEarningRuleSubImportDTO	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:

[
  {
    "isWorked": true,
    "earningTypeCode": "sample string 2",
    "offsetDeductionCode": "sample string 3",
    "triggerOtherCode": "sample string 4",
    "triggerOption": "TransferHours",
    "combineTriggeredEarnings": true,
    "printOnRegister": "None",
    "printOnStub": "None",
    "earningCalcRule": "HoursxRatexFactor",
    "rateRule": "None",
    "rateFactor": 6.0,
    "rateSourceOrder": "Default",
    "hoursMultiplier": 7.0,
    "blockWitholding": true,
    "grossUp": true,
    "transferExtraHrsToCode": "sample string 10",
    "transferExtraHrsRateInfo": true,
    "splitByTimeInOut": true,
    "minimumRateRule": "Fixed",
    "minimumRate": 13.0,
    "maximumRate": 14.0,
    "maximumHours": 15.0,
    "payCodeRules": [
      {
        "minimumRate": 1.0,
        "maximumRate": 2.0,
        "maximumHours": 3.0,
        "startDate": "0001-02-03",
        "employeeCriteriaName": "sample string 4",
        "rateCode": "sample string 5",
        "rate": 6.0,
        "amount": 7.0,
        "minimumAmount": 8.0,
        "maximumAmount": 9.0,
        "otherMaximumAmount": 10.0,
        "otherMaximumType": "None"
      },
      {
        "minimumRate": 1.0,
        "maximumRate": 2.0,
        "maximumHours": 3.0,
        "startDate": "0001-02-03",
        "employeeCriteriaName": "sample string 4",
        "rateCode": "sample string 5",
        "rate": 6.0,
        "amount": 7.0,
        "minimumAmount": 8.0,
        "maximumAmount": 9.0,
        "otherMaximumAmount": 10.0,
        "otherMaximumType": "None"
      }
    ],
    "code": "sample string 16",
    "isActive": true,
    "isInternal": true,
    "shortDescription": "sample string 19",
    "description": "sample string 20",
    "frequencyCode": "sample string 21",
    "memoOnly": true,
    "displaySequence": 23,
    "w2Label": "sample string 24",
    "effectiveDateOption": "CheckDate",
    "codeAccumulatorCode": "sample string 25",
    "isAllEmployees": true,
    "forceCalculate": true,
    "afterCalcCustomDLLMethodCode": "sample string 28",
    "sbCustomCalcExpressionCode": "sample string 29",
    "bracketAccumulatorCode": "sample string 30",
    "rate": 31.0,
    "rateCode": "sample string 32",
    "employeeCriteriaName": "sample string 33",
    "isTableDriven": true,
    "sequence": 35,
    "amount": 36.0,
    "minimumAmount": 37.0,
    "maximumAmount": 38.0,
    "otherMaximumType": "None",
    "otherMaximumAmount": 39.0,
    "divisionCode": "sample string 40",
    "companyCode": "sample string 41"
  },
  {
    "isWorked": true,
    "earningTypeCode": "sample string 2",
    "offsetDeductionCode": "sample string 3",
    "triggerOtherCode": "sample string 4",
    "triggerOption": "TransferHours",
    "combineTriggeredEarnings": true,
    "printOnRegister": "None",
    "printOnStub": "None",
    "earningCalcRule": "HoursxRatexFactor",
    "rateRule": "None",
    "rateFactor": 6.0,
    "rateSourceOrder": "Default",
    "hoursMultiplier": 7.0,
    "blockWitholding": true,
    "grossUp": true,
    "transferExtraHrsToCode": "sample string 10",
    "transferExtraHrsRateInfo": true,
    "splitByTimeInOut": true,
    "minimumRateRule": "Fixed",
    "minimumRate": 13.0,
    "maximumRate": 14.0,
    "maximumHours": 15.0,
    "payCodeRules": [
      {
        "minimumRate": 1.0,
        "maximumRate": 2.0,
        "maximumHours": 3.0,
        "startDate": "0001-02-03",
        "employeeCriteriaName": "sample string 4",
        "rateCode": "sample string 5",
        "rate": 6.0,
        "amount": 7.0,
        "minimumAmount": 8.0,
        "maximumAmount": 9.0,
        "otherMaximumAmount": 10.0,
        "otherMaximumType": "None"
      },
      {
        "minimumRate": 1.0,
        "maximumRate": 2.0,
        "maximumHours": 3.0,
        "startDate": "0001-02-03",
        "employeeCriteriaName": "sample string 4",
        "rateCode": "sample string 5",
        "rate": 6.0,
        "amount": 7.0,
        "minimumAmount": 8.0,
        "maximumAmount": 9.0,
        "otherMaximumAmount": 10.0,
        "otherMaximumType": "None"
      }
    ],
    "code": "sample string 16",
    "isActive": true,
    "isInternal": true,
    "shortDescription": "sample string 19",
    "description": "sample string 20",
    "frequencyCode": "sample string 21",
    "memoOnly": true,
    "displaySequence": 23,
    "w2Label": "sample string 24",
    "effectiveDateOption": "CheckDate",
    "codeAccumulatorCode": "sample string 25",
    "isAllEmployees": true,
    "forceCalculate": true,
    "afterCalcCustomDLLMethodCode": "sample string 28",
    "sbCustomCalcExpressionCode": "sample string 29",
    "bracketAccumulatorCode": "sample string 30",
    "rate": 31.0,
    "rateCode": "sample string 32",
    "employeeCriteriaName": "sample string 33",
    "isTableDriven": true,
    "sequence": 35,
    "amount": 36.0,
    "minimumAmount": 37.0,
    "maximumAmount": 38.0,
    "otherMaximumType": "None",
    "otherMaximumAmount": 39.0,
    "divisionCode": "sample string 40",
    "companyCode": "sample string 41"
  }
]

text/xml

Sample:

<ArrayOfDivisionEarningImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <DivisionEarningImportDTO>
    <CompanyCode>sample string 41</CompanyCode>
    <DivisionCode>sample string 40</DivisionCode>
    <AfterCalcCustomDLLMethodCode>sample string 28</AfterCalcCustomDLLMethodCode>
    <Amount>36</Amount>
    <BracketAccumulatorCode>sample string 30</BracketAccumulatorCode>
    <Code>sample string 16</Code>
    <CodeAccumulatorCode>sample string 25</CodeAccumulatorCode>
    <Description>sample string 20</Description>
    <DisplaySequence>23</DisplaySequence>
    <EffectiveDateOption>CheckDate</EffectiveDateOption>
    <EmployeeCriteriaName>sample string 33</EmployeeCriteriaName>
    <ForceCalculate>true</ForceCalculate>
    <FrequencyCode>sample string 21</FrequencyCode>
    <IsActive>true</IsActive>
    <IsAllEmployees>true</IsAllEmployees>
    <IsInternal>true</IsInternal>
    <IsTableDriven>true</IsTableDriven>
    <MaximumAmount>38</MaximumAmount>
    <MemoOnly>true</MemoOnly>
    <MinimumAmount>37</MinimumAmount>
    <OtherMaximumAmount>39</OtherMaximumAmount>
    <OtherMaximumType>None</OtherMaximumType>
    <Rate>31</Rate>
    <RateCode>sample string 32</RateCode>
    <SBCustomCalcExpressionCode>sample string 29</SBCustomCalcExpressionCode>
    <Sequence>35</Sequence>
    <ShortDescription>sample string 19</ShortDescription>
    <W2Label>sample string 24</W2Label>
    <BlockWitholding>true</BlockWitholding>
    <CombineTriggeredEarnings>true</CombineTriggeredEarnings>
    <EarningCalcRule>HoursxRatexFactor</EarningCalcRule>
    <EarningTypeCode>sample string 2</EarningTypeCode>
    <GrossUp>true</GrossUp>
    <HoursMultiplier>7</HoursMultiplier>
    <IsWorked>true</IsWorked>
    <MaximumHours>15</MaximumHours>
    <MaximumRate>14</MaximumRate>
    <MinimumRate>13</MinimumRate>
    <MinimumRateRule>Fixed</MinimumRateRule>
    <OffsetDeductionCode>sample string 3</OffsetDeductionCode>
    <PayCodeRules>
      <DivisionEarningRuleSubImportDTO>
        <Amount>7</Amount>
        <MaximumAmount>9</MaximumAmount>
        <MinimumAmount>8</MinimumAmount>
        <OtherMaximumAmount>10</OtherMaximumAmount>
        <OtherMaximumType>None</OtherMaximumType>
        <Rate>6</Rate>
        <RateCode>sample string 5</RateCode>
        <EmployeeCriteriaName>sample string 4</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>
        <MaximumHours>3</MaximumHours>
        <MaximumRate>2</MaximumRate>
        <MinimumRate>1</MinimumRate>
      </DivisionEarningRuleSubImportDTO>
      <DivisionEarningRuleSubImportDTO>
        <Amount>7</Amount>
        <MaximumAmount>9</MaximumAmount>
        <MinimumAmount>8</MinimumAmount>
        <OtherMaximumAmount>10</OtherMaximumAmount>
        <OtherMaximumType>None</OtherMaximumType>
        <Rate>6</Rate>
        <RateCode>sample string 5</RateCode>
        <EmployeeCriteriaName>sample string 4</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>
        <MaximumHours>3</MaximumHours>
        <MaximumRate>2</MaximumRate>
        <MinimumRate>1</MinimumRate>
      </DivisionEarningRuleSubImportDTO>
    </PayCodeRules>
    <PrintOnRegister>None</PrintOnRegister>
    <PrintOnStub>None</PrintOnStub>
    <RateFactor>6</RateFactor>
    <RateRule>None</RateRule>
    <RateSourceOrder>Default</RateSourceOrder>
    <SplitByTimeInOut>true</SplitByTimeInOut>
    <TransferExtraHrsRateInfo>true</TransferExtraHrsRateInfo>
    <TransferExtraHrsToCode>sample string 10</TransferExtraHrsToCode>
    <TriggerOption>TransferHours</TriggerOption>
    <TriggerOtherCode>sample string 4</TriggerOtherCode>
  </DivisionEarningImportDTO>
  <DivisionEarningImportDTO>
    <CompanyCode>sample string 41</CompanyCode>
    <DivisionCode>sample string 40</DivisionCode>
    <AfterCalcCustomDLLMethodCode>sample string 28</AfterCalcCustomDLLMethodCode>
    <Amount>36</Amount>
    <BracketAccumulatorCode>sample string 30</BracketAccumulatorCode>
    <Code>sample string 16</Code>
    <CodeAccumulatorCode>sample string 25</CodeAccumulatorCode>
    <Description>sample string 20</Description>
    <DisplaySequence>23</DisplaySequence>
    <EffectiveDateOption>CheckDate</EffectiveDateOption>
    <EmployeeCriteriaName>sample string 33</EmployeeCriteriaName>
    <ForceCalculate>true</ForceCalculate>
    <FrequencyCode>sample string 21</FrequencyCode>
    <IsActive>true</IsActive>
    <IsAllEmployees>true</IsAllEmployees>
    <IsInternal>true</IsInternal>
    <IsTableDriven>true</IsTableDriven>
    <MaximumAmount>38</MaximumAmount>
    <MemoOnly>true</MemoOnly>
    <MinimumAmount>37</MinimumAmount>
    <OtherMaximumAmount>39</OtherMaximumAmount>
    <OtherMaximumType>None</OtherMaximumType>
    <Rate>31</Rate>
    <RateCode>sample string 32</RateCode>
    <SBCustomCalcExpressionCode>sample string 29</SBCustomCalcExpressionCode>
    <Sequence>35</Sequence>
    <ShortDescription>sample string 19</ShortDescription>
    <W2Label>sample string 24</W2Label>
    <BlockWitholding>true</BlockWitholding>
    <CombineTriggeredEarnings>true</CombineTriggeredEarnings>
    <EarningCalcRule>HoursxRatexFactor</EarningCalcRule>
    <EarningTypeCode>sample string 2</EarningTypeCode>
    <GrossUp>true</GrossUp>
    <HoursMultiplier>7</HoursMultiplier>
    <IsWorked>true</IsWorked>
    <MaximumHours>15</MaximumHours>
    <MaximumRate>14</MaximumRate>
    <MinimumRate>13</MinimumRate>
    <MinimumRateRule>Fixed</MinimumRateRule>
    <OffsetDeductionCode>sample string 3</OffsetDeductionCode>
    <PayCodeRules>
      <DivisionEarningRuleSubImportDTO>
        <Amount>7</Amount>
        <MaximumAmount>9</MaximumAmount>
        <MinimumAmount>8</MinimumAmount>
        <OtherMaximumAmount>10</OtherMaximumAmount>
        <OtherMaximumType>None</OtherMaximumType>
        <Rate>6</Rate>
        <RateCode>sample string 5</RateCode>
        <EmployeeCriteriaName>sample string 4</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>
        <MaximumHours>3</MaximumHours>
        <MaximumRate>2</MaximumRate>
        <MinimumRate>1</MinimumRate>
      </DivisionEarningRuleSubImportDTO>
      <DivisionEarningRuleSubImportDTO>
        <Amount>7</Amount>
        <MaximumAmount>9</MaximumAmount>
        <MinimumAmount>8</MinimumAmount>
        <OtherMaximumAmount>10</OtherMaximumAmount>
        <OtherMaximumType>None</OtherMaximumType>
        <Rate>6</Rate>
        <RateCode>sample string 5</RateCode>
        <EmployeeCriteriaName>sample string 4</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>
        <MaximumHours>3</MaximumHours>
        <MaximumRate>2</MaximumRate>
        <MinimumRate>1</MinimumRate>
      </DivisionEarningRuleSubImportDTO>
    </PayCodeRules>
    <PrintOnRegister>None</PrintOnRegister>
    <PrintOnStub>None</PrintOnStub>
    <RateFactor>6</RateFactor>
    <RateRule>None</RateRule>
    <RateSourceOrder>Default</RateSourceOrder>
    <SplitByTimeInOut>true</SplitByTimeInOut>
    <TransferExtraHrsRateInfo>true</TransferExtraHrsRateInfo>
    <TransferExtraHrsToCode>sample string 10</TransferExtraHrsToCode>
    <TriggerOption>TransferHours</TriggerOption>
    <TriggerOtherCode>sample string 4</TriggerOtherCode>
  </DivisionEarningImportDTO>
</ArrayOfDivisionEarningImportDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The results 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.