Home › Introduction to RPM’s API › Account

Account

Account(
	string Supplier,
	int SupplierID,
	string Account,
	int AccountID
)

Get account information.

Request

Request Data:

  • (string) Supplier (optional)
  • (int) SupplierID (optional) – if provided, Supplier will be ignored
  • (string) Account (optional) – the account name, must be used along with SupplierID or Supplier
  • (int) AccountID (optional) – if provided, Account, Supplier and SupplierID will be ignored. 
{
    "Supplier": <string>,
    "SupplierID":<int>,
    "Account": <string>,
    "AccountID": <int>
}

Response

{
    "Result": {
        "Account": <string>,
        "AccountGroup": <string>,
        "AccountGroupID": <int>,
        "AccountID": <int>,
        "Added": "<Date>",
        "AssignedRep": <string>, // Since RPM28
        "AssignedRepID": <int>, // Since RPM28
        "Customer": <string>,
        "CustomerID": <int>,
        "Fields": [<fields>],
        "Modified": "<Date>",
        "Address": <string>, // Since RPM26: the primary location's address line
        "City": <string>, // Since RPM26: the primary location's city
        "StateProvince": <string>, // Since RPM26: the primary location's state or province
        "Country": <string>, // Since RPM26: the primary location's country
        "ZipPostalCode": <string>, // Since RPM26: the primary location's zip/postal code
        "Reps": [
            {
                "Agency": <string>,
                "AgencyID": <int>,
                "AssignmentCodes": [<int>], // Assignment Code IDs
                "Rep": <string>,
                "RepID": <int>
            },
            <more reps...>
        ],
        "Supplier": <string>,
        "SupplierID": <int>,
        "Splits": [ // Since RPM28
                {
                    "Agency": <string>,
                    "AgencyID": <int>,
                    "Rep": <string>,
                    "RepID": <int>,
                    "Percentage": <double> // the percentage value divided by 100 (e.g. if the UI shows 55% the value will be 0.55)
                },
                <more splits...>
        ],
        "Addendums": [ // Since RPM28
            {
                "Agency": <string>,
                "AgencyID": <int>,
                "GrossRate": <double>,
                "GrossRateType": <enum: 
                    1 = % Net Billed
                    3 = cash
                    5 = % (net billed - wholesale)
                    6 = % wholesale
                    9 = % contract value
                >,
                "SalesRate": <double>,
                "SalesRateType": <enum: 
                    1 = % Net Billed
                    2 = % gross comm
                    3 = cash
                    5 = % (net billed - wholesale)
                    6 = % wholesale
                    9 = % contract value
                >
            },
            <more addendums...>
        ],
        "Referrals": [ // Since RPM28
            {
                "PayToAgency": <string>,
                "PayToAgencyID": <int>,
                "Type": "Override" | "Deduction",
                "Rate": <double>,
                "RateType": <enum: 
                    1 = % net billed
                    2 = % gross comm
                    5 = % (net billed - wholesale)
                    6 = % wholesale
                    9 = % contract value
                    4 = % agent comm
                    7 = % (gross - agent)
                    8 = (% gross) - agent
                    3 = cash
                >,
                "Start": <string>, // Start run in the following format: YYYYMM
                "End": <string>, // End run in the following format: YYYYMM
            }
        ]
    }
}

Errors

  • “Supplier not found”
  • “Account not found”

Notes

  • The AssignmentCodes for each Reps provided by this endpoint is a list of string containing the codes. This is different when calling the Rep endpoint which return a more complex structure.