Payment Attachment Upload
Upload attachments to support single payment requests
The svPaymentAttachementService
API allows users to upload attachments for a single payment request in ERP systems and execute it through SingleView ERP APIs. This service is designed to enhance the payment workflow by associating relevant documents (e.g., invoices, receipts) with specific payment requests.
Important Information
Upload supports up to 5 files each of 2 MB in JPG, JPEG, PNG, DOC, DOCX, XLS, & XLSX formats.
Upload Payment Attachment
Endpoint details
Endpoint URL | Method | Authentication requirements |
---|---|---|
/v1/api/erp/svPaymentAttachementService | POST | 1/. clientid 2. clientsecret |
A request in the following format should be posted to the above-mentioned endpoint to fetch the payment status and details:
REQUEST : curl --location 'https://servicesuat.onesingleview.com/v1/api/erp/svPaymentAttachementService' \
--header 'clientid: **********' \
--header 'clientsecret: *********' \
--form '=@"/D:/work/SISA/IM_IN_V.png"' \
--form 'data= {
"svPaymentAttachementServiceRQ":
{
"company":[
{
"companyCode":"0000",
"payment":{
"payId":"12345678901234"
}
}
]
}
}'
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 |
=@ Mandatory | URL of the file | String |
svPaymentAttachementServiceRQ Mandatory | Root object for attachment upload service request | Object |
company Mandatory | Tag carrying information about the company and payment | Object |
companyCode Mandatory | Unique company identification code Length of input: Min 3 Characters Max 20 Characters | String |
payment Mandatory | Tag carrying information on payment to which upload service is requested | Object |
payId Mandatory | Unique payment identification details Length of input: Min 3 Characters Max 20 Characters | String |
Upon processing of the request and finding of valid authentication details, you'll get the following success response:
{
"svPaymentAttachementServiceRS": {
"company": [
{
"companyCode":"0000",
"payment":{
"payId":"12345678901234",
"message": "files attached successfully"
}
}
]
}
}
Response details:
JSON Tag | Description | Data type |
---|---|---|
svPaymentAttachementServiceRS | Root tag carrying response information for the upload attachment service | Object |
company | Tag carrying information about the company and payment | Object |
companyCode | Unique company identification code | String |
payment | Tag carrying information on payment to which upload service is requested | Object |
payId | Unique identification details | String |
message | Message carrying information on the process | String |
Updated 2 days ago