Logo
Submit a request

Materials for Service Requests (API)

Adding a Material Item to a Service Request

URL

https://app.bluefolder.com/api/2.0/serviceRequests/addMaterial.aspx

Request

<request>
    <serviceRequestAddMaterial>
        <serviceRequestId></serviceRequestId>
        <dateUsed></dateUsed>
        <quantity></quantity>
        <billingStatus></billingStatus>
        <billingContractId></billingContractId>
        <itemNo></itemNo>
        <itemDescription></itemDescription>
        <itemUnitCost></itemUnitCost>
        <itemUnitPrice></itemUnitPrice>
        <comment></comment>
        <commentIsPublic></commentIsPublic>
        <taxable></taxable>
    </serviceRequestAddMaterial>
</request>
            
  • serviceRequestId - (required) numeric, must match an existing Service Request No.
  • dateUsed - (required) datetime, must be in the format YYYY.MM.DD HH:MM AM
  • quantity - (required) numeric/decimal
  • billingStatus - string, must be either "billable", "non-billable", or "contract"
  • billingContractId
  • itemNo - string, must match an existing Item Name/No. from your Item List
  • itemDescription - string (250 char limit)
  • itemUnitCost - decimal (do not include currency symbols)
  • itemUnitPrice - decimal (do not include currency symbols)
  • comment - string (no char limit), the comment text
  • commentIsPublic - boolean, indicates if comment should be public (visible to your customer)
  • taxable - boolean

Response

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

Editing a Material Item

URL

https://app.bluefolder.com/api/2.0/serviceRequests/editMaterial.aspx

Request

<request>
    <serviceRequestEditMaterial>
        <materialId></materialId>
        <dateUsed></dateUsed>
        <quantity></quantity>
        <billingStatus></billingStatus>
        <billingContractId></billingContractId>
        <itemNo></itemNo>
        <itemDescription></itemDescription>
        <itemUnitCost></itemUnitCost>
        <itemUnitPrice></itemUnitPrice>
        <comment></comment>
        <commentIsPublic></commentIsPublic>
        <taxable></taxable>
    </serviceRequestEditMaterial>
</request>
            
  • materialId - (required) numeric, must match an existing Service Request Material Item
  • dateUsed - datetime, must be in the format YYYY.MM.DD HH:MM AM
  • quantity - numeric/decimal
  • billingStatus - string, must be either "billable", "non-billable", or "contract"
  • billingContractId
  • itemNo - string, must match an existing Item Name/No. from your Item List
  • itemDescription - string (250 char limit)
  • itemUnitCost - decimal (do not include currency symbols)
  • itemUnitPrice - decimal (do not include currency symbols)
  • comment - string (no char limit), the comment text
  • commentIsPublic - boolean, indicates if comment should be public (visible to your customer)
  • taxable - boolean

Response

<response status="ok">
    <materialId>xxxxxx</materialId>
</response>
            
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request