POST v1/imports/direct-deposits?importAction={importAction}&allowSameFile={allowSameFile}

Import Direct Deposits

Request Information

URI Parameters

Name	Description	Type	Additional information
importAction	The import action.	ImportAction	Default value is Replace
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 DirectDepositImportDTO

Name	Type	Additional information
TransABA	string	None.
AccountNumber	string	None.
DDCalculationType	DDCalculationType	None.
Amount	decimal number	None.
Sequence	integer	None.
StartDate	date	None.
EndDate	date	None.
BlockOnAdditionalChecks	boolean	None.
PreNoteEndDate	date	None.
ACHAccountType	string	None.
EmployeeNumber	string	None.
EmployeePersonalId	integer	None.
DivisionCode	string	None.
CompanyCode	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "transABA": "sample string 1",
    "accountNumber": "sample string 2",
    "ddCalculationType": "Flat",
    "amount": 3.0,
    "sequence": 4,
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "blockOnAdditionalChecks": true,
    "preNoteEndDate": "0001-02-03",
    "achAccountType": "sample string 6",
    "employeeNumber": "sample string 7",
    "employeePersonalId": 1,
    "divisionCode": "sample string 8",
    "companyCode": "sample string 9"
  },
  {
    "transABA": "sample string 1",
    "accountNumber": "sample string 2",
    "ddCalculationType": "Flat",
    "amount": 3.0,
    "sequence": 4,
    "startDate": "0001-02-03",
    "endDate": "0001-02-03",
    "blockOnAdditionalChecks": true,
    "preNoteEndDate": "0001-02-03",
    "achAccountType": "sample string 6",
    "employeeNumber": "sample string 7",
    "employeePersonalId": 1,
    "divisionCode": "sample string 8",
    "companyCode": "sample string 9"
  }
]

text/xml

Sample:

<ArrayOfDirectDepositImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <DirectDepositImportDTO>
    <CompanyCode>sample string 9</CompanyCode>
    <DivisionCode>sample string 8</DivisionCode>
    <EmployeeNumber>sample string 7</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <ACHAccountType>sample string 6</ACHAccountType>
    <AccountNumber>sample string 2</AccountNumber>
    <Amount>3</Amount>
    <BlockOnAdditionalChecks>true</BlockOnAdditionalChecks>
    <DDCalculationType>Flat</DDCalculationType>
    <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>
    <PreNoteEndDate 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>
    </PreNoteEndDate>
    <Sequence>4</Sequence>
    <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>
    <TransABA>sample string 1</TransABA>
  </DirectDepositImportDTO>
  <DirectDepositImportDTO>
    <CompanyCode>sample string 9</CompanyCode>
    <DivisionCode>sample string 8</DivisionCode>
    <EmployeeNumber>sample string 7</EmployeeNumber>
    <EmployeePersonalId>1</EmployeePersonalId>
    <ACHAccountType>sample string 6</ACHAccountType>
    <AccountNumber>sample string 2</AccountNumber>
    <Amount>3</Amount>
    <BlockOnAdditionalChecks>true</BlockOnAdditionalChecks>
    <DDCalculationType>Flat</DDCalculationType>
    <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>
    <PreNoteEndDate 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>
    </PreNoteEndDate>
    <Sequence>4</Sequence>
    <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>
    <TransABA>sample string 1</TransABA>
  </DirectDepositImportDTO>
</ArrayOfDirectDepositImportDTO>

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.