Supplier Services

Create your suppliers' list

Supplier services represent all the associated companies or individual service providers with your company.

Add Supplier

Endpoint details

Endpoint URL

Method

Authentication requirements

/v1/api/erp/svSupplierService

POST

  1. clientid
  2. clientsecret
  3. signature

A request in the following format should be posted to the above mentioned endpoint URL.

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svSupplierService' \
--header 'clientid: Enter_Client_ID' \
--header 'clientsecret: Enter_Client_Secret' \
--header 'signature: Enter_Signature' \
--header 'Content-Type: application/json' \
--data-raw '{
  "svSupplierServiceRQ": {
    "company": [
      {
        "code": "32",
        "supplier": [
          {
            "userName": "Abdullah",
            "name": "New Company",
            "category": "Oil & Gas",
            "supplierContact": "Abdul Rahman",
            "mobile": "+97188996655",
            "email": "[email protected]",
            "supplierCode": "320102",
            "paymentTerms": [
              {
                "name": "Advance Payment",
                "value": "No more than 50% of invoice"
              }
            ],
            "methodOfPayment": [
              {
                "name": "Mode 1",
                "value": "Prefer local bank transfer"
              }
            ]
          }
        ]
      }
    ]
  }
}'

Request details:

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 identification 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

svSupplierServiceRQ Mandatory

Tag carrying information to add supplier service request

Object

company Mandatory

Tag carrying company information to which the supplier services are requested to be added

Object/String

code Mandatory

Unique identification code of the company Length of input: Min 3 Characters Max 20 Characters

String

supplier Mandatory

Tag carrying information about the supplier

Object/Array

userName Mandatory

Unique username of the SingleView platform user Length of input: Min 3 Characters Max 20 Characters

String

name Mandatory

Name/Company name of the supplier Length of input: Min 3 Characters Max 20 Characters

String

category Optional

Category assigned to the supplier Length of input: Min 3 Characters Max 20 Characters

String

supplierContact Mandatory

Contact name of the supplier Length of input: Min 3 Characters Max 20 Characters

String

mobile Mandatory

Mobile number of the supplier

String

email Mandatory

Email address of the supplier

String

supplierCode Mandatory

Unique identification supplier code Length of input: Min 3 Characters Max 20 Characters

String

paymentTerms Optional

Tag carrying information on the payment terms

Object/Array

name Optional

Name assigned to the payment term Length of input: Min 3 Characters Max 20 Characters

String

value Optional

Assigned value of the payment term Length of input: Min 3 Characters Max 20 Characters

String

methodOfPayment Optional

Object carrying information on the method of the payment

Object/Array

name Optional

Name assigned to the method of payment Length of input: Min 3 Characters Max 20 Characters

String

value Optional

Assigned value of the payment method Length of input: Min 3 Characters Max 20 Characters

String

Successful Create Supplier Services Response

{
  "svSupplierServiceRS": {
    "company": [
      {
        "code": "32",
        "supplier": [
          {
            "status": 0,
            "message": "Supplier added successfully"
          }
        ]
      }
    ]
  }
}

Response details description:

JSON TagDescriptionData type
svSupplierServiceRSCreate Group & Company Response TagObject
companyArray of companiesObject/Array
codeUnique company codeString
supplierTag carrying information on supplier services responseObject
statusStatus codeNumerical
messageProcess display messageString