Accounting scripts specify the details of an accounting entry, and the rules used to generate it. When an event occurs, such as funds being credited to an account or a purchase being confirmed, the Pismo platform uses the accounting script to create the appropriate accounting entry.

Accounting script versions

The Pismo platform offers two versions of setting up accounting routing.

• Accounting scripts v1
• Accounting scripts v2

Below are the key functional differences between the two accounting script versions.

Supported flows

The following table lists available flows supported by each accounting scripts version.

New features in accounting scripts v2

Accounting scripts v2 introduce the following features that are not supported in accounting scripts v1.

• Flexibility across multiple programs
• Single‑step setup for accounts and routing
• Expressions
• Parameters

Flexibility across multiple programs

With accounting scripts v2, you have the following options to configure routing based on programs.

• Perform batch routing across multiple program IDs simultaneously
• Configure routing based on program type

This improves efficiency, especially when multiple programs share similar accounting behavior.

Single‑step setup for accounts and routing

Unlike accounting scripts v1, where you must create accounting accounts before configuring routing, accounting scripts v2 let you submit the entire accounting script configuration in a single request using the Create accounting script v2 endpoint. This eliminates intermediate steps and reduces the risk of configuration mismatches between accounts and scripts.

Expressions

Accounting scripts v2 provide additional tools that enhance accuracy and configurability and allow you to define how the accounting amount should be calculated in the expression field. This removes the need for you to perform external calculations before routing.

In this context, expressions are mathematical equations that generate accounting values dynamically rather than relying on fixed values. All values that make up a transaction can be provided directly in the accounting entry input. Alternatively, you can define an expression to calculate a specific value based on other transaction attributes.

Expression examples

If you want to receive the transaction amount net of a fee or interest charge, you can configure expressions such as: amount-interest or amount-fee. This allows accounting amounts to be calculated automatically rather than being passed explicitly in the transaction input.

You can pass the following expressions in the expressions field with the description of how the accounting entry will calculate this value.

For example, consider a transaction composed of the following components:

• Principal amount: 100
• Interest: 20

If you want to create an accounting entry based on the transaction amount excluding the interest portion, use the expression: amount-interest in the expression field.

This results in the calculation 100 - 20 = 80 and accounting entry 101 generated with a value of 80, representing the transaction amount minus the interest amount.

Parameters

Parameters support custom implementation of product‑specific and regulatory‑specific accounting logic. Parameters are set in the parameters object. They allow you to specify when accounting entries are generated (the exact point in the lifecycle of an account or a transaction) and to define other specific accounting behaviors and accrual-related rules.

Create script

To create an accounting script, use the following endpoints.

• V1: Create accounting script v1
• V2:Create accounting script v2

📘

You can include cost centers in the accounting script to improve its management. This is helpful when you need to create an accounting script for revenue and another for expense.

Only create cost centers if your organization requires it. If you need to create a cost center, enter required values in the cost_center object with details about the cost center in your organization. If you don’t need to create a cost center, then enter 0 in the required fields.

Examples

Accounting scripts v1

The following payload request example for Create accounting script v1 is creating an accounting script for entry type ID 404 (IOF of international transactions) and doesn't include any cost centers.

{
  "program_id": {{program_id}},
  "event_type_id": 404,
  "entry_type_id": 404,
  "entry_name": "amount",
  "debit_accounting_account_id": 8195465874,
  "credit_accounting_account_id": 8195410017,
  "cost_center": {
    "debit_org": "0",
    "credit_org": "0",
    "debit_cost": "0",
    "credit_cost": "0"
  }
}

The following payload request example for Create accounting script v1 is creating an accounting script for entry type ID 101 (purchase) and defines the organization's cost centers.

{
  "id": 812046,
  "program_id": 1,
  "event_type_id": 101,
  "entry_type_id": 101,
  "entry_name": "interest",
  "debit_accounting": 
		{
      "id": 1,
      "description": "ACCOUNTING ACCOUNT CREATION TEST",
      "cosif": "161200000006",
			"account": "123123132-x",
      "program_id": 0,
      "created_at": "2021-07-22T00:37:20Z",
      "deactivated_at": null
    },	
  "credit_accounting": 
  {
    "id": 1,
    "description": "ACCOUNTING ACCOUNT CREATION TEST",
    "cosif": "161200000006",
		"account": "123123132-x",
    "program_id": 0,
    "created_at": "2021-07-22T00:37:20Z",
    "deactivated_at": null
  },
  "cost_center": {
    "debit_org": "TN-ORG1",
    "credit_org": "TN-ORG2",
    "debit_cost": "C1",
    "credit_cost": "C2",
    "deactivated_at": null
  },
  "processing_code": "00",
  "deactivated_at": null

}

Accounting script v2

The following payload request example for Create accounting script v2 defines an accounting script for entry type ID 121 (installment transactions) that uses the full principal amount expression and regular timing, causing the Pismo platform to generate the accounting entry when the transaction is created.

{
 "program_id": 1122,
 "event_type_id": 121, //transaction type ID
 "entry_type_id": {
  "id": 1,
  "description": "INSTALLMENT",
  "type": "CREATION",
  "reason": "NEW",
  "responsible": "service-desk"
 },
 "debit_accounting": {
  "description": "Collection and disbursement on behalf",
  "account": "51920001"
 },
  "credit_accounting": {
  "description": "Outstanding balance indue",
  "account": "27510001"
 },
 "expression": "AMOUNT",
 "parameters": [
  {
   "name": "pismo:timing",
   "value": "REGULAR"
  }
 ]
}

You can also combine parameters to create an accounting script, as illustrated in the following payload request example for Create accounting script v2 that uses total interest amount expression and defines several different additional parameters.

{
   "program_types": ["CREDIT"],
   "entry_type_id": {
     "id": 2010,
     "description": "MORA DIARIA",
     "type": "CREATION",
     "reason": "NEW",
     "responsible": "service-desk"
  },
   "debit_accounting": {
     "description": "CARTAO DE CRED-PARC.CORRENTE PARC.EMISSOR-PISMO",
     "account": "1612000007"
  },
   "credit_accounting": {
     "description": "(-)R.A CARTAO DE CREDITO-ROTATIVO-PISMO",
     "account": "1612000002"
  },
   "processing_code": "",
   "expression": "interest",
   "parameters": [
    {
       "name": "bacen:classification",
       "value": "3"
    },
    {
       "name": "pismo:accrual_type",
       "value": "OVERDUE"
    },
    {
       "name": "pismo:overdue",
       "value": "TRUE"
    },
    {
       "name": "pismo:rounding",
       "value": "FALSE"
    }
    
  ]
}