GET v1/export/companies/{companyCode}/divisions/{divisionCode}/billing-items
Retrieve Billable Items 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 ExportDivisionBillingItemDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| DivisionBillingItemKey | GlobalEntityKeyOfIDivisionBillingItem |
None. |
|
| DivisionKey | DivisionKeyDTO |
None. |
|
| Code | string |
None. |
|
| Description | string |
None. |
|
| ItemType | string |
None. |
|
| ChargeFrequency | string |
None. |
|
| BaseCharge | decimal number |
None. |
|
| UnitPrice | decimal number |
None. |
|
| QuantityDescription | string |
None. |
|
| OverrideQuantity | integer |
None. |
|
| MinimumCharge | decimal number |
None. |
|
| IsCountable | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"divisionBillingItemKey": "<empty>",
"divisionKey": {
"companyCode": "sample string 1",
"divisionCode": "sample string 2"
},
"code": "sample string 1",
"description": "sample string 2",
"itemType": "sample string 3",
"chargeFrequency": "sample string 4",
"baseCharge": 5.0,
"unitPrice": 6.0,
"quantityDescription": "sample string 7",
"overrideQuantity": 8,
"minimumCharge": 9.0,
"isCountable": true
},
{
"divisionBillingItemKey": "<empty>",
"divisionKey": {
"companyCode": "sample string 1",
"divisionCode": "sample string 2"
},
"code": "sample string 1",
"description": "sample string 2",
"itemType": "sample string 3",
"chargeFrequency": "sample string 4",
"baseCharge": 5.0,
"unitPrice": 6.0,
"quantityDescription": "sample string 7",
"overrideQuantity": 8,
"minimumCharge": 9.0,
"isCountable": true
}
]
text/xml
Sample:
<ArrayOfExportDivisionBillingItemDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
<ExportDivisionBillingItemDTO>
<BaseCharge>5</BaseCharge>
<ChargeFrequency>sample string 4</ChargeFrequency>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
<IsCountable>true</IsCountable>
<ItemType>sample string 3</ItemType>
<MinimumCharge>9</MinimumCharge>
<OverrideQuantity>8</OverrideQuantity>
<QuantityDescription>sample string 7</QuantityDescription>
<UnitPrice>6</UnitPrice>
<DivisionBillingItemKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
<d3p1:_entityKey>
<d3p1:_hasValue>false</d3p1:_hasValue>
<d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value>
</d3p1:_entityKey>
</DivisionBillingItemKey>
<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>
</ExportDivisionBillingItemDTO>
<ExportDivisionBillingItemDTO>
<BaseCharge>5</BaseCharge>
<ChargeFrequency>sample string 4</ChargeFrequency>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
<IsCountable>true</IsCountable>
<ItemType>sample string 3</ItemType>
<MinimumCharge>9</MinimumCharge>
<OverrideQuantity>8</OverrideQuantity>
<QuantityDescription>sample string 7</QuantityDescription>
<UnitPrice>6</UnitPrice>
<DivisionBillingItemKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
<d3p1:_entityKey>
<d3p1:_hasValue>false</d3p1:_hasValue>
<d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value>
</d3p1:_entityKey>
</DivisionBillingItemKey>
<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>
</ExportDivisionBillingItemDTO>
</ArrayOfExportDivisionBillingItemDTO>