RPConvFee – Developer Support

About RPConvFee

This API reads invoices to determine if an extra convenience fee was charged to customer - usually for credit card/PayPal payments. The charge is applied when the Invoice is created.

Note: The RPConvFee must be entered on the UI. It cannot be created with an API (only Read and List operations are available)

The amount value can be a dollar value (flat fee) or a percentage.

Flat fee (value has a "$" in the field) - this is applied regardless of invoice amounts paid.
Percentage fee (value has a "%" in the field) - percentage is applied to invoice paid total.

Important: Certain states prohibit convenience fees. Therefore, always confirm state laws about convenience fees.

Example

Request

<API_URL_EndPoint>/Crud/Read/RPConvFee.json

data={
   "id" : "rpf01DJCXWGAFQEC6qpc"
}

Response (percentage)

{
   "response_status" : 0,
   "response_message" : "Success",
   "response_data" : {
      "entity" : "RPConvFee",
      "id": "rpf01DJCXWGAFQEC6qpc",
      "refNumber" : "",
      "amount" : 1.5%,
      "paymentDate" : "2016-12-14",
      "chartOfAccountId" : "0ca01GRGACTAHSPLd2jp"
   }
}

Response (flat fee)

{
   "response_status" : 0,
   "response_message" : "Success",
   "response_data" : {
      "entity" : "RPConvFee",
      "id": "rpf01DJCXWGAFQEC6qpc",
      "refNumber" : "",
      "amount" : $5.00,
      "paymentDate" : "2016-12-14",
      "chartOfAccountId" : "0ca01GRGACTAHSPLd2jp"
   }
}

Resources

Parameters