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

Import Divisions

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 DivisionImportDTO

Name	Type	Additional information
DivisionCode	string	None.
ClientCode	string	None.
Client	ClientSubImportDTO	None.
Company	CompanySubImportDTO	None.
Name	string	None.
DBAName	string	None.
Address	AddressDTO	None.
PayrollContact	ContactSubImportDTO	None.
ExecutiveContact	ContactSubImportDTO	None.
PayrollFrequency	CompanyWizardPayFreq	None.
MoveOnCheckDate	MoveHoliday	None.
PeriodBegin	date	None.
PeriodEnd	date	None.
CheckDate	date	None.
ProcessingDate	date	None.
SecondPeriodBegin	date	None.
SecondPeriodEnd	date	None.
SecondCheckDate	date	None.
SecondProcessingDate	date	None.
CompanyCode	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "divisionCode": "sample string 1",
    "clientCode": "sample string 2",
    "client": {
      "name": "sample string 1"
    },
    "company": {
      "federalId": "sample string 1",
      "name": "sample string 2",
      "dbaName": "sample string 3",
      "address": {
        "address1": "sample string 1",
        "address2": "sample string 2",
        "city": "sample string 3",
        "state": "sample string 4",
        "zip": "sample string 5",
        "country": "sample string 6",
        "county": "sample string 7"
      },
      "taxService": "None",
      "federalDepositFrequency": "EveryPayroll",
      "defaultSITTax": "sample string 4",
      "defaultSUITax": "sample string 5",
      "defaultLOCTax": "sample string 6",
      "suiTaxRate": 7.0,
      "bank": {
        "abaBankNumber": "sample string 1",
        "abaAccountNumber": "sample string 2",
        "startingCheckNumber": 3,
        "address": {
          "address1": "sample string 1",
          "address2": "sample string 2",
          "city": "sample string 3",
          "state": "sample string 4",
          "zip": "sample string 5",
          "country": "sample string 6",
          "county": "sample string 7"
        }
      },
      "sicCode": "sample string 8"
    },
    "name": "sample string 3",
    "dbaName": "sample string 4",
    "address": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "zip": "sample string 5",
      "country": "sample string 6",
      "county": "sample string 7"
    },
    "payrollContact": {
      "title": "sample string 1",
      "firstName": "sample string 2",
      "middleInitial": "A",
      "lastName": "sample string 3",
      "homePhone": "sample string 4",
      "mobilePhone": "sample string 5",
      "workPhone": "sample string 6",
      "fax": "sample string 7",
      "email": "sample string 8"
    },
    "executiveContact": {
      "title": "sample string 1",
      "firstName": "sample string 2",
      "middleInitial": "A",
      "lastName": "sample string 3",
      "homePhone": "sample string 4",
      "mobilePhone": "sample string 5",
      "workPhone": "sample string 6",
      "fax": "sample string 7",
      "email": "sample string 8"
    },
    "payrollFrequency": "Weekly",
    "moveOnCheckDate": "None",
    "periodBegin": "0001-02-03",
    "periodEnd": "0001-02-03",
    "checkDate": "0001-02-03",
    "processingDate": "0001-02-03",
    "secondPeriodBegin": "0001-02-03",
    "secondPeriodEnd": "0001-02-03",
    "secondCheckDate": "0001-02-03",
    "secondProcessingDate": "0001-02-03",
    "companyCode": "sample string 5"
  },
  {
    "divisionCode": "sample string 1",
    "clientCode": "sample string 2",
    "client": {
      "name": "sample string 1"
    },
    "company": {
      "federalId": "sample string 1",
      "name": "sample string 2",
      "dbaName": "sample string 3",
      "address": {
        "address1": "sample string 1",
        "address2": "sample string 2",
        "city": "sample string 3",
        "state": "sample string 4",
        "zip": "sample string 5",
        "country": "sample string 6",
        "county": "sample string 7"
      },
      "taxService": "None",
      "federalDepositFrequency": "EveryPayroll",
      "defaultSITTax": "sample string 4",
      "defaultSUITax": "sample string 5",
      "defaultLOCTax": "sample string 6",
      "suiTaxRate": 7.0,
      "bank": {
        "abaBankNumber": "sample string 1",
        "abaAccountNumber": "sample string 2",
        "startingCheckNumber": 3,
        "address": {
          "address1": "sample string 1",
          "address2": "sample string 2",
          "city": "sample string 3",
          "state": "sample string 4",
          "zip": "sample string 5",
          "country": "sample string 6",
          "county": "sample string 7"
        }
      },
      "sicCode": "sample string 8"
    },
    "name": "sample string 3",
    "dbaName": "sample string 4",
    "address": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "zip": "sample string 5",
      "country": "sample string 6",
      "county": "sample string 7"
    },
    "payrollContact": {
      "title": "sample string 1",
      "firstName": "sample string 2",
      "middleInitial": "A",
      "lastName": "sample string 3",
      "homePhone": "sample string 4",
      "mobilePhone": "sample string 5",
      "workPhone": "sample string 6",
      "fax": "sample string 7",
      "email": "sample string 8"
    },
    "executiveContact": {
      "title": "sample string 1",
      "firstName": "sample string 2",
      "middleInitial": "A",
      "lastName": "sample string 3",
      "homePhone": "sample string 4",
      "mobilePhone": "sample string 5",
      "workPhone": "sample string 6",
      "fax": "sample string 7",
      "email": "sample string 8"
    },
    "payrollFrequency": "Weekly",
    "moveOnCheckDate": "None",
    "periodBegin": "0001-02-03",
    "periodEnd": "0001-02-03",
    "checkDate": "0001-02-03",
    "processingDate": "0001-02-03",
    "secondPeriodBegin": "0001-02-03",
    "secondPeriodEnd": "0001-02-03",
    "secondCheckDate": "0001-02-03",
    "secondProcessingDate": "0001-02-03",
    "companyCode": "sample string 5"
  }
]

