POST v1/imports/accumulators?action={action}&allowSameFile={allowSameFile}
Import Division Accumulators
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 AccumulatorImportDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Code | string |
Required |
|
| Description | string |
None. |
|
| Scope | Scope |
None. |
|
| NetPayAction | Action |
None. |
|
| DirectDepositAction | Action |
None. |
|
| AccumulatorListType | AccumulatorListType |
None. |
|
| Rules | Collection of AccumulatorRuleSubImportDTO |
None. |
|
| RequiresEarnings | boolean |
None. |
|
| RequiresDeductions | boolean |
None. |
|
| DivisionCode | string |
None. |
|
| CompanyCode | string |
Required |
Request Formats
application/json, text/json
Sample:
[
{
"code": "sample string 1",
"description": "sample string 2",
"scope": "Ytd",
"netPayAction": "None",
"directDepositAction": "None",
"accumulatorListType": "Accumulators",
"rules": [
{
"accumulatorType": "EarningHours",
"accumulatorTypeCode": "sample string 1",
"includeAll": true,
"action": "None",
"rate": 3.0,
"roundingAction": "None",
"roundingDecimals": 4,
"jobCode": "sample string 5",
"costCenter1Code": "sample string 6",
"costCenter2Code": "sample string 7",
"costCenter3Code": "sample string 8",
"costCenter4Code": "sample string 9",
"costCenter5Code": "sample string 10"
},
{
"accumulatorType": "EarningHours",
"accumulatorTypeCode": "sample string 1",
"includeAll": true,
"action": "None",
"rate": 3.0,
"roundingAction": "None",
"roundingDecimals": 4,
"jobCode": "sample string 5",
"costCenter1Code": "sample string 6",
"costCenter2Code": "sample string 7",
"costCenter3Code": "sample string 8",
"costCenter4Code": "sample string 9",
"costCenter5Code": "sample string 10"
}
],
"requiresEarnings": true,
"requiresDeductions": true,
"divisionCode": "sample string 5",
"companyCode": "sample string 6"
},
{
"code": "sample string 1",
"description": "sample string 2",
"scope": "Ytd",
"netPayAction": "None",
"directDepositAction": "None",
"accumulatorListType": "Accumulators",
"rules": [
{
"accumulatorType": "EarningHours",
"accumulatorTypeCode": "sample string 1",
"includeAll": true,
"action": "None",
"rate": 3.0,
"roundingAction": "None",
"roundingDecimals": 4,
"jobCode": "sample string 5",
"costCenter1Code": "sample string 6",
"costCenter2Code": "sample string 7",
"costCenter3Code": "sample string 8",
"costCenter4Code": "sample string 9",
"costCenter5Code": "sample string 10"
},
{
"accumulatorType": "EarningHours",
"accumulatorTypeCode": "sample string 1",
"includeAll": true,
"action": "None",
"rate": 3.0,
"roundingAction": "None",
"roundingDecimals": 4,
"jobCode": "sample string 5",
"costCenter1Code": "sample string 6",
"costCenter2Code": "sample string 7",
"costCenter3Code": "sample string 8",
"costCenter4Code": "sample string 9",
"costCenter5Code": "sample string 10"
}
],
"requiresEarnings": true,
"requiresDeductions": true,
"divisionCode": "sample string 5",
"companyCode": "sample string 6"
}
]
text/xml
Sample:
<ArrayOfAccumulatorImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
<AccumulatorImportDTO>
<CompanyCode>sample string 6</CompanyCode>
<DivisionCode>sample string 5</DivisionCode>
<AccumulatorListType>Accumulators</AccumulatorListType>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
<DirectDepositAction>None</DirectDepositAction>
<NetPayAction>None</NetPayAction>
<RequiresDeductions>true</RequiresDeductions>
<RequiresEarnings>true</RequiresEarnings>
<Rules>
<AccumulatorRuleSubImportDTO>
<AccumulatorType>EarningHours</AccumulatorType>
<AccumulatorTypeCode>sample string 1</AccumulatorTypeCode>
<Action>None</Action>
<CostCenter1Code>sample string 6</CostCenter1Code>
<CostCenter2Code>sample string 7</CostCenter2Code>
<CostCenter3Code>sample string 8</CostCenter3Code>
<CostCenter4Code>sample string 9</CostCenter4Code>
<CostCenter5Code>sample string 10</CostCenter5Code>
<IncludeAll>true</IncludeAll>
<JobCode>sample string 5</JobCode>
<Rate>3</Rate>
<RoundingAction>None</RoundingAction>
<RoundingDecimals>4</RoundingDecimals>
</AccumulatorRuleSubImportDTO>
<AccumulatorRuleSubImportDTO>
<AccumulatorType>EarningHours</AccumulatorType>
<AccumulatorTypeCode>sample string 1</AccumulatorTypeCode>
<Action>None</Action>
<CostCenter1Code>sample string 6</CostCenter1Code>
<CostCenter2Code>sample string 7</CostCenter2Code>
<CostCenter3Code>sample string 8</CostCenter3Code>
<CostCenter4Code>sample string 9</CostCenter4Code>
<CostCenter5Code>sample string 10</CostCenter5Code>
<IncludeAll>true</IncludeAll>
<JobCode>sample string 5</JobCode>
<Rate>3</Rate>
<RoundingAction>None</RoundingAction>
<RoundingDecimals>4</RoundingDecimals>
</AccumulatorRuleSubImportDTO>
</Rules>
<Scope>Ytd</Scope>
</AccumulatorImportDTO>
<AccumulatorImportDTO>
<CompanyCode>sample string 6</CompanyCode>
<DivisionCode>sample string 5</DivisionCode>
<AccumulatorListType>Accumulators</AccumulatorListType>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
<DirectDepositAction>None</DirectDepositAction>
<NetPayAction>None</NetPayAction>
<RequiresDeductions>true</RequiresDeductions>
<RequiresEarnings>true</RequiresEarnings>
<Rules>
<AccumulatorRuleSubImportDTO>
<AccumulatorType>EarningHours</AccumulatorType>
<AccumulatorTypeCode>sample string 1</AccumulatorTypeCode>
<Action>None</Action>
<CostCenter1Code>sample string 6</CostCenter1Code>
<CostCenter2Code>sample string 7</CostCenter2Code>
<CostCenter3Code>sample string 8</CostCenter3Code>
<CostCenter4Code>sample string 9</CostCenter4Code>
<CostCenter5Code>sample string 10</CostCenter5Code>
<IncludeAll>true</IncludeAll>
<JobCode>sample string 5</JobCode>
<Rate>3</Rate>
<RoundingAction>None</RoundingAction>
<RoundingDecimals>4</RoundingDecimals>
</AccumulatorRuleSubImportDTO>
<AccumulatorRuleSubImportDTO>
<AccumulatorType>EarningHours</AccumulatorType>
<AccumulatorTypeCode>sample string 1</AccumulatorTypeCode>
<Action>None</Action>
<CostCenter1Code>sample string 6</CostCenter1Code>
<CostCenter2Code>sample string 7</CostCenter2Code>
<CostCenter3Code>sample string 8</CostCenter3Code>
<CostCenter4Code>sample string 9</CostCenter4Code>
<CostCenter5Code>sample string 10</CostCenter5Code>
<IncludeAll>true</IncludeAll>
<JobCode>sample string 5</JobCode>
<Rate>3</Rate>
<RoundingAction>None</RoundingAction>
<RoundingDecimals>4</RoundingDecimals>
</AccumulatorRuleSubImportDTO>
</Rules>
<Scope>Ytd</Scope>
</AccumulatorImportDTO>
</ArrayOfAccumulatorImportDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The results of the import.
ImportResultDTO| Name | Description | 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.