SingleView ARAP API services offer a robust set of tools for managing accounts receivable and accounts payable operations by enabling real-time access to financial data, automated workflows, and seamless integration with your existing ERP systems.

Get ARAP info

Try in API Reference ➜

Endpoint details

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

A request in the following format should be posted to the above-mentioned endpoint to fetch the ARAP statuses:

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svARAPService' \
--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	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
svARAPServiceRQ Mandatory	Tag carrying information of the ARAP Service request	Object
company Mandatory	Tag carrying information on company requesting the ARAP services	Object/Array
companyCode Mandatory	Unique company identification code Length of input: Min 3 Characters Max 20 Characters_	String
date Mandatory	Date on which request has been made in in `YYYY-MM-DDTHH:MM:SSZ` format	Date
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 denoting the payment transfer	Alphanumeric
ivId Mandatory	Unique invoice identification details	String
createdDate Mandatory	Date on which Invoice was created in `YYYY-MM-DDTHH:MM:SSZ` format	Date
dueDate Mandatory	By when the Invoice should be cleared	Date
paymentTerms Optional	Terms if any mentioned towards the invoice	String
amount Mandatory	Total amount of the PO transaction	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

If the request is found to be valid in terms of authentication and other details, a similar successful response will be reflected:

{
  "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	Object/Array
ivId	Invoice number or ID	String
status	Status code	String
message	Process display message	String
errorCode	Error code	String