POST v1/imports/billing-items?action={action}&allowSameFile={allowSameFile}
Import Division Billing Items
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 DivisionBillingItemImportDTOName | Description | Type | Additional information |
---|---|---|---|
SerializableKey | globally unique identifier |
None. |
|
ItemCode | string |
Required |
|
Description | string |
None. |
|
IncludeZeroCharges | boolean |
None. |
|
BaseCharge | decimal number |
None. |
|
UnitPrice | decimal number |
None. |
|
MinimumCharge | decimal number |
None. |
|
OverrideQuantity | integer |
None. |
|
DivisionCode | string |
None. |
|
CompanyCode | string |
Required |
Request Formats
application/json, text/json
Sample:
[ { "serializableKey": "17e40799-2e7f-488d-9a72-888c9616ca34", "key": "17e40799-2e7f-488d-9a72-888c9616ca34", "itemCode": "sample string 1", "description": "sample string 2", "includeZeroCharges": true, "baseCharge": 4.0, "unitPrice": 5.0, "minimumCharge": 6.0, "overrideQuantity": 7, "divisionCode": "sample string 8", "companyCode": "sample string 9" }, { "serializableKey": "17e40799-2e7f-488d-9a72-888c9616ca34", "key": "17e40799-2e7f-488d-9a72-888c9616ca34", "itemCode": "sample string 1", "description": "sample string 2", "includeZeroCharges": true, "baseCharge": 4.0, "unitPrice": 5.0, "minimumCharge": 6.0, "overrideQuantity": 7, "divisionCode": "sample string 8", "companyCode": "sample string 9" } ]
text/xml
Sample:
<ArrayOfDivisionBillingItemImportDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models"> <DivisionBillingItemImportDTO> <CompanyCode>sample string 9</CompanyCode> <DivisionCode>sample string 8</DivisionCode> <BaseCharge>4</BaseCharge> <Description>sample string 2</Description> <IncludeZeroCharges>true</IncludeZeroCharges> <ItemCode>sample string 1</ItemCode> <Key xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys"> <d3p1:_entityKey> <d3p1:_hasValue>true</d3p1:_hasValue> <d3p1:_value>17e40799-2e7f-488d-9a72-888c9616ca34</d3p1:_value> </d3p1:_entityKey> </Key> <MinimumCharge>6</MinimumCharge> <OverrideQuantity>7</OverrideQuantity> <SerializableKey>17e40799-2e7f-488d-9a72-888c9616ca34</SerializableKey> <UnitPrice>5</UnitPrice> </DivisionBillingItemImportDTO> <DivisionBillingItemImportDTO> <CompanyCode>sample string 9</CompanyCode> <DivisionCode>sample string 8</DivisionCode> <BaseCharge>4</BaseCharge> <Description>sample string 2</Description> <IncludeZeroCharges>true</IncludeZeroCharges> <ItemCode>sample string 1</ItemCode> <Key xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys"> <d3p1:_entityKey> <d3p1:_hasValue>true</d3p1:_hasValue> <d3p1:_value>17e40799-2e7f-488d-9a72-888c9616ca34</d3p1:_value> </d3p1:_entityKey> </Key> <MinimumCharge>6</MinimumCharge> <OverrideQuantity>7</OverrideQuantity> <SerializableKey>17e40799-2e7f-488d-9a72-888c9616ca34</SerializableKey> <UnitPrice>5</UnitPrice> </DivisionBillingItemImportDTO> </ArrayOfDivisionBillingItemImportDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The results of the import.
ImportResultDTOName | Description | 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.