GET v1/income-verification/export/companies/{companyCode}/earnings?includeInactive={includeInactive}

Retrieve Earnings by Company

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode		string	Required
includeInactive		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of ExportEarningDTO

Name	Type	Additional information
DivisionKey	DivisionKeyDTO	None.
EarningCode	string	None.
EarningDescription	string	None.
EarningType	string	None.
IsActive	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "earningCode": "sample string 1",
    "earningDescription": "sample string 2",
    "earningType": "sample string 3",
    "isActive": true
  },
  {
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "earningCode": "sample string 1",
    "earningDescription": "sample string 2",
    "earningType": "sample string 3",
    "isActive": true
  }
]

text/xml

Sample:

<ArrayOfExportEarningDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportEarningDTO>
    <DivisionKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:CompanyCode>sample string 1</d3p1:CompanyCode>
      <d3p1:DivisionCode>sample string 2</d3p1:DivisionCode>
    </DivisionKey>
    <EarningCode>sample string 1</EarningCode>
    <EarningDescription>sample string 2</EarningDescription>
    <EarningType>sample string 3</EarningType>
    <IsActive>true</IsActive>
  </ExportEarningDTO>
  <ExportEarningDTO>
    <DivisionKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:CompanyCode>sample string 1</d3p1:CompanyCode>
      <d3p1:DivisionCode>sample string 2</d3p1:DivisionCode>
    </DivisionKey>
    <EarningCode>sample string 1</EarningCode>
    <EarningDescription>sample string 2</EarningDescription>
    <EarningType>sample string 3</EarningType>
    <IsActive>true</IsActive>
  </ExportEarningDTO>
</ArrayOfExportEarningDTO>