Surcharges

  • Updated

This self-implementation guide supports PayPack up to version 1.4.7.

To find the latest self-implementation guide, go to our new help documentation here.

Surcharge Overview

There are business use cases where you may want to charge a transaction convenience fee. When enabled, the surcharge fee is applied across any PayPack charge on the customer, sales order, invoice, and invoice group. On successful charge, a separate NetSuite invoice transaction is created with a new line item to track the surcharge without impacting the original transaction details.

  • Flat Amount Surcharge – Enter a static value (i.e. 5 for $5)
  • % Amount Surcharge – Enter a static value (i.e. 3 for 3%)
  • Surcharge Form Label – This form label only appears on the payment link page.
  • Surcharge Item – Recommend setting up a non-inventory or payment item to collect surcharge totals.
    Surcharge Invoice Item.png
  • Surcharge Invoice Mappings – When needing to populate required fields on an invoice transaction, enter metadata in JSON format to satisfy the requirement.

Sample JSON data for Invoice Mapping

{
  "mapping": {
    "fields": [
      {
        "generate": "otherrefnum",
        "lookupName": "otherrefnumlookup"
      },
      {
        "generate": "subsidiary",
        "initializationDefaultValue": true,
        "lookupName": "subsidairylookup"
      },
      {
        "generate": "memo",
        "lookupName": "subsidairylookup"
      },
      {
        "generate": "shipmethod",
        "hardCodedValue": "",
        "fieldType": "text",
        "discardIfEmpty": false
      },
      {
        "generate": "shippingcost",
        "hardCodedValue": 0,
        "fieldType": "",
        "discardIfEmpty": false
      },
      {
        "generate": "taxcode",
        "extract": "",
        "hardCodedValue": -7
      },
     {
        "generate": "shippingtax1rate",
        "extract": "",
        "hardCodedValue": 0
      }
    ],
    "sublist": {
      "item": [
        {
          "generate": "location",
          "extract": "",
          "hardCodedValue": 2
        },
        {
          "generate": "taxcode",
          "extract": "",
          "hardCodedValue": -7
        },
        {
          "generate": "shippingrate",
          "extract": "",
          "hardCodedValue": 0
        }
      ]
    }
  },
  "lookups": {
    "otherrefnumlookup": {
      "resultFieldId": "tranid",
      "recordType": "parent"
    },
    "subsidairylookup": {
      "resultFieldId": "subsidiary",
      "recordType": "parent"
    }
  }
}