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 DivisionBillingItemImportDTO

Name	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": "41118138-7a7e-4fd0-a292-980162afa153",
    "key": "41118138-7a7e-4fd0-a292-980162afa153",
    "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": "41118138-7a7e-4fd0-a292-980162afa153",
    "key": "41118138-7a7e-4fd0-a292-980162afa153",
    "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>41118138-7a7e-4fd0-a292-980162afa153</d3p1:_value>
      </d3p1:_entityKey>
    </Key>
    <MinimumCharge>6</MinimumCharge>
    <OverrideQuantity>7</OverrideQuantity>
    <SerializableKey>41118138-7a7e-4fd0-a292-980162afa153</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>41118138-7a7e-4fd0-a292-980162afa153</d3p1:_value>
      </d3p1:_entityKey>
    </Key>
    <MinimumCharge>6</MinimumCharge>
    <OverrideQuantity>7</OverrideQuantity>
    <SerializableKey>41118138-7a7e-4fd0-a292-980162afa153</SerializableKey>
    <UnitPrice>5</UnitPrice>
  </DivisionBillingItemImportDTO>
</ArrayOfDivisionBillingItemImportDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The results of the import.

ImportResultDTO

Name	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

Sample:

{
  "newRecords": 1,
  "updatedRecords": 2,
  "errors": [
    {
      "index": 1,
      "details": [
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ]
    },
    {
      "index": 1,
      "details": [
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "propertyName": "sample string 1",
          "arrayIndex": 1,
          "errorMessages": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ]
    }
  ],
  "newRecordKeys": [
    {
      "index": 1,
      "key": "sample string 2"
    },
    {
      "index": 1,
      "key": "sample string 2"
    }
  ],
  "updatedRecordKeys": [
    {
      "index": 1,
      "key": "sample string 2"
    },
    {
      "index": 1,
      "key": "sample string 2"
    }
  ],
  "importKey": "<empty>"
}

text/xml

Sample:

<ImportResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
  <Errors>
    <ImportErrorDTO>
      <Details>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
      </Details>
      <Index>1</Index>
    </ImportErrorDTO>
    <ImportErrorDTO>
      <Details>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
        <ImportErrorDetailsDTO>
          <ArrayIndex>1</ArrayIndex>
          <ErrorMessages xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </ErrorMessages>
          <PropertyName>sample string 1</PropertyName>
        </ImportErrorDetailsDTO>
      </Details>
      <Index>1</Index>
    </ImportErrorDTO>
  </Errors>
  <ImportKey xmlns:d2p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
    <d2p1:_entityKey>
      <d2p1:_hasValue>false</d2p1:_hasValue>
      <d2p1:_value>00000000-0000-0000-0000-000000000000</d2p1:_value>
    </d2p1:_entityKey>
  </ImportKey>
  <NewRecordKeys>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
  </NewRecordKeys>
  <NewRecords>1</NewRecords>
  <UpdatedRecordKeys>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
    <ImportKeyDTO>
      <Index>1</Index>
      <Key>sample string 2</Key>
    </ImportKeyDTO>
  </UpdatedRecordKeys>
  <UpdatedRecords>2</UpdatedRecords>
</ImportResultDTO>