ARAP

Manage Accounts Payable & Accounts Receivable

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

Endpoint details

Endpoint URLMethodAuthentication requirements
/v1/api/erp/svARAPServicePOST1. 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 TagDescriptionData type
clientid
Mandatory
Client IDString
clientsecret
Mandatory
Client CodeString
signature
Mandatory
SignatureString
svARAPServiceRQ
Mandatory
ARAP Service request tagObject
company
Mandatory
Array of companiesArray
companyCode
Mandatory
Unique company codeString
date
Mandatory
Date on which requestedString
data
Mandatory
Array of Multiple Payables and receivables dataArray
name
Mandatory
Public name of the customer or the vendorArray or String
type
Mandatory
Receivable / Payable
0 – AP
1 -AR
Number
currency
Mandatory
CurrencyString
ivId
Mandatory
Invoice ID/NumberString
createdDate
Mandatory
Date on which Invoice was createdString
dueDate
Mandatory
By when the Invoice should be clearedString
paymentTerms
Optional
Terms if any mentioned towards the invoiceString
amount
Mandatory
Total amount spent on the PONumber
ref_num
Mandatory
SO/Vendor Reference NumberString
cusPO
Mandatory
Purchase Order or the customer purchase OrderString
status
Mandatory
Payment status, default will be Pending, paid if paid in full; Partially paid in case of part paymentString
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 customerString
value
Optional
Value towards the dimensionString
custVenId
Optional
Customer Vendor IDString

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 TagDescriptionData type
svARAPServiceRSARAP service response tagObject
companyArray of companiesArray
companyCodeUnique company codeString
dataArray of dataArray
ivIdInvoice number or IDString
statusStatus codeString
messageProcess display messageString
errorCodeError codeString