URL
https://devwebapi.leadmaster.com/api/Automation/SearchOpportunityAvailableProduct
Description
Searches the opportunity.
HttpMethod
POST
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| request | The request. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{
"access_token": "sample string 1",
"FieldName": "sample string 2",
"FieldValue": "sample string 3"
}
application/xml, text/xml
Sample:
<SearchRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessObjects.ViewModel"> <FieldName>sample string 2</FieldName> <FieldValue>sample string 3</FieldValue> <access_token>sample string 1</access_token> </SearchRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Response body formats
application/json, text/json
Sample:
{
"StatusCode": 100,
"IsSuccess": true,
"Message": "sample string 2",
"Result": [
{
"AvailProductID": 1,
"CompanyID": 2,
"ProductName": "sample string 3",
"ProductDesc": "sample string 4",
"UnitPrice": 5.0,
"DateCreated": "2025-04-25T07:20:51.6166784-04:00",
"LastUpdated": "2025-04-25T07:20:51.6166784-04:00",
"UpdatedBy": "sample string 8",
"IsHeader": 9,
"Sequence": 10,
"ProductCode": "sample string 11",
"CommissionPercentage": 12.1,
"CommissionValue": 13.0,
"Commission": 14.0,
"BaseCost": 15.0,
"QBItemID": "sample string 16",
"isActive": true,
"isTaxable": true,
"IncomeAccountRef": "sample string 19",
"ExpenseAccountRef": "sample string 20",
"AssetAccountRef": "sample string 21",
"TrackQtyOnHand": true,
"QBProductId": 23,
"UOM_Type": "sample string 24",
"UOM_Qty": 25.0,
"IsDiscount": true
},
{
"AvailProductID": 1,
"CompanyID": 2,
"ProductName": "sample string 3",
"ProductDesc": "sample string 4",
"UnitPrice": 5.0,
"DateCreated": "2025-04-25T07:20:51.6166784-04:00",
"LastUpdated": "2025-04-25T07:20:51.6166784-04:00",
"UpdatedBy": "sample string 8",
"IsHeader": 9,
"Sequence": 10,
"ProductCode": "sample string 11",
"CommissionPercentage": 12.1,
"CommissionValue": 13.0,
"Commission": 14.0,
"BaseCost": 15.0,
"QBItemID": "sample string 16",
"isActive": true,
"isTaxable": true,
"IncomeAccountRef": "sample string 19",
"ExpenseAccountRef": "sample string 20",
"AssetAccountRef": "sample string 21",
"TrackQtyOnHand": true,
"QBProductId": 23,
"UOM_Type": "sample string 24",
"UOM_Qty": 25.0,
"IsDiscount": true
},
{
"AvailProductID": 1,
"CompanyID": 2,
"ProductName": "sample string 3",
"ProductDesc": "sample string 4",
"UnitPrice": 5.0,
"DateCreated": "2025-04-25T07:20:51.6166784-04:00",
"LastUpdated": "2025-04-25T07:20:51.6166784-04:00",
"UpdatedBy": "sample string 8",
"IsHeader": 9,
"Sequence": 10,
"ProductCode": "sample string 11",
"CommissionPercentage": 12.1,
"CommissionValue": 13.0,
"Commission": 14.0,
"BaseCost": 15.0,
"QBItemID": "sample string 16",
"isActive": true,
"isTaxable": true,
"IncomeAccountRef": "sample string 19",
"ExpenseAccountRef": "sample string 20",
"AssetAccountRef": "sample string 21",
"TrackQtyOnHand": true,
"QBProductId": 23,
"UOM_Type": "sample string 24",
"UOM_Qty": 25.0,
"IsDiscount": true
}
]
}
application/xml, text/xml
Sample:
<APIResponseBaseOfArrayOfOpportunityAvailableProducts6ZPUqztj xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessObjects.ViewModel">
<IsSuccess>true</IsSuccess>
<Message>sample string 2</Message>
<Result>
<OpportunityAvailableProducts>
<AssetAccountRef>sample string 21</AssetAccountRef>
<AvailProductID>1</AvailProductID>
<BaseCost>15</BaseCost>
<Commission>14</Commission>
<CommissionPercentage>12.1</CommissionPercentage>
<CommissionValue>13</CommissionValue>
<CompanyID>2</CompanyID>
<DateCreated>2025-04-25T07:20:51.6166784-04:00</DateCreated>
<ExpenseAccountRef>sample string 20</ExpenseAccountRef>
<IncomeAccountRef>sample string 19</IncomeAccountRef>
<IsDiscount>true</IsDiscount>
<IsHeader>9</IsHeader>
<LastUpdated>2025-04-25T07:20:51.6166784-04:00</LastUpdated>
<ProductCode>sample string 11</ProductCode>
<ProductDesc>sample string 4</ProductDesc>
<ProductName>sample string 3</ProductName>
<QBItemID>sample string 16</QBItemID>
<QBProductId>23</QBProductId>
<Sequence>10</Sequence>
<TrackQtyOnHand>true</TrackQtyOnHand>
<UOM_Qty>25</UOM_Qty>
<UOM_Type>sample string 24</UOM_Type>
<UnitPrice>5</UnitPrice>
<UpdatedBy>sample string 8</UpdatedBy>
<isActive>true</isActive>
<isTaxable>true</isTaxable>
</OpportunityAvailableProducts>
<OpportunityAvailableProducts>
<AssetAccountRef>sample string 21</AssetAccountRef>
<AvailProductID>1</AvailProductID>
<BaseCost>15</BaseCost>
<Commission>14</Commission>
<CommissionPercentage>12.1</CommissionPercentage>
<CommissionValue>13</CommissionValue>
<CompanyID>2</CompanyID>
<DateCreated>2025-04-25T07:20:51.6166784-04:00</DateCreated>
<ExpenseAccountRef>sample string 20</ExpenseAccountRef>
<IncomeAccountRef>sample string 19</IncomeAccountRef>
<IsDiscount>true</IsDiscount>
<IsHeader>9</IsHeader>
<LastUpdated>2025-04-25T07:20:51.6166784-04:00</LastUpdated>
<ProductCode>sample string 11</ProductCode>
<ProductDesc>sample string 4</ProductDesc>
<ProductName>sample string 3</ProductName>
<QBItemID>sample string 16</QBItemID>
<QBProductId>23</QBProductId>
<Sequence>10</Sequence>
<TrackQtyOnHand>true</TrackQtyOnHand>
<UOM_Qty>25</UOM_Qty>
<UOM_Type>sample string 24</UOM_Type>
<UnitPrice>5</UnitPrice>
<UpdatedBy>sample string 8</UpdatedBy>
<isActive>true</isActive>
<isTaxable>true</isTaxable>
</OpportunityAvailableProducts>
<OpportunityAvailableProducts>
<AssetAccountRef>sample string 21</AssetAccountRef>
<AvailProductID>1</AvailProductID>
<BaseCost>15</BaseCost>
<Commission>14</Commission>
<CommissionPercentage>12.1</CommissionPercentage>
<CommissionValue>13</CommissionValue>
<CompanyID>2</CompanyID>
<DateCreated>2025-04-25T07:20:51.6166784-04:00</DateCreated>
<ExpenseAccountRef>sample string 20</ExpenseAccountRef>
<IncomeAccountRef>sample string 19</IncomeAccountRef>
<IsDiscount>true</IsDiscount>
<IsHeader>9</IsHeader>
<LastUpdated>2025-04-25T07:20:51.6166784-04:00</LastUpdated>
<ProductCode>sample string 11</ProductCode>
<ProductDesc>sample string 4</ProductDesc>
<ProductName>sample string 3</ProductName>
<QBItemID>sample string 16</QBItemID>
<QBProductId>23</QBProductId>
<Sequence>10</Sequence>
<TrackQtyOnHand>true</TrackQtyOnHand>
<UOM_Qty>25</UOM_Qty>
<UOM_Type>sample string 24</UOM_Type>
<UnitPrice>5</UnitPrice>
<UpdatedBy>sample string 8</UpdatedBy>
<isActive>true</isActive>
<isTaxable>true</isTaxable>
</OpportunityAvailableProducts>
</Result>
<StatusCode>Continue</StatusCode>
</APIResponseBaseOfArrayOfOpportunityAvailableProducts6ZPUqztj>