GET v1/cms/export/companies?companyCount={companyCount}&afterCompanyCode={afterCompanyCode}

Retrieve CMS Companies

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCount		integer	Default value is 100
afterCompanyCode		string	Default value is

Body Parameters

None.

Response Information

Resource Description

ExportCMSCompanyResultDTO

Name	Description	Type	Additional information
Companies		Collection of ExportCMSCompanyDTO	None.
LastCompanyCode		string	None.

Response Formats

application/json, text/json

Sample:

{
  "companies": [
    {
      "clientCode": "sample string 1",
      "clientName": "sample string 2",
      "legalName": "sample string 3",
      "dbaName": "sample string 4",
      "companyCode": "sample string 5",
      "startDate": "0001-02-03",
      "salesPerson": "sample string 6",
      "fedId": "sample string 7",
      "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"
      },
      "firstCheckDate": "0001-02-03",
      "isLive": true,
      "activeEmployeeCount": 9,
      "divisions": [
        {
          "name": "sample string 1",
          "executiveContact": "sample string 2",
          "payrollContact": "sample string 3",
          "setupRep": "sample string 4",
          "customServiceRep": "sample string 5",
          "teleDataRep": "sample string 6",
          "dataEntryRep": "sample string 7",
          "dataEntryRep2": "sample string 8",
          "holdForBilling": true,
          "holdForCustomerService": true,
          "holdForTaxService": true,
          "holdForOperation": true,
          "holdQuarterlyProcess": true,
          "holdQuarterlyProcessComment": "sample string 14",
          "hold1099Printing": true,
          "status": "Active",
          "termDate": "0001-02-03",
          "termReason": "sample string 16",
          "inputMethod": "Fax",
          "isAutoSubmit": true,
          "processingFrequency": "Weekly",
          "salesPerson": "sample string 18",
          "activeEmployeeCount": 19,
          "directDepositMinimumDays": 20,
          "directDepositDebitDays": 21,
          "directDepositThreshold": 22.0,
          "directDepositThresholdIfLate": 23.0,
          "taxLiabilityLimit": 24.0,
          "taxLiabilityMinimumDays": 25,
          "taxLiabilityLimitMinimumDays": 26,
          "hasQuarterlyReportsPrinted": true,
          "hasW2Printed": true,
          "hasReportsPrinted": true,
          "hasChecksPrinted": true,
          "companyCode": "sample string 31",
          "divisionCode": "sample string 32"
        },
        {
          "name": "sample string 1",
          "executiveContact": "sample string 2",
          "payrollContact": "sample string 3",
          "setupRep": "sample string 4",
          "customServiceRep": "sample string 5",
          "teleDataRep": "sample string 6",
          "dataEntryRep": "sample string 7",
          "dataEntryRep2": "sample string 8",
          "holdForBilling": true,
          "holdForCustomerService": true,
          "holdForTaxService": true,
          "holdForOperation": true,
          "holdQuarterlyProcess": true,
          "holdQuarterlyProcessComment": "sample string 14",
          "hold1099Printing": true,
          "status": "Active",
          "termDate": "0001-02-03",
          "termReason": "sample string 16",
          "inputMethod": "Fax",
          "isAutoSubmit": true,
          "processingFrequency": "Weekly",
          "salesPerson": "sample string 18",
          "activeEmployeeCount": 19,
          "directDepositMinimumDays": 20,
          "directDepositDebitDays": 21,
          "directDepositThreshold": 22.0,
          "directDepositThresholdIfLate": 23.0,
          "taxLiabilityLimit": 24.0,
          "taxLiabilityMinimumDays": 25,
          "taxLiabilityLimitMinimumDays": 26,
          "hasQuarterlyReportsPrinted": true,
          "hasW2Printed": true,
          "hasReportsPrinted": true,
          "hasChecksPrinted": true,
          "companyCode": "sample string 31",
          "divisionCode": "sample string 32"
        }
      ],
      "serviceOptions": null
    },
    {
      "clientCode": "sample string 1",
      "clientName": "sample string 2",
      "legalName": "sample string 3",
      "dbaName": "sample string 4",
      "companyCode": "sample string 5",
      "startDate": "0001-02-03",
      "salesPerson": "sample string 6",
      "fedId": "sample string 7",
      "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"
      },
      "firstCheckDate": "0001-02-03",
      "isLive": true,
      "activeEmployeeCount": 9,
      "divisions": [
        {
          "name": "sample string 1",
          "executiveContact": "sample string 2",
          "payrollContact": "sample string 3",
          "setupRep": "sample string 4",
          "customServiceRep": "sample string 5",
          "teleDataRep": "sample string 6",
          "dataEntryRep": "sample string 7",
          "dataEntryRep2": "sample string 8",
          "holdForBilling": true,
          "holdForCustomerService": true,
          "holdForTaxService": true,
          "holdForOperation": true,
          "holdQuarterlyProcess": true,
          "holdQuarterlyProcessComment": "sample string 14",
          "hold1099Printing": true,
          "status": "Active",
          "termDate": "0001-02-03",
          "termReason": "sample string 16",
          "inputMethod": "Fax",
          "isAutoSubmit": true,
          "processingFrequency": "Weekly",
          "salesPerson": "sample string 18",
          "activeEmployeeCount": 19,
          "directDepositMinimumDays": 20,
          "directDepositDebitDays": 21,
          "directDepositThreshold": 22.0,
          "directDepositThresholdIfLate": 23.0,
          "taxLiabilityLimit": 24.0,
          "taxLiabilityMinimumDays": 25,
          "taxLiabilityLimitMinimumDays": 26,
          "hasQuarterlyReportsPrinted": true,
          "hasW2Printed": true,
          "hasReportsPrinted": true,
          "hasChecksPrinted": true,
          "companyCode": "sample string 31",
          "divisionCode": "sample string 32"
        },
        {
          "name": "sample string 1",
          "executiveContact": "sample string 2",
          "payrollContact": "sample string 3",
          "setupRep": "sample string 4",
          "customServiceRep": "sample string 5",
          "teleDataRep": "sample string 6",
          "dataEntryRep": "sample string 7",
          "dataEntryRep2": "sample string 8",
          "holdForBilling": true,
          "holdForCustomerService": true,
          "holdForTaxService": true,
          "holdForOperation": true,
          "holdQuarterlyProcess": true,
          "holdQuarterlyProcessComment": "sample string 14",
          "hold1099Printing": true,
          "status": "Active",
          "termDate": "0001-02-03",
          "termReason": "sample string 16",
          "inputMethod": "Fax",
          "isAutoSubmit": true,
          "processingFrequency": "Weekly",
          "salesPerson": "sample string 18",
          "activeEmployeeCount": 19,
          "directDepositMinimumDays": 20,
          "directDepositDebitDays": 21,
          "directDepositThreshold": 22.0,
          "directDepositThresholdIfLate": 23.0,
          "taxLiabilityLimit": 24.0,
          "taxLiabilityMinimumDays": 25,
          "taxLiabilityLimitMinimumDays": 26,
          "hasQuarterlyReportsPrinted": true,
          "hasW2Printed": true,
          "hasReportsPrinted": true,
          "hasChecksPrinted": true,
          "companyCode": "sample string 31",
          "divisionCode": "sample string 32"
        }
      ],
      "serviceOptions": null
    }
  ],
  "lastCompanyCode": "sample string 1"
}

