From RPM Wiki
Warning: Just an idea at this point
| Table of contents |
[edit]
Summary
API: Get all the information of a single commission item using an ItemID
[edit]
Request
By ItemID
{
"Key":"{api key}",
"ItemID":"{commItemID}"
}
[edit]
Examples
http://demo.rpmsoftware.com/rpm/Api.svc/CommItem
{
"Key":"abc123def456",
"ItemID":"n314567"
}
or
{
"Key":"abc123def456",
"ItemID":"s234234"
}
[edit]
Response
{"CommItemResult":
{
"ItemID":"{comm item id}",
"Account": "{account number}",
"AccountID": "{account id}",
"Customer": "{customer name}",
"CustomerID": "{customer id}",
"Supplier": "{supplier name}",
"SupplierID": "{supplier id}",
"CommissionGroup": "{commission group}",
"CommissionGroupID": "{commission group id}",
"Quantity":"{quantity}",
"CommissionRun": "{commission run}",
"Origin": "{origin info}",
"Note": "{note}",
"NoteForAgents" : " {note for agents}",
"NetBilled": "{netbilled}",
"Wholesale": "{wholesale}",
"Margin" : "{margin}",
"GrossComm":"{gross commission}",
"GrossCommPercent": "{gross commission percent}",
"GrossCommClaimedPercent": "{gross commission claimed percent}",
"GrossCommExpectedPercent": "{gross commission expected percent}",
"Variables": [
{
"Name": "{item variable name}",
"Type": "{type}",
"Note" : "{note}",
"Hidden" : "{hidden to agent user}",
"Value" : "{value}"
},
(repeat as needed)
],
"Referrals": [
{
"Agency": "{Agency name}",
"AgencyID": "{Agency ID}",
"CommRate" : "{rate}",
"CommType" : "{commission type}"
"Type" : "{referral type}"
}
(repeat as needed)
],
"Splits":
{
"OriginalNetBilled" : "{original net billed}",
"Participants" : [
{
"Rep": "{rep name}",
"RepID": "{rep ID}",
"Agency": "{Agency name}",
"AgencyID": "{Agency ID}",
"Percent": "{split percent}",
"ItemID": "{comm item id for this participants item}"
}
(repeat as needed)
]
}
}
}
- The Referrals and Splits object lists all referrals and splits of this commission item
[edit]
Example
{"CommItemResult":
{
"ItemID":"s314569",
"Account": "000123456",
"AccountID": "2015",
"Customer": "Acme, Inc.",
"CustomerID": "10023",
"Supplier": "Qwest",
"SupplierID": "45",
"CommissionGroup": "Install or Set Up Charge",
"CommissionGroupID": "35",
"Quantity":"1",
"CommissionRun": "{commission run}",
"Origin": "{origin info}",
"Note": "{note}",
"NoteForAgents" : " {note for agents}",
"NetBilled": "$12.00",
"Wholesale": "$12.00",
"Margin" : "$12.00",
"GrossComm":"$12.00",
"GrossCommPercent": "12%",
"GrossCommClaimedPercent": "12%",
"GrossCommExpectedPercent": "12%}",
"Variables": [
{
"Name": "BTN",
"Type": "Text",
"Note": "To scan UPC",
"Hidden": "true",
"Value" : "23424232652523"
},
"Name": "Rev Date",
"Type": "Date",
"Note": "T",
"Hidden": "false",
"Value" : "10/10/10"
],
"Referrals": [
{
"Agency": "Birgett Stacey",
"AgencyID": "12",
"CommRate": 1.5,
"CommType":"percentGrossComm",
"Type":"Override"
},
{
"Agency": "Tom Tom Industry",
"AgencyID": "16",
"CommRate": 200,
"CommType":"cash",
"Type":"Override"
}
],
"Splits":
{
"OriginalNetBilled" : "$1,099.07",
"Participants" : [
{
"Rep": "Steve Braverman",
"RepID": "20",
"Agency": "Telelink Communications LLC",
"AgencyID": "250",
"Percent": "50%",
"ItemID":"s314566"
},
{
"Rep": "David Beckam",
"RepID": "29",
"Agency": "Telelink Global",
"AgencyID": "249",
"Percent": "50%"
"ItemID":"n314567"
}
]
}
}
}
[edit]
Errors
- "Comm Item not found"
- This page was last modified 16:39, 19 Mar 2010.
- This page has been accessed 412 times.