POST api/Items/Create

Request Information

URI Parameters

None.

Body Parameters

ItemsModel
NameDescriptionTypeAdditional information
ItemCode

string

None.

ItemName

string

None.

TaxCode

string

None.

TaxRate

decimal number

None.

Discount

decimal number

None.

DiscountG

decimal number

None.

UnitPrice

decimal number

None.

FirmName

string

None.

ForeingName

string

None.

OnHand

integer

None.

InvntItem

string

None.

Frozen

boolean

None.

BarCode

string

None.

Quantity

decimal number

None.

LastPurchaseDate

date

None.

LastPurchasePrice

decimal number

None.

PriceList

Collection of PriceListModel

None.

Barcodes

Collection of ItemsBarcodeModel

None.

UdfTarget

Collection of UdfTarget

None.

HasInconsistency

boolean

None.

InconsistencyMessage

string

None.

ItemClass

string

None.

Speciality

string

None.

HasDiscount

boolean

None.

Supplier

string

None.

Requestable

boolean

None.

ItemGroup

string

None.

AuthorizationRequired

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "ItemCode": "sample string 1",
  "ItemName": "sample string 2",
  "TaxCode": "sample string 3",
  "TaxRate": 4.1,
  "Discount": 5.0,
  "DiscountG": 6.0,
  "UnitPrice": 7.0,
  "FirmName": "sample string 8",
  "ForeingName": "sample string 9",
  "OnHand": 10,
  "InvntItem": "sample string 11",
  "Frozen": true,
  "BarCode": "sample string 13",
  "Quantity": 1.1,
  "LastPurchaseDate": "2025-09-29T14:41:59.4108764-06:00",
  "LastPurchasePrice": 1.1,
  "PriceList": [
    {
      "ListNum": 1,
      "ListName": "sample string 2",
      "Price": 3.1,
      "PrimCurr": "sample string 4",
      "AddCurr1": "sample string 5",
      "AddCurr2": "sample string 6"
    },
    {
      "ListNum": 1,
      "ListName": "sample string 2",
      "Price": 3.1,
      "PrimCurr": "sample string 4",
      "AddCurr1": "sample string 5",
      "AddCurr2": "sample string 6"
    }
  ],
  "Barcodes": [
    {
      "BcdEntry": 1,
      "BcdCode": "sample string 2",
      "BcdName": "sample string 3",
      "UomEntry": 4
    },
    {
      "BcdEntry": 1,
      "BcdCode": "sample string 2",
      "BcdName": "sample string 3",
      "UomEntry": 4
    }
  ],
  "UdfTarget": [
    {
      "Name": "sample string 1",
      "FieldType": "sample string 2",
      "Value": "sample string 3"
    },
    {
      "Name": "sample string 1",
      "FieldType": "sample string 2",
      "Value": "sample string 3"
    }
  ],
  "HasInconsistency": true,
  "InconsistencyMessage": "sample string 15",
  "ItemClass": "sample string 16",
  "Speciality": "sample string 17",
  "HasDiscount": true,
  "Supplier": "sample string 19",
  "Requestable": true,
  "ItemGroup": "sample string 21",
  "AuthorizationRequired": true
}

application/xml, text/xml

Sample:
<ItemsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CLVSPOS.MODELS">
  <AuthorizationRequired>true</AuthorizationRequired>
  <BarCode>sample string 13</BarCode>
  <Barcodes>
    <ItemsBarcodeModel>
      <BcdCode>sample string 2</BcdCode>
      <BcdEntry>1</BcdEntry>
      <BcdName>sample string 3</BcdName>
      <UomEntry>4</UomEntry>
    </ItemsBarcodeModel>
    <ItemsBarcodeModel>
      <BcdCode>sample string 2</BcdCode>
      <BcdEntry>1</BcdEntry>
      <BcdName>sample string 3</BcdName>
      <UomEntry>4</UomEntry>
    </ItemsBarcodeModel>
  </Barcodes>
  <Discount>5</Discount>
  <DiscountG>6</DiscountG>
  <FirmName>sample string 8</FirmName>
  <ForeingName>sample string 9</ForeingName>
  <Frozen>true</Frozen>
  <HasDiscount>true</HasDiscount>
  <HasInconsistency>true</HasInconsistency>
  <InconsistencyMessage>sample string 15</InconsistencyMessage>
  <InvntItem>sample string 11</InvntItem>
  <ItemClass>sample string 16</ItemClass>
  <ItemCode>sample string 1</ItemCode>
  <ItemGroup>sample string 21</ItemGroup>
  <ItemName>sample string 2</ItemName>
  <LastPurchaseDate>2025-09-29T14:41:59.4108764-06:00</LastPurchaseDate>
  <LastPurchasePrice>1.1</LastPurchasePrice>
  <OnHand>10</OnHand>
  <PriceList>
    <PriceListModel>
      <AddCurr1>sample string 5</AddCurr1>
      <AddCurr2>sample string 6</AddCurr2>
      <ListName>sample string 2</ListName>
      <ListNum>1</ListNum>
      <Price>3.1</Price>
      <PrimCurr>sample string 4</PrimCurr>
    </PriceListModel>
    <PriceListModel>
      <AddCurr1>sample string 5</AddCurr1>
      <AddCurr2>sample string 6</AddCurr2>
      <ListName>sample string 2</ListName>
      <ListNum>1</ListNum>
      <Price>3.1</Price>
      <PrimCurr>sample string 4</PrimCurr>
    </PriceListModel>
  </PriceList>
  <Quantity>1.1</Quantity>
  <Requestable>true</Requestable>
  <Speciality>sample string 17</Speciality>
  <Supplier>sample string 19</Supplier>
  <TaxCode>sample string 3</TaxCode>
  <TaxRate>4.1</TaxRate>
  <UdfTarget xmlns:d2p1="http://schemas.datacontract.org/2004/07/CLVSSUPER.MODELS">
    <d2p1:UdfTarget>
      <d2p1:FieldType>sample string 2</d2p1:FieldType>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:UdfTarget>
    <d2p1:UdfTarget>
      <d2p1:FieldType>sample string 2</d2p1:FieldType>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:UdfTarget>
  </UdfTarget>
  <UnitPrice>7</UnitPrice>
</ItemsModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.