Logo
Submit a request
Follow

Items

Adding an Item

URL

https://app.bluefolder.com/api/1.0/items/add.aspx

Request

<request>
    <itemAdd>
        <itemType></itemType>
        <itemName></itemName>
        <description></description>
        <accountName></accountName>
        <isFlatRate></isFlatRate>
        <mfrDescription></mfrDescription>
        <mfrItemNo></mfrItemNo>
        <mfrName></mfrName>
        <notes></notes>
        <taxableDefault></taxableDefault>
        <unitCost></unitCost>
        <unitPrice></unitPrice>
        <unitListPrice></unitListPrice>
    </itemAdd>
</request>
            
  • itemType - (required) string, should be either "labor", "materials", or "expense"
  • itemName - (required) string (159 char limit)
  • description - (required) string (250 char limit)
  • accountName - string (159 char limit)
  • isFlatRate - boolean
  • mfrDescription - string (250 char limit)
  • mfrItemNo - string (100 char limit)
  • mfrName - string (100 char limit)
  • notes - string (no char limit)
  • taxableDefault - boolean
  • unitCost - decimal (do not include currency symbols)
  • unitPrice - decimal (do not include currency symbols)
  • unitListPrice - decimal (do not include currency symbols)

Response

<response status="ok">
    <itemID>xxxxxx</itemID>
</response>
            

Editing an Item

URL

https://app.bluefolder.com/api/1.0/items/edit.aspx

Request

<request>
    <itemEdit>
        <itemID></itemID>
        <itemType></itemType>
        <itemName></itemName>
        <description></description>
        <accountName></accountName>
        <isFlatRate></isFlatRate>
        <mfrDescription></mfrDescription>
        <mfrItemNo></mfrItemNo>
        <mfrName></mfrName>
        <notes></notes>
        <taxableDefault></taxableDefault>
        <unitCost></unitCost>
        <unitPrice></unitPrice>
        <unitListPrice></unitListPrice>
    </itemEdit>
</request>
            
  • itemID - (required) integer
  • itemType - string, should be either "labor", "materials", or "expense"
  • itemName - string (159 char limit)
  • description - string (250 char limit)
  • accountName - string (159 char limit)
  • isFlatRate - boolean
  • mfrDescription - string (250 char limit)
  • mfrItemNo - string (100 char limit)
  • mfrName - string (100 char limit)
  • notes - string (no char limit)
  • taxableDefault - boolean
  • unitCost - decimal (do not include currency symbols)
  • unitPrice - decimal (do not include currency symbols)
  • unitListPrice - decimal (do not include currency symbols)

Response

<response status="ok">
    <itemID>xxxxxx</itemID>
</response>
            

Deleting an Item

URL

https://app.bluefolder.com/api/1.0/items/delete.aspx

Request

<request>
    <itemDelete>
        <itemID></itemID>
    </itemDelete>
</request>
            
  • itemID - (required) integer

Response

<response status="ok">
    <itemID>xxxxxx</itemID>
</response>
            

Retrieving a Single Item

URL

https://app.bluefolder.com/api/1.0/items/get.aspx

Request

<request>
    <itemID>xxxxxx</itemID>
</request>
            

Response

<response status="ok">
    <item>
        <id></id>
        <type></type>
        <itemNo></itemNo>
        <description></description>
        <createdByUserID></createdByUserID>
        <createdBy></createdBy>
        <dateTimeCreated></dateTimeCreated>
        <discontinued></discontinued>
        <mfrItemNo></mfrItemNo>
        <mfrDescription></mfrDescription>
        <mfrName></mfrName>
        <taxableDefault></taxableDefault>
        <unitCost></unitCost>
        <unitPrice></unitPrice>
    </item>
</response>
            

Retrieving a List of Items

URL

https://app.bluefolder.com/api/1.0/items/list.aspx

Request

<request>
    <itemList>
        <listType></listType>
    </itemList>
</request>
            
Parameters: listType: either 'basic', or 'full'

Response (for 'basic' list)

<response status="ok">
    <item>
        <id></id>
        <type></type>
        <itemNo></itemNo>
        <description></description>
        <unitCost></unitCost>
        <unitPrice></unitPrice>
    </item>
</response>
            
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request