Api/CommPayments

From RPM Wiki

Table of contents

1 Summary 2 Request 2.1 Example 3 Response 3.1 Example

Summary

API: Get a list of agency payout amounts for a commission run.

Request

Comm run in the form of yyyymm

• If no run is specified, the most recent closed run is used.

{
  "Key":"{api key}",
  "CommRun":"{commission run}"
}

Example

http://demo.rpmsoftware.com/rpm/Api.svc/CommPayments

{
  "Key":"abc123def456",
  "CommRun":200901
}

Response

{ "CommPaymentsResponse":
  {
    "Agencies": [
      {
        "Agency": "{agency name}",
        "AgencyID": {agency id},
        "Payout": {payout amount},
        "Paid": {true/false}
      },
      {repeat as needed}
    ]
  }
}

• Return processes in order by agencies A-Z.
• Agencies with $0 are included.

Example

{ "CommPaymentsResult":
  {
    "Agencies": [
      {
        "Agency": "Ahead Trunck",
        "AgencyID": "4023",
        "Payout": 9106.2,
        "Paid": true
      },
      {
        "Agency": "Delta Network Solutions",
        "AgencyID": "4985",
        "Payout": -10.0001,
        "Paid": false
     }
    ]
  }
}

• This page was last modified 20:19, 25 Nov 2009.
• This page has been accessed 930 times.

---

• History

---

• About RPM Wiki
• Disclaimers
• Special pages