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

Import Payees

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 PayeeImportDTO

Name	Type	Additional information
Code	string	Required
Name	string	None.
Name2	string	None.
IsRestricted	boolean	None.
Address	AddressDTO	None.
TransABA	string	None.
AccountNumber	string	None.
AccountType	string	None.
PayMethod	PayMethod	None.
PayFrequencyCode	string	None.
PrenoteDate	date	None.
PayeeType	PayeeType	None.
FIPSCode	string	None.
DivisionCode	string	None.
CompanyCode	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "code": "sample string 1",
    "name": "sample string 2",
    "name2": "sample string 3",
    "isRestricted": true,
    "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"
    },
    "transABA": "sample string 4",
    "accountNumber": "sample string 5",
    "accountType": "sample string 6",
    "payMethod": "Check",
    "payFrequencyCode": "sample string 7",
    "prenoteDate": "2025-10-28T10:27:02.3272806Z",
    "payeeType": "Other",
    "fipsCode": "sample string 8",
    "divisionCode": "sample string 9",
    "companyCode": "sample string 10"
  },
  {
    "code": "sample string 1",
    "name": "sample string 2",
    "name2": "sample string 3",
    "isRestricted": true,
    "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"
    },
    "transABA": "sample string 4",
    "accountNumber": "sample string 5",
    "accountType": "sample string 6",
    "payMethod": "Check",
    "payFrequencyCode": "sample string 7",
    "prenoteDate": "2025-10-28T10:27:02.3272806Z",
    "payeeType": "Other",
    "fipsCode": "sample string 8",
    "divisionCode": "sample string 9",
    "companyCode": "sample string 10"
  }
]

text/xml

Sample:

<ArrayOfPayeeImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <PayeeImportDTO>
    <CompanyCode>sample string 10</CompanyCode>
    <DivisionCode>sample string 9</DivisionCode>
    <AccountNumber>sample string 5</AccountNumber>
    <AccountType>sample string 6</AccountType>
    <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>
    <Code>sample string 1</Code>
    <FIPSCode>sample string 8</FIPSCode>
    <IsRestricted>true</IsRestricted>
    <Name>sample string 2</Name>
    <Name2>sample string 3</Name2>
    <PayFrequencyCode>sample string 7</PayFrequencyCode>
    <PayMethod>Check</PayMethod>
    <PayeeType>Other</PayeeType>
    <PrenoteDate>2025-10-28T06:27:02.3272806-04:00</PrenoteDate>
    <TransABA>sample string 4</TransABA>
  </PayeeImportDTO>
  <PayeeImportDTO>
    <CompanyCode>sample string 10</CompanyCode>
    <DivisionCode>sample string 9</DivisionCode>
    <AccountNumber>sample string 5</AccountNumber>
    <AccountType>sample string 6</AccountType>
    <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>
    <Code>sample string 1</Code>
    <FIPSCode>sample string 8</FIPSCode>
    <IsRestricted>true</IsRestricted>
    <Name>sample string 2</Name>
    <Name2>sample string 3</Name2>
    <PayFrequencyCode>sample string 7</PayFrequencyCode>
    <PayMethod>Check</PayMethod>
    <PayeeType>Other</PayeeType>
    <PrenoteDate>2025-10-28T06:27:02.3272806-04:00</PrenoteDate>
    <TransABA>sample string 4</TransABA>
  </PayeeImportDTO>
</ArrayOfPayeeImportDTO>

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.