In this topic:

Creating Dunning Plans and Tiers

With Gotransverse Dunning API, you can create custom Dunning Plans and tiers. First, let’s create a Dunning Plan that would be a container for our tiers.

Creating a Dunning Plan

Following a sample payload, specify the name, description, and code for identifying your Dunning Plan. Also, indicate the minimum_account_due that is the overall account balance required to trigger an account to be evaluated for dunning.

Status

You can create a Dunning Plan in either ACTIVE or DRAFT status.

Once the Dunning Plan is in the ACTIVE status, it can be used to evaluate accounts via the Scheduler.

  • When you create the Dunning Plan in the DRAFT status, you can modify its details before it’s used. Once the Dunning status is ACTIVE, it cannot be changed back to DRAFT.
  • When you no longer need a certain Dunning Plan, move it to the INACTIVE status. Later, you can move it back to ACTIVE.
  • You can change the status of the Dunning Plan specifying the desired status in the request body: PUT http://example-dunning-api.gotransverse.com/dunning/2/plans/{plan_id}

Strategy

Currently, the only available strategy is OLDEST_OPEN_INVOICE. It bases the dunning evaluation on the oldest, non‐disputed open invoice's “days past due” and “invoice amount due”.

Create a Dunning Plan
POST http://example-dunning-api.gotransverse.com/dunning/2/plans

Request

{
 "name": "Standard Client",
 "code": "Standard Client #1",
 "description": "sample description",
 "status": "ACTIVE",
 "strategy": "OLDEST_OPEN_INVOICE",
 "minimum_account_due": 3
}

Response

{
 "id": "f97e0498-cef0-4502-9638-b994b60915c7",
 "name": "Standard Client",
 "code": "Standard Client #1",
 "description": "sample description",
 "status": "ACTIVE",
 "strategy": "OLDEST_OPEN_INVOICE",
 "minimum_account_due": 3
}


Retrieve Dunning Plans

GET http://example-dunning-api.gotransverse.com/dunning/2/plans/{plan_id}

Update Dunning Plans
PUT http://example-dunning-api.gotransverse.com/dunning/2/plans/{plan_id}

Creating Dunning Plan tiers

Tiers provide a way to design multiple custom actions based on different criteria within the same Dunning Plan. For example, you may want to implement increasing levels of severity as the days past due exceed certain thresholds. In this example, let’s create three tiers within our Dunning Plan.

Priority Dunning Tier Days Overdue on Payment Minimum Invoice Due Description
1 Dunning block 1 100 For Customers with dunning status equal to ‘Dunning block’ there will be NO dunning actions.
2 Friendly reminder 10 100 First reminder notification sent to the Customer as the oldest open invoice is past the invoice due date.
3 Important notice 30 100 Second reminder notification sent to the Customer as the oldest open invoice is past the invoice due date.

Create Tier 1 “Dunning block”
POST http://example-dunning-api.gotransverse.com/dunning/2/plans/{plan_id}/tiers

Request

{
 "code": "Tier 1",
 "name": "Dunning block",
 "description": "For Customers with dunning status equal to ‘Dunning block’ there will be NO dunning actions",
 "minimum_days_past_due": 1,
 "minimum_invoice_due": 100
}

Response

{
 "id": "5c753106-ba42-4611-8655-6689f2db7b90",
 "plan_id": "f97e0498-cef0-4502-9638-b994b60915c7",
 "code": "Tier 1",
 "name": "Dunning block",
 "description": "For Customers with dunning status equal to ‘Dunning block’ there will be NO dunning actions",
 "minimum_days_past_due": 1,
 "minimum_invoice_due": 100,
 "priority_order": 1
}

Create Tier 2 “Friendly reminder”
POST http://example-dunning-api.gotransverse.com/dunning/2/plans/{plan_id}/tiers

Request

{
 "code": "Tier 2",
 "name": "Friendly reminder",
 "description": "1st reminder notification sent to the Customer as the oldest open invoice is past the invoice due date",
 "minimum_days_past_due": 10,
 "minimum_invoice_due": 100
}

Response

{
 "id": "3c837b11-b62b-4219-b2cd-c6952e6cbfef",
 "plan_id": "f97e0498-cef0-4502-9638-b994b60915c7",
 "code": "Tier 2",
 "name": "Friendly reminder",
 "description": "1st reminder notification sent to the Customer as the oldest open invoice is past the invoice due date",
 "minimum_days_past_due": 10,
 "minimum_invoice_due": 100,
 "priority_order": 2
}

Create Tier 3 “Important notice”
POST http://example-dunning-api.gotransverse.com/dunning/2/plans/{plan_id}/tiers

Request

{
 "code": "Tier 3",
 "name": "Important notice",
 "description": "2nd reminder notification sent to the Customer as the oldest open invoice is past the invoice due date",
 "minimum_days_past_due": 30,
 "minimum_invoice_due": 100
}

Response

{
 "id": "223ecb64-81aa-4277-9cd2-d5069d412664",
 "plan_id": "f97e0498-cef0-4502-9638-b994b60915c7",
 "code": "Tier 3",
 "name": "Important notice",
 "description": "2nd reminder notification sent to the Customer as the oldest open invoice is past the invoice due date",
 "minimum_days_past_due": 30,
 "minimum_invoice_due": 100,
 "priority_order": 3
}

Note: Each Dunning Plan has one tier created by default.

{
 "id": "bb1d0de6-171d-4b5e-a577-e51c35106dbb",
 "plan_id": "ee8d4945-879c-4d34-904f-50ee270ff0dc",
 "code": "default_no_dunning",
 "name": "No Dunning",
 "description": "Default Dunning Plan Tier",
 "minimum_days_past_due": 0,
 "minimum_invoice_due": 0,
 "priority_order": 0
}
]

 

Setting up Gotransverse UI 1.0


Next steps

Now, when you have created Dunning Plan with tiers and set up Gotransverse, proceed with assigning Dunning to the billing account.

Top