text/xml

Sample:

<ArrayOfDivisionImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <DivisionImportDTO>
    <CompanyCode>sample string 5</CompanyCode>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:County>sample string 7</d3p1:County>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <CheckDate 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>
    </CheckDate>
    <Client>
      <Name>sample string 1</Name>
    </Client>
    <ClientCode>sample string 2</ClientCode>
    <Company>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>sample string 6</d4p1:Country>
        <d4p1:County>sample string 7</d4p1:County>
        <d4p1:State>sample string 4</d4p1:State>
        <d4p1:Zip>sample string 5</d4p1:Zip>
      </Address>
      <Bank>
        <ABAAccountNumber>sample string 2</ABAAccountNumber>
        <ABABankNumber>sample string 1</ABABankNumber>
        <Address xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
          <d5p1:Address1>sample string 1</d5p1:Address1>
          <d5p1:Address2>sample string 2</d5p1:Address2>
          <d5p1:City>sample string 3</d5p1:City>
          <d5p1:Country>sample string 6</d5p1:Country>
          <d5p1:County>sample string 7</d5p1:County>
          <d5p1:State>sample string 4</d5p1:State>
          <d5p1:Zip>sample string 5</d5p1:Zip>
        </Address>
        <StartingCheckNumber>3</StartingCheckNumber>
      </Bank>
      <DBAName>sample string 3</DBAName>
      <DefaultLOCTax>sample string 6</DefaultLOCTax>
      <DefaultSITTax>sample string 4</DefaultSITTax>
      <DefaultSUITax>sample string 5</DefaultSUITax>
      <FederalDepositFrequency>EveryPayroll</FederalDepositFrequency>
      <FederalId>sample string 1</FederalId>
      <Name>sample string 2</Name>
      <SICCode>sample string 8</SICCode>
      <SUITaxRate>7</SUITaxRate>
      <TaxService>None</TaxService>
    </Company>
    <DBAName>sample string 4</DBAName>
    <DivisionCode>sample string 1</DivisionCode>
    <ExecutiveContact>
      <Email>sample string 8</Email>
      <Fax>sample string 7</Fax>
      <FirstName>sample string 2</FirstName>
      <HomePhone>sample string 4</HomePhone>
      <LastName>sample string 3</LastName>
      <MiddleInitial>65</MiddleInitial>
      <MobilePhone>sample string 5</MobilePhone>
      <Title>sample string 1</Title>
      <WorkPhone>sample string 6</WorkPhone>
    </ExecutiveContact>
    <MoveOnCheckDate>None</MoveOnCheckDate>
    <Name>sample string 3</Name>
    <PayrollContact>
      <Email>sample string 8</Email>
      <Fax>sample string 7</Fax>
      <FirstName>sample string 2</FirstName>
      <HomePhone>sample string 4</HomePhone>
      <LastName>sample string 3</LastName>
      <MiddleInitial>65</MiddleInitial>
      <MobilePhone>sample string 5</MobilePhone>
      <Title>sample string 1</Title>
      <WorkPhone>sample string 6</WorkPhone>
    </PayrollContact>
    <PayrollFrequency>Weekly</PayrollFrequency>
    <PeriodBegin 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>
    </PeriodBegin>
    <PeriodEnd 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>
    </PeriodEnd>
    <ProcessingDate 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>
    </ProcessingDate>
    <SecondCheckDate 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>
    </SecondCheckDate>
    <SecondPeriodBegin 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>
    </SecondPeriodBegin>
    <SecondPeriodEnd 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>
    </SecondPeriodEnd>
    <SecondProcessingDate 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>
    </SecondProcessingDate>
  </DivisionImportDTO>
  <DivisionImportDTO>
    <CompanyCode>sample string 5</CompanyCode>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:County>sample string 7</d3p1:County>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <CheckDate 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>
    </CheckDate>
    <Client>
      <Name>sample string 1</Name>
    </Client>
    <ClientCode>sample string 2</ClientCode>
    <Company>
      <Address xmlns:d4p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
        <d4p1:Address1>sample string 1</d4p1:Address1>
        <d4p1:Address2>sample string 2</d4p1:Address2>
        <d4p1:City>sample string 3</d4p1:City>
        <d4p1:Country>sample string 6</d4p1:Country>
        <d4p1:County>sample string 7</d4p1:County>
        <d4p1:State>sample string 4</d4p1:State>
        <d4p1:Zip>sample string 5</d4p1:Zip>
      </Address>
      <Bank>
        <ABAAccountNumber>sample string 2</ABAAccountNumber>
        <ABABankNumber>sample string 1</ABABankNumber>
        <Address xmlns:d5p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
          <d5p1:Address1>sample string 1</d5p1:Address1>
          <d5p1:Address2>sample string 2</d5p1:Address2>
          <d5p1:City>sample string 3</d5p1:City>
          <d5p1:Country>sample string 6</d5p1:Country>
          <d5p1:County>sample string 7</d5p1:County>
          <d5p1:State>sample string 4</d5p1:State>
          <d5p1:Zip>sample string 5</d5p1:Zip>
        </Address>
        <StartingCheckNumber>3</StartingCheckNumber>
      </Bank>
      <DBAName>sample string 3</DBAName>
      <DefaultLOCTax>sample string 6</DefaultLOCTax>
      <DefaultSITTax>sample string 4</DefaultSITTax>
      <DefaultSUITax>sample string 5</DefaultSUITax>
      <FederalDepositFrequency>EveryPayroll</FederalDepositFrequency>
      <FederalId>sample string 1</FederalId>
      <Name>sample string 2</Name>
      <SICCode>sample string 8</SICCode>
      <SUITaxRate>7</SUITaxRate>
      <TaxService>None</TaxService>
    </Company>
    <DBAName>sample string 4</DBAName>
    <DivisionCode>sample string 1</DivisionCode>
    <ExecutiveContact>
      <Email>sample string 8</Email>
      <Fax>sample string 7</Fax>
      <FirstName>sample string 2</FirstName>
      <HomePhone>sample string 4</HomePhone>
      <LastName>sample string 3</LastName>
      <MiddleInitial>65</MiddleInitial>
      <MobilePhone>sample string 5</MobilePhone>
      <Title>sample string 1</Title>
      <WorkPhone>sample string 6</WorkPhone>
    </ExecutiveContact>
    <MoveOnCheckDate>None</MoveOnCheckDate>
    <Name>sample string 3</Name>
    <PayrollContact>
      <Email>sample string 8</Email>
      <Fax>sample string 7</Fax>
      <FirstName>sample string 2</FirstName>
      <HomePhone>sample string 4</HomePhone>
      <LastName>sample string 3</LastName>
      <MiddleInitial>65</MiddleInitial>
      <MobilePhone>sample string 5</MobilePhone>
      <Title>sample string 1</Title>
      <WorkPhone>sample string 6</WorkPhone>
    </PayrollContact>
    <PayrollFrequency>Weekly</PayrollFrequency>
    <PeriodBegin 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>
    </PeriodBegin>
    <PeriodEnd 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>
    </PeriodEnd>
    <ProcessingDate 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>
    </ProcessingDate>
    <SecondCheckDate 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>
    </SecondCheckDate>
    <SecondPeriodBegin 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>
    </SecondPeriodBegin>
    <SecondPeriodEnd 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>
    </SecondPeriodEnd>
    <SecondProcessingDate 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>
    </SecondProcessingDate>
  </DivisionImportDTO>
</ArrayOfDivisionImportDTO>

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

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>