Group & Company Management

Types of companies

A company represents a set of transactions and data categorized by the user. A Group represents multiple companies. However, users can choose to have the companies individually or as Group.

📘
Companies can be listed as follows:

An individual company

Multiple individual companies

Companies in a Group

Multiple groups representing multiple companies

Using a combination of two or more options mentioned above

Create Group & Company Request

Try in API Reference ➜

Endpoint details

Endpoint URL	Method	Authentication requirements
`/v1/api/erp/svGrpCmpService`	POST	1. `clientid` 2. `clientsecret` 3. `signature`

A request in the following format should be posted to the above mentioned endpoint to create a group and company:

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svGrpCmpService' \
--header 'clientid: Enter_Client_ID' \
--header 'clientsecret: Enter_Client_Secret' \
--header 'signature: Enter_Signature' \
--header 'Content-Type: application/json' \
--data-raw '{
  "svGrpCmpServiceRQ": {
    "group": {
      "en": "Enter_Group_Name_English",
      "ar": "Enter_Group_Name_Arabic",
      "code": "Enter_Group_Code"
    },
    "company": [
      {
        "en": "Enter_Company_Name_English",
        "ar": "Enter_Company_Name_Arabic",
        "code": "Enter_Company_Code",
        "address": "Enter_Address",
        "erpService": "Enter_ERP_Service",
        "callBackPaymentStatusUrl": "Enter_Callback_Payment_Status_URL",
        "callBackPaymentChargeUrl": " Enter_Callback_Payment_Charge_URL"
      },
      {
        "en": "Enter_Company_Name_English",
        "ar": "Enter_Company_Name_Arabic",
        "code": "Enter_Company_Code",
        "address": "Enter_Address",
        "erpService": "Enter_ERP_Service",
        "callBackPaymentStatusUrl": "Enter_Callback_Payment_Status_URL",
        "callBackPaymentChargeUrl": "Enter_Callback_Payment_Charge_URL"
      }
    ]
  }
}'

Request details description:

JSON Tag	Description	Data type
clientid Mandatory	Client ID	String
clientsecret Mandatory	Client Code	String
signature Mandatory	Signature	String
svGrpCmpServiceRQ Mandatory	Group & Company creation request tag	Object
group Specific Mandatory	Group tag	Object
en Mandatory	Name of the Group in English	String
ar Mandatory	Name of the Group in Arabic	String
code Mandatory	Unique Group code	String
company Mandatory	Array of Companies	Array
en Mandatory	Name of the Company in English	String
ar Mandatory	Name of the Company in Arabic	String
code Mandatory	Unique Company Code	String
address Optional	Address of the company	String
erpService Mandatory	Type of ERP Service	String
callBackPaymentStatusUrl Mandatory	Call back URL to notify payment status	String
callBackPaymentChargeUrl Mandatory	Call back URL to notify payment charges	String

Successful Create Group & Company Response

{
  "svGrpCmpServiceRS": {
    "group": {
      "code": "Group_Code",
      "status": 0,
      "message": "Process/Status_Message",
      
    },
    "company": [
      {
        "status": 0,
        "message": "Status_Message"
      },
      {
        "code": "Company_Code",
        "status": 0,
        "message": "Process/Status_Message",
        "errorCode": "Error_Code"
      }
    ]
  }
}

Response details description:

JSON Tag	Description	Data type
svGrpCmpServiceRS	Create Group & Company Response Tag	Object
group	Group tag	Object
code	Unique Group code	String
status	Status Code	Numerical
message	Process display message	String
company	Array of companies	Array
status	Status code	Numerical
code	Unique company code	String
message	Process display message	String
errorCode	Error code	String

Group & Company Management

Types of companies

📘Companies can be listed as follows:

Create Group & Company Request

Endpoint details

Successful Create Group & Company Response

📘
Companies can be listed as follows: