POST api/quickbook/CreateItem

Create Catelouge

Request Information

URI Parameters

None.

Body Parameters

ItemRequestDataModel
NameDescriptionTypeAdditional information
RequestModel

QboCommonRequestModel

None.

Id

string

None.

CatelougeId

integer

None.

InventoryName

string

None.

InventorySku

string

None.

AvailableQty

decimal number

None.

Description

string

None.

PurchaseCost

decimal number

None.

UnitPrice

decimal number

None.

UOM

string

None.

UOMGuid

string

None.

ProductGroup

string

None.

ProductGroupGuid

string

None.

TaxCode

integer

None.

IncomeAccount

integer

None.

ExpenseAccount

integer

None.

AssetAccount

integer

None.

IsPartialUpdate

boolean

None.

Request Formats

application/json, text/json, text/plain, text/html

Sample:
{
  "requestModel": {
    "userId": 1,
    "apiKey": "sample string 2"
  },
  "id": "sample string 1",
  "catelougeId": 1,
  "inventoryName": "sample string 2",
  "inventorySku": "sample string 3",
  "availableQty": 1.0,
  "description": "sample string 4",
  "purchaseCost": 1.0,
  "unitPrice": 1.0,
  "uom": "sample string 5",
  "uomGuid": "sample string 6",
  "productGroup": "sample string 7",
  "productGroupGuid": "sample string 8",
  "taxCode": 1,
  "incomeAccount": 1,
  "expenseAccount": 1,
  "assetAccount": 1,
  "isPartialUpdate": true
}

application/xml, text/xml

Sample:
<ItemRequestDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel">
  <AssetAccount>1</AssetAccount>
  <AvailableQty>1</AvailableQty>
  <CatelougeId>1</CatelougeId>
  <Description>sample string 4</Description>
  <ExpenseAccount>1</ExpenseAccount>
  <Id>sample string 1</Id>
  <IncomeAccount>1</IncomeAccount>
  <InventoryName>sample string 2</InventoryName>
  <InventorySku>sample string 3</InventorySku>
  <IsPartialUpdate>true</IsPartialUpdate>
  <ProductGroup>sample string 7</ProductGroup>
  <ProductGroupGuid>sample string 8</ProductGroupGuid>
  <PurchaseCost>1</PurchaseCost>
  <RequestModel>
    <APIKey>sample string 2</APIKey>
    <UserId>1</UserId>
  </RequestModel>
  <TaxCode>1</TaxCode>
  <UOM>sample string 5</UOM>
  <UOMGuid>sample string 6</UOMGuid>
  <UnitPrice>1</UnitPrice>
</ItemRequestDataModel>

multipart/form-data

Sample:
<ItemRequestDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"><AssetAccount>1</AssetAccount><AvailableQty>1</AvailableQty><CatelougeId>1</CatelougeId><Description>sample string 4</Description><ExpenseAccount>1</ExpenseAccount><Id>sample string 1</Id><IncomeAccount>1</IncomeAccount><InventoryName>sample string 2</InventoryName><InventorySku>sample string 3</InventorySku><IsPartialUpdate>true</IsPartialUpdate><ProductGroup>sample string 7</ProductGroup><ProductGroupGuid>sample string 8</ProductGroupGuid><PurchaseCost>1</PurchaseCost><RequestModel><APIKey>sample string 2</APIKey><UserId>1</UserId></RequestModel><TaxCode>1</TaxCode><UOM>sample string 5</UOM><UOMGuid>sample string 6</UOMGuid><UnitPrice>1</UnitPrice></ItemRequestDataModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Action Status

CommonResponseDataModel
NameDescriptionTypeAdditional information
ReturnID

integer

Required

Message

string

Required

Successful

boolean

Required

Code

integer

None.

TotalRecord

integer

None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:
{
  "returnID": 1,
  "message": "sample string 2",
  "successful": true,
  "code": 4,
  "totalRecord": 5
}

application/xml, text/xml

Sample:
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">
  <Code>4</Code>
  <Message>sample string 2</Message>
  <ReturnID>1</ReturnID>
  <Successful>true</Successful>
  <TotalRecord>5</TotalRecord>
</CommonResponseDataModel>

multipart/form-data

Sample:
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>