Overview

The Virtual Account Enable/Disable API Service allows ERP-integrated clients to enable or disable Virtual Accounts for specific companies under a group. This feature helps administrators manage account accessibility and operational control directly via ERP integration.

❗️
Important information

Enable/Disable services apply only to already created/added virtual accounts in the system.

Enable/Disable a Virtual Account

Endpoint details

Endpoint URL	Method	Authentication requirements
`/v1/api/erp/svVAService`	POST	`clientid` `clientsecret` `signature`

Sample request

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svVAService' \
--header 'clientid: abcdef83643f61c975' \
--header 'clientsecret: zyxvw95cE163C03b7d1' \
--header 'signature: UMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408nUMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408n' \
--header 'Content-Type: application/json' \
--data-raw '{
"svVAServiceRQ": {
  "groupCode": "1000",
  "company": [
    {
      "companyCode": "1234",
      "userName": "sayeed_1234",
      "type": "enable",
      "virAccount": [
        {
          "va_acERPcode": "VA1234567890"
        }
      ]
    }
  ]
}
}'

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svVAService' \
--header 'clientid: abcdef83643f61c975' \
--header 'clientsecret: zyxvw95cE163C03b7d1' \
--header 'signature: UMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408nUMEH9M8tXknuRnnkrzRjDHaxFRLyZJwDNAl408n' \
--header 'Content-Type: application/json' \
--data-raw '{
"svVAServiceRQ": {
  "groupCode": "1234",
  "company": [
    {
      "companyCode": "1234",
      "userName": "sayeed_1234",
      "type": "disable",
      "virAccount": [
        {
          "va_acERPcode": "VA1234567890"
        }
      ]
    }
  ]
}
}'

Request description

JSON Tag	Requirement	Description	Data Type
svVAServiceRQ	Mandatory	Tag carrying information on request to enable a virtual account	Object
groupCode	Mandatory	Unique group identification details	String
company	Mandatory	Tag carrying information about company	Object
companyCode	Mandatory	Unique company identification code Length of input: Min 3 Characters Max 20 Characters	Numeric
userName	Mandatory	Unique user identification name Length of input: Min 3 Characters Max 20 Characters	String
type	Mandatory	Type of operation to be performed for the mentioned virtual accounts in the request to be mentioned as `enable` or `disable`	String
virAccount	Mandatory	Tag carrying information of the virtual account that are needed to be enabled/disabled	Object
va_acERPcode	Mandatory	Unique account ERP identification code of the virtual account Min: 9 Characters	Alphanumeric

Sample response

{
  "svVAServiceRS": {
    "company": [
      {
        "companyCode": "1234",
        "userName": "sayeed_1234",
        "virAccount": [
          {
            "status": 0,
            "va_acERPcode": "VA1234567890",
            "message": "Account enabled successfully."
          }
        ]
      }
    ]
  }
}

{
  "svVAServiceRS": {
    "company": [
      {
        "companyCode": "1234",
        "userName": "sayeed_1234",
        "virAccount": [
          {
            "status": 0,
            "va_acERPcode": "VA1234567890",
            "message": "Account disabled successfully."
          }
        ]
      }
    ]
  }
}

Response description

JSON Tag	Description	Data Type
svVAServiceRS	Tag carrying information on process response of Virtual Account services	Object
company	Tag carrying information on company	Object
companyCode	Unique company identification code	Numeric
userName	Unique username	String
virAccount	Tag carrying information on the requested virtual accounts in the request	Object
status	Status of the process	Numeric
va_acERPcode	Unique account ERP identification code of the virtual account	Alphanumeric
message	Details on the process as per the status code	String