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: abcdef83643f61c975' \
--header 'clientsecret: zyxvw95cE163C03b7d1' \
--header 'signature: Enter_Signature' \
--header 'Content-Type: application/json' \
--data-raw '{
"svGrpCmpServiceRQ": {
  "group": {
    "en": "Oil & Gas Group",
    "ar": "مجموعة النفط والغاز",
    "code": "78"
  },
  "company": [
    {
      "en": "Riyadh Oil & Gas Company",
      "ar": "شركة الرياض للنفط والغاز",
      "code": "36",
      "address": "Riyadh, KSA",
      "erpService": "SAP",
      "callBackPaymentStatusUrl": "https://oilgascompany.com/one/callback_url/payment_status",
      "callBackPaymentChargeUrl": " https://oilgascompany.com/one/callback_url/payment_charges"
    },
    {
      "en": "Jeddah Oil & Gas Company",
      "ar": "شركة جدة للنفط والغاز",
      "code": "37",
      "address": "Jeddah, KSA",
      "erpService": "SAP",
      "callBackPaymentStatusUrl": "https://oilgascompany.com/two/callback_url/payment_status",
      "callBackPaymentChargeUrl": "https://oilgascompany.com/two/callback_url/payment_charges"
    }
  ]
}
}'

Request details description:

JSON Tag	Description	Data type
clientid Mandatory	Unique client identification details Length of input: Min 3 Characters Max 20 Characters	String
clientsecret Mandatory	Unique client secret code Length of input: Min 3 Characters Max 20 Characters	String
signature Mandatory	64-Bit string obtained by processing client signature key through Base-64 and SHA-256	String
svGrpCmpServiceRQ Mandatory	Tag carrying information on request to create Group & Company	Object
group Specific Mandatory/Optional	Tag carrying information about the Group requested for creation	Object
en Specific Mandatory/Optional	Name of the Group in English Length of input: Min 3 Characters Max 20 Characters	String
ar Specific Mandatory/Optional	Name of the Group in Arabic Length of input: Min 3 Characters Max 20 Characters	String
code Specific Mandatory/Optional	Unique Group identification code Length of input: Min 3 Characters Max 20 Characters	String
company Mandatory	Tag carrying information about the Companies to be included in the group	Object/Array
en Mandatory	Name of the Company in English Length of input: Min 3 Characters Max 20 Characters	String
ar Mandatory	Name of the Company in Arabic Length of input: Min 3 Characters Max 20 Characters	String
code Mandatory	Unique Company identification code Length of input: Min 3 Characters Max 20 Characters	String
address Optional	Address of the company Length of input: Min 3 Characters Max 35 Characters	String
erpService Mandatory	Type of ERP Service to be assigned for the company Length of input: Min 3 Characters Max 35 Characters	String
callBackPaymentStatusUrl Optional	Call back URL to notify payment status	String
callBackPaymentChargeUrl Optional	Call back URL to notify payment charges	String

Successful Create Group & Company Response

{
  "svGrpCmpServiceRS": {
    "group": {
      "code": "78",
      "status": 0,
      "message": "group added successfully"
    },
    "company": [
      {
        "code": "36",
        "status": 0,
        "message": "company updated successfully"
      },
      {
        "code": "37",
        "clientId": "pSLwfthnKSG8",
        "clientSecret": "BCRTXIu2b5dR",
        "signatureKey": "jnDRTGYquct2FqQGP2",
        "status": 0,
        "message": "company added successfully"
      }
    ]
  }
}

Response details description:

JSON Tag	Description	Data type
svGrpCmpServiceRS	Create Group & Company Response Tag	Object
group	Tag carrying information on the group in the response	Object
code	Unique Group identification code	String
status	Status code of the process represented as: `0` - Success `1` - Failed	Numerical
message	Message conveying information on the process of group creation	String
company	Tag carrying the array of companies included in the request	Object/Array
code	Unique company identification code	String
status	Status code of the process represented as: `0` - Success `1` - Failed	Numerical
message	Message conveying information on the process of company creation	String
errorCode	Code representing the error occurred in the request Refer error codes for more information	String
code	Unique code of the company	Numeric
clientId	Unique client identification details allotted to the client	String
clientSecret	Unique client secret identification details	String
signatureKey	Unique signature key allotted to the individual company	String
status	Status code of the process represented as: `0` - Success `1` - Failed	Numerical
message	Message conveying information on the process of company creation	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: