Apportion Service

Overview

Apportion service is used to apportion the amount paid against a bill among the different tax heads based on the implemented algorithm. The default algorithm uses order of the tax head to apportion, the tax head with lowest order is apportioned off first while the highest order tax head is apportioned last.

Pre-requisites

Before you proceed with the documentation, make sure the following pre-requisites are met -

Java 8
Kafka server is up and running
egov-persister service is running and has apportion persister config path added in it
PSQL server is running and database is created to store apportion audit data

Key Functionalities

Apportion payment in tax heads of bill
Apportion advance amount in tax heads of demand during demand creation

Environment Variables

Description

egov.apportion.default.value.order

If set to true will apportion of negative amount first irrespective of tax head order

Interaction Diagram:

Deployment Details

Deploy latest version of egov-apportion-service service
Add apportion persister yaml path in persister configuration

Configuration Details

There is no separate configuration required. The TaxHead master that is configured in billing service is only used

Integration

Integration Scope

Any payment service which want to divide the paid amount in different tax head buckets can integrate with apportion service.

Integration Benefits

Apportions amount in tax heads

Steps to Integration

To integrate, host of egov-apportion-service should be overwritten in helm chart
/apportion-service/v2/bill/_apportion should be called to apportion the bill
/apportion-service/v2/demand/_apportion should be called to apportion advance amount in demands