Sample request

A request in the following format should be posted to the URL https://servicesuat.onesingleview.com/v1/api/erp/svARAPService.

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svPayEnquiryService' \
--header 'clientid: Enter_Client_ID' \
--header 'clientsecret: Enter_Client_Secret' \
--header 'signature: Enter_Signature' \
--header 'Content-Type: application/json' \
--data-raw '{
  "svARAPServiceRQ": {
    "company": [
      {
        "companyCode": "Enter_Company_Code",
        "date": "YYYY-MM-DDTHH:MM:SSZ",
        "data": [
          {
            "name": "Enter_Name_Of_Vendor",
            "type": Enter_Type,
            "currency": "Enter_Currency",
            "ivId": "Enter_invoice_ID",
            "createdDate": "YYYY-MM-DDTHH:MM:SSZ",
            "dueDate": "YYYY-MM-DDTHH:MM:SSZ",
            "paymentTerms": "Enter_Payment_Terms",
            "amount": 00.00,
            "ref_num": "Enter_Reference_Number",
            "cusPO": "Enter_Customer_Purchase_Order",
            "status": "Enter_Status",
            "udf": [
              {
                "key": "Enter_Key",
                "value": "Enter_Value"
              }
            ],
            "custVenId": "Enter_Customer_Vendor_ID"
          },
          {
            "name": "Enter_Name_Of_Vendor",
            "type": "Enter_Type",
            "currency": "Enter_Currency",
            "ivId": "Enter_invoice_ID",
            "createdDate": "YYYY-MM-DDTHH:MM:SSZ",
            "dueDate": "YYYY-MM-DDTHH:MM:SSZ",
            "paymentTerms": "Enter_Payment_Terms",
            "amount": 00.00,
            "ref_num": "Enter_Reference_Number",
            "cusPO": "Enter_Customer_Purchase_Order",
            "status": "Enter_Status",
            "udf": [
              {
                "key": "Enter_Key",
                "value": "Enter_Value"
              }
            ],
            "custVenId": "Enter_Customer_Vendor_ID"
          }
        ]
      }
    ]
  }
}'

Request details:

JSON Tag	Description	Data type
clientid Mandatory	Client ID	String
clientsecret Mandatory	Client Code	String
signature Mandatory	Signature	String
svARAPServiceRQ Mandatory	ARAP Service request tag	Object
company Mandatory	Array of companies	Array
companyCode Mandatory	Unique company code	String
date Mandatory	Date on which requested	String
data Mandatory	Array of Multiple Payables and receivables data	Array
name Mandatory	Public name of the customer or the vendor	Array or String
type Mandatory	Receivable / Payable 0 – AP 1 -AR	Number
currency Mandatory	Currency	String
ivId Mandatory	Invoice ID/Number	String
createdDate Mandatory	Date on which Invoice was created	String
dueDate Mandatory	By when the Invoice should be cleared	String
paymentTerms Optional	Terms if any mentioned towards the invoice	String
amount Mandatory	Total amount spent on the PO	Number
ref_num Mandatory	SO/Vendor Reference Number	String
cusPO Mandatory	Purchase Order or the customer purchase Order	String
status Mandatory	Payment status, default will be Pending, paid if paid in full; Partially paid in case of part payment	String
udf Optional	User defined dimension is specific to customer / company, the key value paid combination can be multiple; maximum of 5. [ex udf2, udf3, udf4, udf5]	Array
key Optional	Should be agreed dimension per customer	String
value Optional	Value towards the dimension	String
custVenId Optional	Customer Vendor ID	String

Sample response

{
  "svARAPServiceRS": {
    "company": [
      {
        "companyCode": "Company_Code",
        "data": [
          {
            "ivId": "Invoice_ID",
            "status": Status_Code,
            "message": "Process/Status_Message"
          },
          {
            "ivId": "Invoice_ID",
            "status": Status_Code,
            "message": "Process/Status_Message",
            "errorCode": "Error_Code"
          }
        ]
      }
    ]
  }
}

Response description:

JSON Tag	Description	Data type
svARAPServiceRS	ARAP service response tag	Object
company	Array of companies	Array
companyCode	Unique company code	String
data	Array of data	Array
ivId	Invoice number or ID	String
status	Status code	String
message	Process display message	String
errorCode	Error code	String