CommItem(
     string itemID 
)

Get all the information of a single commission item.

Request

Request Data:

  • (int) itemID(required) – Identify the ID of the commission item including its type.
    • Commission Item: n1234
    • From Split: s6789
{
    "itemID": "n123" // n is for normal Comission Items
}
{
    "itemID": "s345" // s is for splits
}

Response

{
    "Result": {
        "Account": <string>,
        "AccountID": <int>,
        "CommissionGroup": <string>,
        "CommissionGroupID": <int>,
        "CommissionRun": <string>,
        "Customer": <string>,
        "CustomerID": <int>,
        "GrossComm": <string>,
        "GrossCommClaimedPercent": <string>,
        "GrossCommExpectedPercent": <string>,
        "GrossCommPercent": <string>,
        "ItemID": <string>,
        "Margin": <string>,
        "NetBilled": <string>,
        "Note": <string>,
        "NoteForAgents": <string>,
        "Origin": <string>,
        "OriginName": <string>,

        "Quantity": <int>,
        "Referrals": [],
        "Splits": {
            "OriginalNetBilled": <string>,
            "Participants": []
        },
        "Supplier": <string>,
        "SupplierID": <int>,
        "Variables": [
            {
                "Hidden": false,
                "Name": <string>,
                "Note": <string>,
                "Type": <string>,
                "Value": <string>
            }
        ],
        "Wholesale": <string>
    }
}

Errors

  • “Comm Item not found”
  • "Call requires parameter: \"ItemID\" which was not found"