In this topic:

Setting up Posting Rules and Posting Rule Sets

Once you set up the GL Accounts, Account Categories, and Chart of Accounts, proceed with creating Posting Rules and Rule Sets.

Posting Rules use parameters and Drools code to determine what transactions to create based on the data in the Charge Information Records.

In order for a Posting Rule to create transactions for the AR Ledger, it must belong to a Rule Set that has been assigned to that AR Ledger.

A Posting Rule may be assigned to multiple Rule Sets, so that multiple Rule Sets use the same Posting Rule.

  • Rule Set can have any number of Posting Rules.
  • One Posting Rule can be assigned to multiple Posting Rule Sets.
  • One Rule Set may be associated with multiple AR Ledgers.
  • An AR Ledger is associated with only one Rule Set.

Creating a Posting Rule

To create a new posting rule, base it on the existing template. You can retrieve a list of preconfigured templates using the following command:

Retrieve existing templates

GET https://example.gotransverse.com/calypso/3/rule-templates

Select the desired template and note its ID.

Create a Posting Rule

POST https://example.gotransverse.com/calypso/3/rules

Request

{
  "name": "sample rule",
  "status": "ACTIVE",
  "parameters": {
	"debitAccount": "1115",
	"creditAccount": "2510",
	"chargeCategory": "name of charge category",
	"chargeInfoType": "Usage",
	"currency": "USD"
  }, 
  "gl_rule_template_id": 33
}

Response

{
  "id": 5,
  "name": "sample rule",
  "status": "ACTIVE",
  "identifier": "29d4c06c-1e32-4a09-b645-3801dd8942d2",
  "parameters": {
	"currency": "USD",
	"ruleName": "29d4c06c-1e32-4a09-b645-3801dd8942d2",
	"debitAccount": "1115",
	"creditAccount": "2510",
	"chargeCategory": "name of charge category",
	"chargeInfoType": "Usage"
  },
  "currency_conversion_date_type": "POSTING_DATE",
  "gl_rule_template_id": 33,
  "gl_rule_template_name": "On invoice usage with charge category",
  "event_date_field": "invoice_issued_event_date",
  "trigger": "INVOICE",
  "types": [
	"USAGE"
   ],
  "last_updated": "2018-10-04T14:24:31Z",
  "rule_sets": []
}

Creating a Rule Set

A Rule Set provides a way to group, organize and apply Posting Rules to your AR Ledger. Individual posting rules cannot be applied to the AR Ledger.
Create posting rule set

POST https://example.gotransverse.com/calypso/3/rulesets

Request

{
  "name": "Rule Set",
  "description": "additional information on the rule set",
  "status": "ACTIVE"
}

Response

{
  "id": 2,
  "description": "additional information on the rule set",
  "name": "Rule Set",
  "status": "ACTIVE",
  "ledgers": []
}

Assigning a Posting Rule to the Rule Set

To apply configurations specified in the Posting Rules to your AR Ledger, create the association between your Posting Rule and Rule Set.

Assign aPosting Rule to the Rule Set

POST https://example.gotransverse.com/calypso/3/rulesets/{rule_set_ID}/rules

Request

{
  "ids":  [5]
}

Response

{
 "code": 200,
 "message": "Success"
}

Now, when you have created and configured the GL Accounts, Account Categories, Chart of Accoutns, Rules and Rule Sets, proceed with creating run modes.

Top