GET v1/ats/export/companies/{companyCode}/divisions/{divisionCode}/benefit-categories
Retrieve Benefit Categories by Division
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyCode | string |
Required |
|
| divisionCode | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of ExportBenefitCategoryDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Code | string |
None. |
|
| Description | string |
None. |
|
| ACAEmploymentType | ACAEmploymentType |
None. |
|
| ACASafeHarbor | ACASafeHarbor |
None. |
|
| IsDefault | boolean |
None. |
|
| IsMultiEmployerArrangement | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"code": "sample string 1",
"description": "sample string 2",
"acaEmploymentType": "ACAVariable",
"acaSafeHarbor": "W2Wages",
"isDefault": true,
"isMultiEmployerArrangement": true
},
{
"code": "sample string 1",
"description": "sample string 2",
"acaEmploymentType": "ACAVariable",
"acaSafeHarbor": "W2Wages",
"isDefault": true,
"isMultiEmployerArrangement": true
}
]
text/xml
Sample:
<ArrayOfExportBenefitCategoryDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
<ExportBenefitCategoryDTO>
<ACAEmploymentType>ACAVariable</ACAEmploymentType>
<ACASafeHarbor>W2Wages</ACASafeHarbor>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
<IsDefault>true</IsDefault>
<IsMultiEmployerArrangement>true</IsMultiEmployerArrangement>
</ExportBenefitCategoryDTO>
<ExportBenefitCategoryDTO>
<ACAEmploymentType>ACAVariable</ACAEmploymentType>
<ACASafeHarbor>W2Wages</ACASafeHarbor>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
<IsDefault>true</IsDefault>
<IsMultiEmployerArrangement>true</IsMultiEmployerArrangement>
</ExportBenefitCategoryDTO>
</ArrayOfExportBenefitCategoryDTO>