Bundles

Element type: Required

Enpoints/models used: LineItem

Your integration must allow users to create bundles and associate those bundles with client profiles.

Bundles allow you to:

Associate a group of transaction/service pairs with an offering
Specify the percentage of the sale amount to be applied to each transaction/service pairs

When taxes are calculated for bundled transactions, the appropriate taxes are calculated for each transaction/service associated with the transaction/service type defined for the bundle.

Bundles are created in the Communications Customer Portal. Information about how to add bundles is available in the "Add a Bundle Group to apply separate transaction/service pairs to bundled items" Help Center article. Once available, you can include the bundle in a transaction by specifying the Bundle Transaction ID (tran) and the Bundle Service ID (serv) in the LineItem model.

View example:

{
  "cmpn": {
    "bscl": 0,
    "svcl": 0,
    "fclt": false,
    "frch": false,
    "reg": false
  },
  "inv": [
    {
      "bill": {
        "cnty": "Johnson",
        "ctry": "USA",
        "int": true,
        "geo": false,
        "city": "Overland Park",
        "st": "KS",
        "zip": "66212"
      },
      "cust": 0,
      "lfln": false,
      "date": "2018-12-01T12:00:00Z",
      "itms": [
        {
          "ref": "Line Item 001 - Bundle",
          "chg": 100,
          "sale": 1,
          "tran": 20000,
          "serv": 20001
        }
      ],
      "invm": true,
      "dtl": false,
      "summ": true
    }
  ]
}