Create group code

POST

/va/groupcodes

Creates a sub-ledger group code for a client on TPBackEnd.

Field mapping to TPBackEnd: clientId, productId, type and description are sent
unchanged. customNUBAN is sent as enforceExternalId with a string value of
"true" or "false".

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Header Params

Body Params application/jsonRequired

Examples

Normal collection group codeGroup code that enforces caller-supplied NUBANs

{
    "clientId": 18,
    "type": "Normal",
    "description": "School fees collection",
    "productId": 3,
    "customNUBAN": false
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Normal collection group codeGroup code that enforces caller-supplied NUBANs

curl --location '/va/groupcodes' \
--header 'X-Forwarded-For: 102.89.34.10' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "clientId": 18,
    "type": "Normal",
    "description": "School fees collection",
    "productId": 3,
    "customNUBAN": false
}'

Responses

🟢200

application/json

Group code created

Bodyapplication/json

Example

{
    "clientId": 18,
    "productId": 0,
    "accountId": "16",
    "groupCode": "GC0000018"
}

🟠400

🟠401

🔴500

Modified at 2026-10-14 10:10:03

Get Reports Details

VACreateGroupCodeRequest