text/xml

Sample:

<ExportCMSCompanyResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <LastCompanyCode>sample string 1</LastCompanyCode>
  <Companies>
    <ExportCMSCompanyDTO>
      <ActiveEmployeeCount>9</ActiveEmployeeCount>
      <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>
      <ClientCode>sample string 1</ClientCode>
      <ClientName>sample string 2</ClientName>
      <CompanyCode>sample string 5</CompanyCode>
      <DBAName>sample string 4</DBAName>
      <Divisions>
        <ExportCMSDivisionDTO>
          <CompanyCode>sample string 31</CompanyCode>
          <DivisionCode>sample string 32</DivisionCode>
          <ActiveEmployeeCount>19</ActiveEmployeeCount>
          <CustomServiceRep>sample string 5</CustomServiceRep>
          <DataEntryRep>sample string 7</DataEntryRep>
          <DataEntryRep2>sample string 8</DataEntryRep2>
          <DirectDepositDebitDays>21</DirectDepositDebitDays>
          <DirectDepositMinimumDays>20</DirectDepositMinimumDays>
          <DirectDepositThreshold>22</DirectDepositThreshold>
          <DirectDepositThresholdIfLate>23</DirectDepositThresholdIfLate>
          <ExecutiveContact>sample string 2</ExecutiveContact>
          <HasChecksPrinted>true</HasChecksPrinted>
          <HasQuarterlyReportsPrinted>true</HasQuarterlyReportsPrinted>
          <HasReportsPrinted>true</HasReportsPrinted>
          <HasW2Printed>true</HasW2Printed>
          <Hold1099Printing>true</Hold1099Printing>
          <HoldForBilling>true</HoldForBilling>
          <HoldForCustomerService>true</HoldForCustomerService>
          <HoldForOperation>true</HoldForOperation>
          <HoldForTaxService>true</HoldForTaxService>
          <HoldQuarterlyProcess>true</HoldQuarterlyProcess>
          <HoldQuarterlyProcessComment>sample string 14</HoldQuarterlyProcessComment>
          <InputMethod>Fax</InputMethod>
          <IsAutoSubmit>true</IsAutoSubmit>
          <Name>sample string 1</Name>
          <PayrollContact>sample string 3</PayrollContact>
          <ProcessingFrequency>Weekly</ProcessingFrequency>
          <SalesPerson>sample string 18</SalesPerson>
          <SetupRep>sample string 4</SetupRep>
          <Status>Active</Status>
          <TaxLiabilityLimit>24</TaxLiabilityLimit>
          <TaxLiabilityLimitMinimumDays>26</TaxLiabilityLimitMinimumDays>
          <TaxLiabilityMinimumDays>25</TaxLiabilityMinimumDays>
          <TeleDataRep>sample string 6</TeleDataRep>
          <TermDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
            <d6p1:Year>1</d6p1:Year>
            <d6p1:Month>2</d6p1:Month>
            <d6p1:Day>3</d6p1:Day>
          </TermDate>
          <TermReason>sample string 16</TermReason>
        </ExportCMSDivisionDTO>
        <ExportCMSDivisionDTO>
          <CompanyCode>sample string 31</CompanyCode>
          <DivisionCode>sample string 32</DivisionCode>
          <ActiveEmployeeCount>19</ActiveEmployeeCount>
          <CustomServiceRep>sample string 5</CustomServiceRep>
          <DataEntryRep>sample string 7</DataEntryRep>
          <DataEntryRep2>sample string 8</DataEntryRep2>
          <DirectDepositDebitDays>21</DirectDepositDebitDays>
          <DirectDepositMinimumDays>20</DirectDepositMinimumDays>
          <DirectDepositThreshold>22</DirectDepositThreshold>
          <DirectDepositThresholdIfLate>23</DirectDepositThresholdIfLate>
          <ExecutiveContact>sample string 2</ExecutiveContact>
          <HasChecksPrinted>true</HasChecksPrinted>
          <HasQuarterlyReportsPrinted>true</HasQuarterlyReportsPrinted>
          <HasReportsPrinted>true</HasReportsPrinted>
          <HasW2Printed>true</HasW2Printed>
          <Hold1099Printing>true</Hold1099Printing>
          <HoldForBilling>true</HoldForBilling>
          <HoldForCustomerService>true</HoldForCustomerService>
          <HoldForOperation>true</HoldForOperation>
          <HoldForTaxService>true</HoldForTaxService>
          <HoldQuarterlyProcess>true</HoldQuarterlyProcess>
          <HoldQuarterlyProcessComment>sample string 14</HoldQuarterlyProcessComment>
          <InputMethod>Fax</InputMethod>
          <IsAutoSubmit>true</IsAutoSubmit>
          <Name>sample string 1</Name>
          <PayrollContact>sample string 3</PayrollContact>
          <ProcessingFrequency>Weekly</ProcessingFrequency>
          <SalesPerson>sample string 18</SalesPerson>
          <SetupRep>sample string 4</SetupRep>
          <Status>Active</Status>
          <TaxLiabilityLimit>24</TaxLiabilityLimit>
          <TaxLiabilityLimitMinimumDays>26</TaxLiabilityLimitMinimumDays>
          <TaxLiabilityMinimumDays>25</TaxLiabilityMinimumDays>
          <TeleDataRep>sample string 6</TeleDataRep>
          <TermDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
            <d6p1:Year>1</d6p1:Year>
            <d6p1:Month>2</d6p1:Month>
            <d6p1:Day>3</d6p1:Day>
          </TermDate>
          <TermReason>sample string 16</TermReason>
        </ExportCMSDivisionDTO>
      </Divisions>
      <FedId>sample string 7</FedId>
      <FirstCheckDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
        <d4p1:Year>1</d4p1:Year>
        <d4p1:Month>2</d4p1:Month>
        <d4p1:Day>3</d4p1:Day>
      </FirstCheckDate>
      <IsLive>true</IsLive>
      <LegalName>sample string 3</LegalName>
      <SalesPerson>sample string 6</SalesPerson>
      <ServiceOptions i:nil="true" />
      <StartDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
        <d4p1:Year>1</d4p1:Year>
        <d4p1:Month>2</d4p1:Month>
        <d4p1:Day>3</d4p1:Day>
      </StartDate>
    </ExportCMSCompanyDTO>
    <ExportCMSCompanyDTO>
      <ActiveEmployeeCount>9</ActiveEmployeeCount>
      <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>
      <ClientCode>sample string 1</ClientCode>
      <ClientName>sample string 2</ClientName>
      <CompanyCode>sample string 5</CompanyCode>
      <DBAName>sample string 4</DBAName>
      <Divisions>
        <ExportCMSDivisionDTO>
          <CompanyCode>sample string 31</CompanyCode>
          <DivisionCode>sample string 32</DivisionCode>
          <ActiveEmployeeCount>19</ActiveEmployeeCount>
          <CustomServiceRep>sample string 5</CustomServiceRep>
          <DataEntryRep>sample string 7</DataEntryRep>
          <DataEntryRep2>sample string 8</DataEntryRep2>
          <DirectDepositDebitDays>21</DirectDepositDebitDays>
          <DirectDepositMinimumDays>20</DirectDepositMinimumDays>
          <DirectDepositThreshold>22</DirectDepositThreshold>
          <DirectDepositThresholdIfLate>23</DirectDepositThresholdIfLate>
          <ExecutiveContact>sample string 2</ExecutiveContact>
          <HasChecksPrinted>true</HasChecksPrinted>
          <HasQuarterlyReportsPrinted>true</HasQuarterlyReportsPrinted>
          <HasReportsPrinted>true</HasReportsPrinted>
          <HasW2Printed>true</HasW2Printed>
          <Hold1099Printing>true</Hold1099Printing>
          <HoldForBilling>true</HoldForBilling>
          <HoldForCustomerService>true</HoldForCustomerService>
          <HoldForOperation>true</HoldForOperation>
          <HoldForTaxService>true</HoldForTaxService>
          <HoldQuarterlyProcess>true</HoldQuarterlyProcess>
          <HoldQuarterlyProcessComment>sample string 14</HoldQuarterlyProcessComment>
          <InputMethod>Fax</InputMethod>
          <IsAutoSubmit>true</IsAutoSubmit>
          <Name>sample string 1</Name>
          <PayrollContact>sample string 3</PayrollContact>
          <ProcessingFrequency>Weekly</ProcessingFrequency>
          <SalesPerson>sample string 18</SalesPerson>
          <SetupRep>sample string 4</SetupRep>
          <Status>Active</Status>
          <TaxLiabilityLimit>24</TaxLiabilityLimit>
          <TaxLiabilityLimitMinimumDays>26</TaxLiabilityLimitMinimumDays>
          <TaxLiabilityMinimumDays>25</TaxLiabilityMinimumDays>
          <TeleDataRep>sample string 6</TeleDataRep>
          <TermDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
            <d6p1:Year>1</d6p1:Year>
            <d6p1:Month>2</d6p1:Month>
            <d6p1:Day>3</d6p1:Day>
          </TermDate>
          <TermReason>sample string 16</TermReason>
        </ExportCMSDivisionDTO>
        <ExportCMSDivisionDTO>
          <CompanyCode>sample string 31</CompanyCode>
          <DivisionCode>sample string 32</DivisionCode>
          <ActiveEmployeeCount>19</ActiveEmployeeCount>
          <CustomServiceRep>sample string 5</CustomServiceRep>
          <DataEntryRep>sample string 7</DataEntryRep>
          <DataEntryRep2>sample string 8</DataEntryRep2>
          <DirectDepositDebitDays>21</DirectDepositDebitDays>
          <DirectDepositMinimumDays>20</DirectDepositMinimumDays>
          <DirectDepositThreshold>22</DirectDepositThreshold>
          <DirectDepositThresholdIfLate>23</DirectDepositThresholdIfLate>
          <ExecutiveContact>sample string 2</ExecutiveContact>
          <HasChecksPrinted>true</HasChecksPrinted>
          <HasQuarterlyReportsPrinted>true</HasQuarterlyReportsPrinted>
          <HasReportsPrinted>true</HasReportsPrinted>
          <HasW2Printed>true</HasW2Printed>
          <Hold1099Printing>true</Hold1099Printing>
          <HoldForBilling>true</HoldForBilling>
          <HoldForCustomerService>true</HoldForCustomerService>
          <HoldForOperation>true</HoldForOperation>
          <HoldForTaxService>true</HoldForTaxService>
          <HoldQuarterlyProcess>true</HoldQuarterlyProcess>
          <HoldQuarterlyProcessComment>sample string 14</HoldQuarterlyProcessComment>
          <InputMethod>Fax</InputMethod>
          <IsAutoSubmit>true</IsAutoSubmit>
          <Name>sample string 1</Name>
          <PayrollContact>sample string 3</PayrollContact>
          <ProcessingFrequency>Weekly</ProcessingFrequency>
          <SalesPerson>sample string 18</SalesPerson>
          <SetupRep>sample string 4</SetupRep>
          <Status>Active</Status>
          <TaxLiabilityLimit>24</TaxLiabilityLimit>
          <TaxLiabilityLimitMinimumDays>26</TaxLiabilityLimitMinimumDays>
          <TaxLiabilityMinimumDays>25</TaxLiabilityMinimumDays>
          <TeleDataRep>sample string 6</TeleDataRep>
          <TermDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
            <d6p1:Year>1</d6p1:Year>
            <d6p1:Month>2</d6p1:Month>
            <d6p1:Day>3</d6p1:Day>
          </TermDate>
          <TermReason>sample string 16</TermReason>
        </ExportCMSDivisionDTO>
      </Divisions>
      <FedId>sample string 7</FedId>
      <FirstCheckDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
        <d4p1:Year>1</d4p1:Year>
        <d4p1:Month>2</d4p1:Month>
        <d4p1:Day>3</d4p1:Day>
      </FirstCheckDate>
      <IsLive>true</IsLive>
      <LegalName>sample string 3</LegalName>
      <SalesPerson>sample string 6</SalesPerson>
      <ServiceOptions i:nil="true" />
      <StartDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
        <d4p1:Year>1</d4p1:Year>
        <d4p1:Month>2</d4p1:Month>
        <d4p1:Day>3</d4p1:Day>
      </StartDate>
    </ExportCMSCompanyDTO>
  </Companies>
</ExportCMSCompanyResultDTO>